Compare commits
56 Commits
Author | SHA1 | Date | |
---|---|---|---|
aef6030a8e | |||
91bd2d0d81 | |||
882276a845 | |||
e8c54810f8 | |||
c37b9c88b1 | |||
fdb1268213 | |||
377c87045e | |||
4c9264c12c | |||
93a0403288 | |||
d12577ae71 | |||
c06d0b8e95 | |||
61dbe6c728 | |||
eb90a4091c | |||
7cd4821718 | |||
26cc53ce06 | |||
c3ecfece03 | |||
a5c44f30fa | |||
4c19c88e98 | |||
9232e08eb9 | |||
500cff20eb | |||
387d158bd1 | |||
2760bd8ee1 | |||
30d6a0a58d | |||
613e929d91 | |||
c0e5e30e76 | |||
67bebf853c | |||
e8b82122c6 | |||
a6bd2370b6 | |||
b4a3c98114 | |||
cb5270b197 | |||
3ef27f9d11 | |||
ba710a3c96 | |||
d257d05d4e | |||
adffa185bb | |||
f4ed06741d | |||
8efb08fda1 | |||
d9a2937b55 | |||
f4f076fa59 | |||
6d951491be | |||
dd8f312cb3 | |||
d82d5a36b3 | |||
44dc80bb37 | |||
fdf5914626 | |||
78ee76f9d5 | |||
56d88310df | |||
e3a495a778 | |||
62f3c34bfe | |||
bdf711d69f | |||
b215e1a4a7 | |||
1e55f17e7e | |||
9a5d54c035 | |||
0cbe69736b | |||
4c0d226030 | |||
3c1a5c800f | |||
fc9ad9c4a1 | |||
def52ddc20 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -9,3 +9,6 @@
|
|||||||
cabal.sandbox.config
|
cabal.sandbox.config
|
||||||
cabal.project.local
|
cabal.project.local
|
||||||
/graphql.cabal
|
/graphql.cabal
|
||||||
|
|
||||||
|
# GHC
|
||||||
|
*.hi
|
||||||
|
124
CHANGELOG.md
124
CHANGELOG.md
@ -1,6 +1,125 @@
|
|||||||
# Change Log
|
# Changelog
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on
|
||||||
|
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to
|
||||||
|
[Haskell Package Versioning Policy](https://pvp.haskell.org/).
|
||||||
|
|
||||||
|
## [0.8.0.0] - 2020-06-20
|
||||||
|
### Fixed
|
||||||
|
- The parser rejects variables when parsing defaultValue (DefaultValue). The
|
||||||
|
specification defines default values as `Value` with `const` parameter and
|
||||||
|
constants cannot be variables. `AST.Document.ConstValue` was added,
|
||||||
|
`AST.Document.ObjectField` was modified.
|
||||||
|
- AST transformation should never fail.
|
||||||
|
* Arguments and fields with a missing variable as value should be left out.
|
||||||
|
* Invalid (recusrive or non-existing) fragments should be skipped.
|
||||||
|
- Argument value coercion.
|
||||||
|
- Variable value coercion.
|
||||||
|
- Result coercion.
|
||||||
|
- The executor should skip the fields missing in the object type and not fail.
|
||||||
|
- Merging subselections.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- `Schema.Resolver` was moved to `Type.Out`, it is a field and resolver function
|
||||||
|
pair.
|
||||||
|
- `AST.Core.Value` was moved into `Type.Definition`. These values are used only
|
||||||
|
in the execution and type system, it is not a part of the parsing tree.
|
||||||
|
- `Type` module is superseded by `Type.Out`. This module contains now only
|
||||||
|
exports from other module that complete `Type.In` and `Type.Out` exports.
|
||||||
|
- `Error.CollectErrsT` contains the new `Resolution` data structure.
|
||||||
|
`Resolution` represents the state used by the executor. It contains all types
|
||||||
|
defined in the schema and collects the thrown errors.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `Type.Definition` contains base type system definition, e.g. Enums and
|
||||||
|
Scalars.
|
||||||
|
- `Type.Schema` describes a schema. Both public functions that execute queries
|
||||||
|
accept a `Schema` now instead of a `HashMap`. The execution fails if the root
|
||||||
|
operation doesn't match the root Query type in the schema.
|
||||||
|
- `Type.In` and `Type.Out` contain definitions for input and output types.
|
||||||
|
- `Execute.Coerce` defines a typeclass responsible for input, variable value
|
||||||
|
coercion. It decouples us a bit from JSON since any format can be used to pass
|
||||||
|
query variables. Execution functions accept (`HashMap Name a`) instead of
|
||||||
|
`Subs`, where a is an instance of `VariableValue`.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- `Schema.scalar`, `Schema.wrappedScalar`. They accepted everything can be
|
||||||
|
converted to JSON and JSON is not suitable as an internal representation for
|
||||||
|
GraphQL. E.g. GraphQL distinguishes between Floats and Integers.
|
||||||
|
- `Schema.wrappedObject`, `Schema.object`, `Schema.resolversToMap`. There is no
|
||||||
|
need in special functions to construct field resolvers anymore, resolvers are
|
||||||
|
normal functions attached to the fields in the schema representation.
|
||||||
|
- `Schema.resolve` is superseded by `Execute.Execution`.
|
||||||
|
- `Error.runAppendErrs` isn't used anywhere.
|
||||||
|
- `AST.Core`: `Document`, `Directive`, `Field`, `Fragment`, `Selection`, `Alias`
|
||||||
|
`TypeCondition` were modified, moved into `Execute.Transform.Document` and
|
||||||
|
made private. These types describe intermediate representation used by the
|
||||||
|
executor internally. Moving was required to avoid cyclic dependencies between
|
||||||
|
the executor and type system.
|
||||||
|
- `AST.Core` doesn't reexports anything.
|
||||||
|
|
||||||
|
## [0.7.0.0] - 2020-05-11
|
||||||
|
### Fixed
|
||||||
|
- Result of null encoding
|
||||||
|
- Block strings encoding
|
||||||
|
- Result of tab and newline encoding
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- AST for the GraphQL schema.
|
||||||
|
- Type system definition parser.
|
||||||
|
- `Trans.argument`.
|
||||||
|
- Schema extension parser.
|
||||||
|
- Contributing guidelines.
|
||||||
|
- `Schema.resolversToMap` (intended to be used internally).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Rename `AST.Definition` into `AST.Document.ExecutableDefinition`.
|
||||||
|
`AST.Document.TypeSystemDefinition` and `AST.Document.TypeSystemExtension`
|
||||||
|
can also be definitions.
|
||||||
|
- Move all AST data to `AST.Document` and reexport them.
|
||||||
|
- Rename `AST.OperationSelectionSet` to `AST.Document.SelectionSet`.
|
||||||
|
- Make `Schema.Subs` a `Data.HashMap.Strict` (was a function
|
||||||
|
`key -> Maybe value` before).
|
||||||
|
- Make `AST.Lexer.at` a text (symbol) parser. It was a char before and is
|
||||||
|
`symbol "@"` now.
|
||||||
|
- Replace `MonadIO` with a plain `Monad`. Since the tests don't use IO,
|
||||||
|
set the inner monad to `Identity`.
|
||||||
|
- `NonEmpty (Resolver m)` is now `HashMap Text (NonEmpty (Resolver m))`. Root
|
||||||
|
operation type can be any type, therefore a hashmap is needed. Since types
|
||||||
|
cannot be empty, we save the list of resolvers in the type as a non-empty
|
||||||
|
list. Currently only "Query" and "Mutation" are supported as types. For more
|
||||||
|
schema support is required. The executor checks now if the type in the query
|
||||||
|
matches the type of the provided root resolvers.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- `AST.Field`, `AST.InlineFragment` and `AST.FragmentSpread`.
|
||||||
|
These types are only used in `AST.Selection` and `AST.Selection` contains now
|
||||||
|
3 corresponding data constructors, `Field`, `InlineFragment` and
|
||||||
|
`FragmentSpread`, instead of separate types. It simplifies pattern matching
|
||||||
|
and doesn't make the code less typesafe.
|
||||||
|
- `Schema.scalarA`.
|
||||||
|
- `Schema.wrappedScalarA`.
|
||||||
|
- `Schema.wrappedObjectA`.
|
||||||
|
- `Schema.objectA`.
|
||||||
|
- `AST.Argument`. Replaced with `AST.Arguments` which holds all arguments as a
|
||||||
|
key/value map.
|
||||||
|
|
||||||
|
## [0.6.1.0] - 2019-12-23
|
||||||
|
### Fixed
|
||||||
|
- Parsing multiple string arguments, such as
|
||||||
|
`login(username: "username", password: "password")` would fail on the comma
|
||||||
|
due to strings not having a space consumer.
|
||||||
|
- Fragment spread is evaluated based on the `__typename` resolver. If the
|
||||||
|
resolver is missing, it is assumed that the type condition is satisfied (all
|
||||||
|
fragments are included).
|
||||||
|
- Escaping characters during encoding.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Directive support (@skip and @include).
|
||||||
|
- Pretifying multi-line string arguments as block strings.
|
||||||
|
|
||||||
## [0.6.0.0] - 2019-11-27
|
## [0.6.0.0] - 2019-11-27
|
||||||
### Changed
|
### Changed
|
||||||
- `Language.GraphQL.Encoder` moved to `Language.GraphQL.AST.Encoder`.
|
- `Language.GraphQL.Encoder` moved to `Language.GraphQL.AST.Encoder`.
|
||||||
@ -148,6 +267,9 @@ All notable changes to this project will be documented in this file.
|
|||||||
### Added
|
### Added
|
||||||
- Data types for the GraphQL language.
|
- Data types for the GraphQL language.
|
||||||
|
|
||||||
|
[0.8.0.0]: https://github.com/caraus-ecms/graphql/compare/v0.7.0.0...v0.8.0.0
|
||||||
|
[0.7.0.0]: https://github.com/caraus-ecms/graphql/compare/v0.6.1.0...v0.7.0.0
|
||||||
|
[0.6.1.0]: https://github.com/caraus-ecms/graphql/compare/v0.6.0.0...v0.6.1.0
|
||||||
[0.6.0.0]: https://github.com/caraus-ecms/graphql/compare/v0.5.1.0...v0.6.0.0
|
[0.6.0.0]: https://github.com/caraus-ecms/graphql/compare/v0.5.1.0...v0.6.0.0
|
||||||
[0.5.1.0]: https://github.com/caraus-ecms/graphql/compare/v0.5.0.1...v0.5.1.0
|
[0.5.1.0]: https://github.com/caraus-ecms/graphql/compare/v0.5.0.1...v0.5.1.0
|
||||||
[0.5.0.1]: https://github.com/caraus-ecms/graphql/compare/v0.5.0.0...v0.5.0.1
|
[0.5.0.1]: https://github.com/caraus-ecms/graphql/compare/v0.5.0.0...v0.5.0.1
|
||||||
|
31
CONTRIBUTING.md
Normal file
31
CONTRIBUTING.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Contributing guidelines
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
To ensure all code changes adhere to existing code quality standards, some
|
||||||
|
automatic checks can be run locally.
|
||||||
|
|
||||||
|
Ensure that the code builds without warnings and passes the tests:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
stack test --pedantic
|
||||||
|
```
|
||||||
|
|
||||||
|
And also run the linter on your code:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
stack build hlint
|
||||||
|
stack exec hlint -- src tests
|
||||||
|
```
|
||||||
|
|
||||||
|
Build the documentation and check if you get any warnings:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
stack haddock
|
||||||
|
```
|
||||||
|
|
||||||
|
Validate that literate Haskell (tutorials) files compile without any warnings:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
stack ghc -- -Wall -fno-code docs/tutorial/*.lhs
|
||||||
|
```
|
2
LICENSE
2
LICENSE
@ -1,4 +1,4 @@
|
|||||||
Copyright 2019 Eugen Wissner, Germany
|
Copyright 2019-2020 Eugen Wissner, Germany
|
||||||
Copyright 2015-2017 J. Daniel Navarro
|
Copyright 2015-2017 J. Daniel Navarro
|
||||||
|
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
@ -24,11 +24,18 @@ For the list of currently missing features see issues marked as
|
|||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
API documentation is available through
|
API documentation is available through
|
||||||
[hackage](https://hackage.haskell.org/package/graphql).
|
[Hackage](https://hackage.haskell.org/package/graphql).
|
||||||
|
|
||||||
You'll also find a small tutorial with some examples under
|
You'll also find a small tutorial with some examples under
|
||||||
[docs/tutorial](https://github.com/caraus-ecms/graphql/tree/master/docs/tutorial).
|
[docs/tutorial](https://github.com/caraus-ecms/graphql/tree/master/docs/tutorial).
|
||||||
|
|
||||||
|
## Further information
|
||||||
|
|
||||||
|
- [Contributing guidelines](CONTRIBUTING.md).
|
||||||
|
- [Changelog](CHANGELOG.md) – this one contains the most recent changes;
|
||||||
|
individual changelogs for specific versions can be found on
|
||||||
|
[Hackage](https://hackage.haskell.org/package/graphql).
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
Suggestions, contributions and bug reports are welcome.
|
Suggestions, contributions and bug reports are welcome.
|
||||||
|
@ -12,20 +12,20 @@ We have written a small tutorial to help you (and ourselves) understand the grap
|
|||||||
Since this file is a literate haskell file, we start by importing some dependencies.
|
Since this file is a literate haskell file, we start by importing some dependencies.
|
||||||
|
|
||||||
> {-# LANGUAGE OverloadedStrings #-}
|
> {-# LANGUAGE OverloadedStrings #-}
|
||||||
> {-# LANGUAGE LambdaCase #-}
|
|
||||||
> module Main where
|
> module Main where
|
||||||
>
|
>
|
||||||
> import Control.Monad.IO.Class (liftIO)
|
> import Control.Monad.IO.Class (liftIO)
|
||||||
> import Control.Monad.Trans.Except (throwE)
|
|
||||||
> import Data.Aeson (encode)
|
> import Data.Aeson (encode)
|
||||||
> import Data.ByteString.Lazy.Char8 (putStrLn)
|
> import Data.ByteString.Lazy.Char8 (putStrLn)
|
||||||
> import Data.List.NonEmpty (NonEmpty(..))
|
> import qualified Data.HashMap.Strict as HashMap
|
||||||
> import Data.Text (Text)
|
> import Data.Text (Text)
|
||||||
|
> import qualified Data.Text as Text
|
||||||
> import Data.Time (getCurrentTime)
|
> import Data.Time (getCurrentTime)
|
||||||
>
|
>
|
||||||
> import Language.GraphQL
|
> import Language.GraphQL
|
||||||
> import qualified Language.GraphQL.Schema as Schema
|
> import Language.GraphQL.Trans
|
||||||
> import Language.GraphQL.Trans (ActionT(..))
|
> import Language.GraphQL.Type
|
||||||
|
> import qualified Language.GraphQL.Type.Out as Out
|
||||||
>
|
>
|
||||||
> import Prelude hiding (putStrLn)
|
> import Prelude hiding (putStrLn)
|
||||||
|
|
||||||
@ -36,11 +36,19 @@ example from [graphql.js](https://github.com/graphql/graphql-js).
|
|||||||
|
|
||||||
First we build a GraphQL schema.
|
First we build a GraphQL schema.
|
||||||
|
|
||||||
> schema1 :: NonEmpty (Schema.Resolver IO)
|
> schema1 :: Schema IO
|
||||||
> schema1 = hello :| []
|
> schema1 = Schema queryType Nothing
|
||||||
>
|
>
|
||||||
> hello :: Schema.Resolver IO
|
> queryType :: ObjectType IO
|
||||||
> hello = Schema.scalar "hello" (return ("it's me" :: Text))
|
> queryType = ObjectType "Query" Nothing []
|
||||||
|
> $ HashMap.singleton "hello"
|
||||||
|
> $ Out.Resolver helloField hello
|
||||||
|
>
|
||||||
|
> helloField :: Field IO
|
||||||
|
> helloField = Field Nothing (Out.NamedScalarType string) mempty
|
||||||
|
>
|
||||||
|
> hello :: ActionT IO Value
|
||||||
|
> hello = pure $ String "it's me"
|
||||||
|
|
||||||
This defines a simple schema with one type and one field, that resolves to a fixed value.
|
This defines a simple schema with one type and one field, that resolves to a fixed value.
|
||||||
|
|
||||||
@ -53,7 +61,7 @@ Next we define our query.
|
|||||||
To run the query, we call the `graphql` with the schema and the query.
|
To run the query, we call the `graphql` with the schema and the query.
|
||||||
|
|
||||||
> main1 :: IO ()
|
> main1 :: IO ()
|
||||||
> main1 = putStrLn =<< encode <$> graphql schema1 query1
|
> main1 = graphql schema1 query1 >>= putStrLn . encode
|
||||||
|
|
||||||
This runs the query by fetching the one field defined,
|
This runs the query by fetching the one field defined,
|
||||||
returning
|
returning
|
||||||
@ -66,14 +74,21 @@ returning
|
|||||||
|
|
||||||
For this example, we're going to be using time.
|
For this example, we're going to be using time.
|
||||||
|
|
||||||
> schema2 :: NonEmpty (Schema.Resolver IO)
|
> schema2 :: Schema IO
|
||||||
> schema2 = time :| []
|
> schema2 = Schema queryType2 Nothing
|
||||||
>
|
>
|
||||||
> time :: Schema.Resolver IO
|
> queryType2 :: ObjectType IO
|
||||||
> time = Schema.scalarA "time" $ \case
|
> queryType2 = ObjectType "Query" Nothing []
|
||||||
> [] -> do t <- liftIO getCurrentTime
|
> $ HashMap.singleton "time"
|
||||||
> return $ show t
|
> $ Out.Resolver timeField time
|
||||||
> _ -> ActionT $ throwE "Invalid arguments."
|
>
|
||||||
|
> timeField :: Field IO
|
||||||
|
> timeField = Field Nothing (Out.NamedScalarType string) mempty
|
||||||
|
>
|
||||||
|
> time :: ActionT IO Value
|
||||||
|
> time = do
|
||||||
|
> t <- liftIO getCurrentTime
|
||||||
|
> pure $ String $ Text.pack $ show t
|
||||||
|
|
||||||
This defines a simple schema with one type and one field,
|
This defines a simple schema with one type and one field,
|
||||||
which resolves to the current time.
|
which resolves to the current time.
|
||||||
@ -84,7 +99,7 @@ Next we define our query.
|
|||||||
> query2 = "{ time }"
|
> query2 = "{ time }"
|
||||||
>
|
>
|
||||||
> main2 :: IO ()
|
> main2 :: IO ()
|
||||||
> main2 = putStrLn =<< encode <$> graphql schema2 query2
|
> main2 = graphql schema2 query2 >>= putStrLn . encode
|
||||||
|
|
||||||
This runs the query, returning the current time
|
This runs the query, returning the current time
|
||||||
|
|
||||||
@ -126,14 +141,20 @@ This will fail
|
|||||||
|
|
||||||
Now that we have two resolvers, we can define a schema which uses them both.
|
Now that we have two resolvers, we can define a schema which uses them both.
|
||||||
|
|
||||||
> schema3 :: NonEmpty (Schema.Resolver IO)
|
> schema3 :: Schema IO
|
||||||
> schema3 = hello :| [time]
|
> schema3 = Schema queryType3 Nothing
|
||||||
|
>
|
||||||
|
> queryType3 :: ObjectType IO
|
||||||
|
> queryType3 = ObjectType "Query" Nothing [] $ HashMap.fromList
|
||||||
|
> [ ("hello", Out.Resolver helloField hello)
|
||||||
|
> , ("time", Out.Resolver timeField time)
|
||||||
|
> ]
|
||||||
>
|
>
|
||||||
> query3 :: Text
|
> query3 :: Text
|
||||||
> query3 = "query timeAndHello { time hello }"
|
> query3 = "query timeAndHello { time hello }"
|
||||||
>
|
>
|
||||||
> main3 :: IO ()
|
> main3 :: IO ()
|
||||||
> main3 = putStrLn =<< encode <$> graphql schema3 query3
|
> main3 = graphql schema3 query3 >>= putStrLn . encode
|
||||||
|
|
||||||
This queries for both time and hello, returning
|
This queries for both time and hello, returning
|
||||||
|
|
||||||
|
14
package.yaml
14
package.yaml
@ -1,5 +1,5 @@
|
|||||||
name: graphql
|
name: graphql
|
||||||
version: 0.6.0.0
|
version: 0.8.0.0
|
||||||
synopsis: Haskell GraphQL implementation
|
synopsis: Haskell GraphQL implementation
|
||||||
description:
|
description:
|
||||||
This package provides a rudimentary parser for the
|
This package provides a rudimentary parser for the
|
||||||
@ -8,7 +8,7 @@ maintainer: belka@caraus.de
|
|||||||
github: caraus-ecms/graphql
|
github: caraus-ecms/graphql
|
||||||
category: Language
|
category: Language
|
||||||
copyright:
|
copyright:
|
||||||
- (c) 2019 Eugen Wissner
|
- (c) 2019-2020 Eugen Wissner
|
||||||
- (c) 2015-2017 J. Daniel Navarro
|
- (c) 2015-2017 J. Daniel Navarro
|
||||||
author:
|
author:
|
||||||
- Danny Navarro <j@dannynavarro.net>
|
- Danny Navarro <j@dannynavarro.net>
|
||||||
@ -30,14 +30,21 @@ dependencies:
|
|||||||
- base >= 4.7 && < 5
|
- base >= 4.7 && < 5
|
||||||
- containers
|
- containers
|
||||||
- megaparsec
|
- megaparsec
|
||||||
|
- parser-combinators
|
||||||
|
- scientific
|
||||||
- text
|
- text
|
||||||
- transformers
|
- transformers
|
||||||
- unordered-containers
|
- unordered-containers
|
||||||
|
- vector
|
||||||
|
|
||||||
library:
|
library:
|
||||||
source-dirs: src
|
source-dirs: src
|
||||||
other-modules:
|
other-modules:
|
||||||
- Language.GraphQL.AST.Transform
|
- Language.GraphQL.Execute.Execution
|
||||||
|
- Language.GraphQL.Execute.Transform
|
||||||
|
- Language.GraphQL.Type.Definition
|
||||||
|
- Language.GraphQL.Type.Directive
|
||||||
|
- Language.GraphQL.Type.Schema
|
||||||
|
|
||||||
tests:
|
tests:
|
||||||
tasty:
|
tasty:
|
||||||
@ -52,4 +59,5 @@ tests:
|
|||||||
- hspec
|
- hspec
|
||||||
- hspec-expectations
|
- hspec-expectations
|
||||||
- hspec-megaparsec
|
- hspec-megaparsec
|
||||||
|
- QuickCheck
|
||||||
- raw-strings-qq
|
- raw-strings-qq
|
||||||
|
@ -8,7 +8,12 @@ setup() {
|
|||||||
then
|
then
|
||||||
curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C $SEMAPHORE_CACHE_DIR '*/stack'
|
curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C $SEMAPHORE_CACHE_DIR '*/stack'
|
||||||
fi
|
fi
|
||||||
|
if [ -e "$SEMAPHORE_CACHE_DIR/graphql.cabal" ]
|
||||||
|
then
|
||||||
|
cp -a $SEMAPHORE_CACHE_DIR/graphql.cabal graphql.cabal
|
||||||
|
fi
|
||||||
$STACK --no-terminal setup
|
$STACK --no-terminal setup
|
||||||
|
cp -a graphql.cabal $SEMAPHORE_CACHE_DIR/graphql.cabal
|
||||||
}
|
}
|
||||||
|
|
||||||
setup_test() {
|
setup_test() {
|
||||||
|
@ -4,31 +4,32 @@ module Language.GraphQL
|
|||||||
, graphqlSubs
|
, graphqlSubs
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Monad.IO.Class (MonadIO)
|
|
||||||
import qualified Data.Aeson as Aeson
|
import qualified Data.Aeson as Aeson
|
||||||
import Data.List.NonEmpty (NonEmpty)
|
import Data.HashMap.Strict (HashMap)
|
||||||
import qualified Data.Text as T
|
import Data.Text (Text)
|
||||||
|
import Language.GraphQL.AST.Document
|
||||||
|
import Language.GraphQL.AST.Parser
|
||||||
import Language.GraphQL.Error
|
import Language.GraphQL.Error
|
||||||
import Language.GraphQL.Execute
|
import Language.GraphQL.Execute
|
||||||
import Language.GraphQL.AST.Parser
|
import Language.GraphQL.Execute.Coerce
|
||||||
import qualified Language.GraphQL.Schema as Schema
|
import Language.GraphQL.Type.Schema
|
||||||
import Text.Megaparsec (parse)
|
import Text.Megaparsec (parse)
|
||||||
|
|
||||||
-- | If the text parses correctly as a @GraphQL@ query the query is
|
-- | If the text parses correctly as a @GraphQL@ query the query is
|
||||||
-- executed using the given 'Schema.Resolver's.
|
-- executed using the given 'Schema'.
|
||||||
graphql :: MonadIO m
|
graphql :: Monad m
|
||||||
=> NonEmpty (Schema.Resolver m) -- ^ Resolvers.
|
=> Schema m -- ^ Resolvers.
|
||||||
-> T.Text -- ^ Text representing a @GraphQL@ request document.
|
-> Text -- ^ Text representing a @GraphQL@ request document.
|
||||||
-> m Aeson.Value -- ^ Response.
|
-> m Aeson.Value -- ^ Response.
|
||||||
graphql = flip graphqlSubs $ const Nothing
|
graphql = flip graphqlSubs (mempty :: Aeson.Object)
|
||||||
|
|
||||||
-- | If the text parses correctly as a @GraphQL@ query the substitution is
|
-- | If the text parses correctly as a @GraphQL@ query the substitution is
|
||||||
-- applied to the query and the query is then executed using to the given
|
-- applied to the query and the query is then executed using to the given
|
||||||
-- 'Schema.Resolver's.
|
-- 'Schema'.
|
||||||
graphqlSubs :: MonadIO m
|
graphqlSubs :: (Monad m, VariableValue a)
|
||||||
=> NonEmpty (Schema.Resolver m) -- ^ Resolvers.
|
=> Schema m -- ^ Resolvers.
|
||||||
-> Schema.Subs -- ^ Variable substitution function.
|
-> HashMap Name a -- ^ Variable substitution function.
|
||||||
-> T.Text -- ^ Text representing a @GraphQL@ request document.
|
-> Text -- ^ Text representing a @GraphQL@ request document.
|
||||||
-> m Aeson.Value -- ^ Response.
|
-> m Aeson.Value -- ^ Response.
|
||||||
graphqlSubs schema f
|
graphqlSubs schema f
|
||||||
= either parseError (execute schema f)
|
= either parseError (execute schema f)
|
||||||
|
@ -1,185 +1,6 @@
|
|||||||
-- | This module defines an abstract syntax tree for the @GraphQL@ language based on
|
-- | Target AST for Parser.
|
||||||
-- <https://facebook.github.io/graphql/ Facebook's GraphQL Specification>.
|
|
||||||
--
|
|
||||||
-- Target AST for Parser.
|
|
||||||
module Language.GraphQL.AST
|
module Language.GraphQL.AST
|
||||||
( Alias
|
( module Language.GraphQL.AST.Document
|
||||||
, Argument(..)
|
|
||||||
, Definition(..)
|
|
||||||
, Directive(..)
|
|
||||||
, Document
|
|
||||||
, Field(..)
|
|
||||||
, FragmentDefinition(..)
|
|
||||||
, FragmentSpread(..)
|
|
||||||
, InlineFragment(..)
|
|
||||||
, Name
|
|
||||||
, NonNullType(..)
|
|
||||||
, ObjectField(..)
|
|
||||||
, OperationDefinition(..)
|
|
||||||
, OperationType(..)
|
|
||||||
, Selection(..)
|
|
||||||
, SelectionSet
|
|
||||||
, SelectionSetOpt
|
|
||||||
, Type(..)
|
|
||||||
, TypeCondition
|
|
||||||
, Value(..)
|
|
||||||
, VariableDefinition(..)
|
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Data.Int (Int32)
|
import Language.GraphQL.AST.Document
|
||||||
import Data.List.NonEmpty (NonEmpty)
|
|
||||||
import Data.Text (Text)
|
|
||||||
|
|
||||||
-- * Document
|
|
||||||
|
|
||||||
-- | GraphQL document.
|
|
||||||
type Document = NonEmpty Definition
|
|
||||||
|
|
||||||
-- | Name
|
|
||||||
type Name = Text
|
|
||||||
|
|
||||||
-- | Directive.
|
|
||||||
data Directive = Directive Name [Argument] deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- * Operations
|
|
||||||
|
|
||||||
-- | Top-level definition of a document, either an operation or a fragment.
|
|
||||||
data Definition
|
|
||||||
= DefinitionOperation OperationDefinition
|
|
||||||
| DefinitionFragment FragmentDefinition
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Operation definition.
|
|
||||||
data OperationDefinition
|
|
||||||
= OperationSelectionSet SelectionSet
|
|
||||||
| OperationDefinition OperationType
|
|
||||||
(Maybe Name)
|
|
||||||
[VariableDefinition]
|
|
||||||
[Directive]
|
|
||||||
SelectionSet
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | GraphQL has 3 operation types: queries, mutations and subscribtions.
|
|
||||||
--
|
|
||||||
-- Currently only queries and mutations are supported.
|
|
||||||
data OperationType = Query | Mutation deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- * Selections
|
|
||||||
|
|
||||||
-- | "Top-level" selection, selection on an operation or fragment.
|
|
||||||
type SelectionSet = NonEmpty Selection
|
|
||||||
|
|
||||||
-- | Field selection.
|
|
||||||
type SelectionSetOpt = [Selection]
|
|
||||||
|
|
||||||
-- | Single selection element.
|
|
||||||
data Selection
|
|
||||||
= SelectionField Field
|
|
||||||
| SelectionFragmentSpread FragmentSpread
|
|
||||||
| SelectionInlineFragment InlineFragment
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- * Field
|
|
||||||
|
|
||||||
-- | Single GraphQL field.
|
|
||||||
--
|
|
||||||
-- The only required property of a field is its name. Optionally it can also
|
|
||||||
-- have an alias, arguments or a list of subfields.
|
|
||||||
--
|
|
||||||
-- Given the following query:
|
|
||||||
--
|
|
||||||
-- @
|
|
||||||
-- {
|
|
||||||
-- zuck: user(id: 4) {
|
|
||||||
-- id
|
|
||||||
-- name
|
|
||||||
-- }
|
|
||||||
-- }
|
|
||||||
-- @
|
|
||||||
--
|
|
||||||
-- * "user", "id" and "name" are field names.
|
|
||||||
-- * "user" has two subfields, "id" and "name".
|
|
||||||
-- * "zuck" is an alias for "user". "id" and "name" have no aliases.
|
|
||||||
-- * "id: 4" is an argument for "user". "id" and "name" don't have any
|
|
||||||
-- arguments.
|
|
||||||
data Field
|
|
||||||
= Field (Maybe Alias) Name [Argument] [Directive] SelectionSetOpt
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Alternative field name.
|
|
||||||
--
|
|
||||||
-- @
|
|
||||||
-- {
|
|
||||||
-- smallPic: profilePic(size: 64)
|
|
||||||
-- bigPic: profilePic(size: 1024)
|
|
||||||
-- }
|
|
||||||
-- @
|
|
||||||
--
|
|
||||||
-- Here "smallPic" and "bigPic" are aliases for the same field, "profilePic",
|
|
||||||
-- used to distinquish between profile pictures with different arguments
|
|
||||||
-- (sizes).
|
|
||||||
type Alias = Name
|
|
||||||
|
|
||||||
-- | Single argument.
|
|
||||||
--
|
|
||||||
-- @
|
|
||||||
-- {
|
|
||||||
-- user(id: 4) {
|
|
||||||
-- name
|
|
||||||
-- }
|
|
||||||
-- }
|
|
||||||
-- @
|
|
||||||
--
|
|
||||||
-- Here "id" is an argument for the field "user" and its value is 4.
|
|
||||||
data Argument = Argument Name Value deriving (Eq,Show)
|
|
||||||
|
|
||||||
-- * Fragments
|
|
||||||
|
|
||||||
-- | Fragment spread.
|
|
||||||
data FragmentSpread = FragmentSpread Name [Directive] deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Inline fragment.
|
|
||||||
data InlineFragment = InlineFragment (Maybe TypeCondition) [Directive] SelectionSet
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Fragment definition.
|
|
||||||
data FragmentDefinition
|
|
||||||
= FragmentDefinition Name TypeCondition [Directive] SelectionSet
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- * Inputs
|
|
||||||
|
|
||||||
-- | Input value.
|
|
||||||
data Value = Variable Name
|
|
||||||
| Int Int32
|
|
||||||
| Float Double
|
|
||||||
| String Text
|
|
||||||
| Boolean Bool
|
|
||||||
| Null
|
|
||||||
| Enum Name
|
|
||||||
| List [Value]
|
|
||||||
| Object [ObjectField]
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Key-value pair.
|
|
||||||
--
|
|
||||||
-- A list of 'ObjectField's represents a GraphQL object type.
|
|
||||||
data ObjectField = ObjectField Name Value deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Variable definition.
|
|
||||||
data VariableDefinition = VariableDefinition Name Type (Maybe Value)
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Type condition.
|
|
||||||
type TypeCondition = Name
|
|
||||||
|
|
||||||
-- | Type representation.
|
|
||||||
data Type = TypeNamed Name
|
|
||||||
| TypeList Type
|
|
||||||
| TypeNonNull NonNullType
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Helper type to represent Non-Null types and lists of such types.
|
|
||||||
data NonNullType = NonNullTypeNamed Name
|
|
||||||
| NonNullTypeList Type
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
@ -1,66 +1,19 @@
|
|||||||
-- | This is the AST meant to be executed.
|
-- | This is the AST meant to be executed.
|
||||||
module Language.GraphQL.AST.Core
|
module Language.GraphQL.AST.Core
|
||||||
( Alias
|
( Arguments(..)
|
||||||
, Argument(..)
|
|
||||||
, Document
|
|
||||||
, Field(..)
|
|
||||||
, Fragment(..)
|
|
||||||
, Name
|
|
||||||
, Operation(..)
|
|
||||||
, Selection(..)
|
|
||||||
, TypeCondition
|
|
||||||
, Value(..)
|
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Data.Int (Int32)
|
|
||||||
import Data.HashMap.Strict (HashMap)
|
import Data.HashMap.Strict (HashMap)
|
||||||
import Data.List.NonEmpty (NonEmpty)
|
import Language.GraphQL.AST (Name)
|
||||||
import Data.Sequence (Seq)
|
import Language.GraphQL.Type.Definition
|
||||||
import Data.String (IsString(..))
|
|
||||||
import Data.Text (Text)
|
|
||||||
import Language.GraphQL.AST (Alias, Name, TypeCondition)
|
|
||||||
|
|
||||||
-- | GraphQL document is a non-empty list of operations.
|
-- | Argument list.
|
||||||
type Document = NonEmpty Operation
|
newtype Arguments = Arguments (HashMap Name Value)
|
||||||
|
|
||||||
-- | GraphQL has 3 operation types: queries, mutations and subscribtions.
|
|
||||||
--
|
|
||||||
-- Currently only queries and mutations are supported.
|
|
||||||
data Operation
|
|
||||||
= Query (Maybe Text) (Seq Selection)
|
|
||||||
| Mutation (Maybe Text) (Seq Selection)
|
|
||||||
deriving (Eq, Show)
|
deriving (Eq, Show)
|
||||||
|
|
||||||
-- | Single GraphQL field.
|
instance Semigroup Arguments where
|
||||||
data Field
|
(Arguments x) <> (Arguments y) = Arguments $ x <> y
|
||||||
= Field (Maybe Alias) Name [Argument] (Seq Selection)
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Single argument.
|
instance Monoid Arguments where
|
||||||
data Argument = Argument Name Value deriving (Eq, Show)
|
mempty = Arguments mempty
|
||||||
|
|
||||||
-- | Represents fragments and inline fragments.
|
|
||||||
data Fragment
|
|
||||||
= Fragment TypeCondition (Seq Selection)
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Single selection element.
|
|
||||||
data Selection
|
|
||||||
= SelectionFragment Fragment
|
|
||||||
| SelectionField Field
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
-- | Represents accordingly typed GraphQL values.
|
|
||||||
data Value
|
|
||||||
= Int Int32
|
|
||||||
| Float Double -- ^ GraphQL Float is double precision
|
|
||||||
| String Text
|
|
||||||
| Boolean Bool
|
|
||||||
| Null
|
|
||||||
| Enum Name
|
|
||||||
| List [Value]
|
|
||||||
| Object (HashMap Name Value)
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
instance IsString Value where
|
|
||||||
fromString = String . fromString
|
|
||||||
|
41
src/Language/GraphQL/AST/DirectiveLocation.hs
Normal file
41
src/Language/GraphQL/AST/DirectiveLocation.hs
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
-- | Various parts of a GraphQL document can be annotated with directives.
|
||||||
|
-- This module describes locations in a document where directives can appear.
|
||||||
|
module Language.GraphQL.AST.DirectiveLocation
|
||||||
|
( DirectiveLocation(..)
|
||||||
|
, ExecutableDirectiveLocation(..)
|
||||||
|
, TypeSystemDirectiveLocation(..)
|
||||||
|
) where
|
||||||
|
|
||||||
|
-- | All directives can be splitted in two groups: directives used to annotate
|
||||||
|
-- various parts of executable definitions and the ones used in the schema
|
||||||
|
-- definition.
|
||||||
|
data DirectiveLocation
|
||||||
|
= ExecutableDirectiveLocation ExecutableDirectiveLocation
|
||||||
|
| TypeSystemDirectiveLocation TypeSystemDirectiveLocation
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Where directives can appear in an executable definition, like a query.
|
||||||
|
data ExecutableDirectiveLocation
|
||||||
|
= Query
|
||||||
|
| Mutation
|
||||||
|
| Subscription
|
||||||
|
| Field
|
||||||
|
| FragmentDefinition
|
||||||
|
| FragmentSpread
|
||||||
|
| InlineFragment
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Where directives can appear in a type system definition.
|
||||||
|
data TypeSystemDirectiveLocation
|
||||||
|
= Schema
|
||||||
|
| Scalar
|
||||||
|
| Object
|
||||||
|
| FieldDefinition
|
||||||
|
| ArgumentDefinition
|
||||||
|
| Interface
|
||||||
|
| Union
|
||||||
|
| Enum
|
||||||
|
| EnumValue
|
||||||
|
| InputObject
|
||||||
|
| InputFieldDefinition
|
||||||
|
deriving (Eq, Show)
|
515
src/Language/GraphQL/AST/Document.hs
Normal file
515
src/Language/GraphQL/AST/Document.hs
Normal file
@ -0,0 +1,515 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
|
||||||
|
-- | This module defines an abstract syntax tree for the @GraphQL@ language. It
|
||||||
|
-- follows closely the structure given in the specification. Please refer to
|
||||||
|
-- <https://facebook.github.io/graphql/ Facebook's GraphQL Specification>.
|
||||||
|
-- for more information.
|
||||||
|
module Language.GraphQL.AST.Document
|
||||||
|
( Alias
|
||||||
|
, Argument(..)
|
||||||
|
, ArgumentsDefinition(..)
|
||||||
|
, ConstValue(..)
|
||||||
|
, Definition(..)
|
||||||
|
, Description(..)
|
||||||
|
, Directive(..)
|
||||||
|
, Document
|
||||||
|
, EnumValueDefinition(..)
|
||||||
|
, ExecutableDefinition(..)
|
||||||
|
, FieldDefinition(..)
|
||||||
|
, FragmentDefinition(..)
|
||||||
|
, ImplementsInterfaces(..)
|
||||||
|
, InputValueDefinition(..)
|
||||||
|
, Name
|
||||||
|
, NamedType
|
||||||
|
, NonNullType(..)
|
||||||
|
, ObjectField(..)
|
||||||
|
, OperationDefinition(..)
|
||||||
|
, OperationType(..)
|
||||||
|
, OperationTypeDefinition(..)
|
||||||
|
, SchemaExtension(..)
|
||||||
|
, Selection(..)
|
||||||
|
, SelectionSet
|
||||||
|
, SelectionSetOpt
|
||||||
|
, Type(..)
|
||||||
|
, TypeCondition
|
||||||
|
, TypeDefinition(..)
|
||||||
|
, TypeExtension(..)
|
||||||
|
, TypeSystemDefinition(..)
|
||||||
|
, TypeSystemExtension(..)
|
||||||
|
, UnionMemberTypes(..)
|
||||||
|
, Value(..)
|
||||||
|
, VariableDefinition(..)
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Foldable (toList)
|
||||||
|
import Data.Int (Int32)
|
||||||
|
import Data.List.NonEmpty (NonEmpty)
|
||||||
|
import Data.Text (Text)
|
||||||
|
import qualified Data.Text as Text
|
||||||
|
import Language.GraphQL.AST.DirectiveLocation
|
||||||
|
|
||||||
|
-- * Language
|
||||||
|
|
||||||
|
-- ** Source Text
|
||||||
|
|
||||||
|
-- | Name.
|
||||||
|
type Name = Text
|
||||||
|
|
||||||
|
-- ** Document
|
||||||
|
|
||||||
|
-- | GraphQL document.
|
||||||
|
type Document = NonEmpty Definition
|
||||||
|
|
||||||
|
-- | All kinds of definitions that can occur in a GraphQL document.
|
||||||
|
data Definition
|
||||||
|
= ExecutableDefinition ExecutableDefinition
|
||||||
|
| TypeSystemDefinition TypeSystemDefinition
|
||||||
|
| TypeSystemExtension TypeSystemExtension
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Top-level definition of a document, either an operation or a fragment.
|
||||||
|
data ExecutableDefinition
|
||||||
|
= DefinitionOperation OperationDefinition
|
||||||
|
| DefinitionFragment FragmentDefinition
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Operations
|
||||||
|
|
||||||
|
-- | Operation definition.
|
||||||
|
data OperationDefinition
|
||||||
|
= SelectionSet SelectionSet
|
||||||
|
| OperationDefinition
|
||||||
|
OperationType
|
||||||
|
(Maybe Name)
|
||||||
|
[VariableDefinition]
|
||||||
|
[Directive]
|
||||||
|
SelectionSet
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | GraphQL has 3 operation types:
|
||||||
|
--
|
||||||
|
-- * query - a read-only fetch.
|
||||||
|
-- * mutation - a write operation followed by a fetch.
|
||||||
|
-- * subscription - a long-lived request that fetches data in response to
|
||||||
|
-- source events.
|
||||||
|
--
|
||||||
|
-- Currently only queries and mutations are supported.
|
||||||
|
data OperationType = Query | Mutation deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Selection Sets
|
||||||
|
|
||||||
|
-- | "Top-level" selection, selection on an operation or fragment.
|
||||||
|
type SelectionSet = NonEmpty Selection
|
||||||
|
|
||||||
|
-- | Field selection.
|
||||||
|
type SelectionSetOpt = [Selection]
|
||||||
|
|
||||||
|
-- | Selection is a single entry in a selection set. It can be a single field,
|
||||||
|
-- fragment spread or inline fragment.
|
||||||
|
--
|
||||||
|
-- The only required property of a field is its name. Optionally it can also
|
||||||
|
-- have an alias, arguments, directives and a list of subfields.
|
||||||
|
--
|
||||||
|
-- In the following query "user" is a field with two subfields, "id" and "name":
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- {
|
||||||
|
-- user {
|
||||||
|
-- id
|
||||||
|
-- name
|
||||||
|
-- }
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- A fragment spread refers to a fragment defined outside the operation and is
|
||||||
|
-- expanded at the execution time.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- {
|
||||||
|
-- user {
|
||||||
|
-- ...userFragment
|
||||||
|
-- }
|
||||||
|
-- }
|
||||||
|
--
|
||||||
|
-- fragment userFragment on UserType {
|
||||||
|
-- id
|
||||||
|
-- name
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- Inline fragments are similar but they don't have any name and the type
|
||||||
|
-- condition ("on UserType") is optional.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- {
|
||||||
|
-- user {
|
||||||
|
-- ... on UserType {
|
||||||
|
-- id
|
||||||
|
-- name
|
||||||
|
-- }
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
data Selection
|
||||||
|
= Field (Maybe Alias) Name [Argument] [Directive] SelectionSetOpt
|
||||||
|
| FragmentSpread Name [Directive]
|
||||||
|
| InlineFragment (Maybe TypeCondition) [Directive] SelectionSet
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Arguments
|
||||||
|
|
||||||
|
-- | Single argument.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- {
|
||||||
|
-- user(id: 4) {
|
||||||
|
-- name
|
||||||
|
-- }
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- Here "id" is an argument for the field "user" and its value is 4.
|
||||||
|
data Argument = Argument Name Value deriving (Eq,Show)
|
||||||
|
|
||||||
|
-- ** Field Alias
|
||||||
|
|
||||||
|
-- | Alternative field name.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- {
|
||||||
|
-- smallPic: profilePic(size: 64)
|
||||||
|
-- bigPic: profilePic(size: 1024)
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- Here "smallPic" and "bigPic" are aliases for the same field, "profilePic",
|
||||||
|
-- used to distinquish between profile pictures with different arguments
|
||||||
|
-- (sizes).
|
||||||
|
type Alias = Name
|
||||||
|
|
||||||
|
-- ** Fragments
|
||||||
|
|
||||||
|
-- | Fragment definition.
|
||||||
|
data FragmentDefinition
|
||||||
|
= FragmentDefinition Name TypeCondition [Directive] SelectionSet
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Type condition.
|
||||||
|
type TypeCondition = Name
|
||||||
|
|
||||||
|
-- ** Input Values
|
||||||
|
|
||||||
|
-- | Input value (literal or variable).
|
||||||
|
data Value
|
||||||
|
= Variable Name
|
||||||
|
| Int Int32
|
||||||
|
| Float Double
|
||||||
|
| String Text
|
||||||
|
| Boolean Bool
|
||||||
|
| Null
|
||||||
|
| Enum Name
|
||||||
|
| List [Value]
|
||||||
|
| Object [ObjectField Value]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Constant input value.
|
||||||
|
data ConstValue
|
||||||
|
= ConstInt Int32
|
||||||
|
| ConstFloat Double
|
||||||
|
| ConstString Text
|
||||||
|
| ConstBoolean Bool
|
||||||
|
| ConstNull
|
||||||
|
| ConstEnum Name
|
||||||
|
| ConstList [ConstValue]
|
||||||
|
| ConstObject [ObjectField ConstValue]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Key-value pair.
|
||||||
|
--
|
||||||
|
-- A list of 'ObjectField's represents a GraphQL object type.
|
||||||
|
data ObjectField a = ObjectField Name a
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Variables
|
||||||
|
|
||||||
|
-- | Variable definition.
|
||||||
|
--
|
||||||
|
-- Each operation can include a list of variables:
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- query (protagonist: String = "Zarathustra") {
|
||||||
|
-- getAuthor(protagonist: $protagonist)
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- This query defines an optional variable @protagonist@ of type @String@,
|
||||||
|
-- its default value is "Zarathustra". If no default value is defined and no
|
||||||
|
-- value is provided, a variable can still be @null@ if its type is nullable.
|
||||||
|
--
|
||||||
|
-- Variables are usually passed along with the query, but not in the query
|
||||||
|
-- itself. They make queries reusable.
|
||||||
|
data VariableDefinition = VariableDefinition Name Type (Maybe ConstValue)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Type References
|
||||||
|
|
||||||
|
-- | Type representation.
|
||||||
|
data Type
|
||||||
|
= TypeNamed Name
|
||||||
|
| TypeList Type
|
||||||
|
| TypeNonNull NonNullType
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Represents type names.
|
||||||
|
type NamedType = Name
|
||||||
|
|
||||||
|
-- | Helper type to represent Non-Null types and lists of such types.
|
||||||
|
data NonNullType
|
||||||
|
= NonNullTypeNamed Name
|
||||||
|
| NonNullTypeList Type
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Directives
|
||||||
|
|
||||||
|
-- | Directive.
|
||||||
|
--
|
||||||
|
-- Directives begin with "@", can accept arguments, and can be applied to the
|
||||||
|
-- most GraphQL elements, providing additional information.
|
||||||
|
data Directive = Directive Name [Argument] deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- * Type System
|
||||||
|
|
||||||
|
-- | Type system can define a schema, a type or a directive.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- schema {
|
||||||
|
-- query: Query
|
||||||
|
-- }
|
||||||
|
--
|
||||||
|
-- directive @example on FIELD_DEFINITION
|
||||||
|
--
|
||||||
|
-- type Query {
|
||||||
|
-- field: String @example
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- This example defines a custom directive "@example", which is applied to a
|
||||||
|
-- field definition of the type definition "Query". On the top the schema
|
||||||
|
-- is defined by taking advantage of the type "Query".
|
||||||
|
data TypeSystemDefinition
|
||||||
|
= SchemaDefinition [Directive] (NonEmpty OperationTypeDefinition)
|
||||||
|
| TypeDefinition TypeDefinition
|
||||||
|
| DirectiveDefinition
|
||||||
|
Description Name ArgumentsDefinition (NonEmpty DirectiveLocation)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Type System Extensions
|
||||||
|
|
||||||
|
-- | Extension for a type system definition. Only schema and type definitions
|
||||||
|
-- can be extended.
|
||||||
|
data TypeSystemExtension
|
||||||
|
= SchemaExtension SchemaExtension
|
||||||
|
| TypeExtension TypeExtension
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Schema
|
||||||
|
|
||||||
|
-- | Root operation type definition.
|
||||||
|
--
|
||||||
|
-- Defining root operation types is not required since they have defaults. So
|
||||||
|
-- the default query root type is "Query", and the default mutation root type
|
||||||
|
-- is "Mutation". But these defaults can be changed for a specific schema. In
|
||||||
|
-- the following code the query root type is changed to "MyQueryRootType", and
|
||||||
|
-- the mutation root type to "MyMutationRootType":
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- schema {
|
||||||
|
-- query: MyQueryRootType
|
||||||
|
-- mutation: MyMutationRootType
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
data OperationTypeDefinition
|
||||||
|
= OperationTypeDefinition OperationType NamedType
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Extension of the schema definition by further operations or directives.
|
||||||
|
data SchemaExtension
|
||||||
|
= SchemaOperationExtension [Directive] (NonEmpty OperationTypeDefinition)
|
||||||
|
| SchemaDirectivesExtension (NonEmpty Directive)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Descriptions
|
||||||
|
|
||||||
|
-- | GraphQL has built-in capability to document service APIs. Documentation
|
||||||
|
-- is a GraphQL string that precedes a particular definition and contains
|
||||||
|
-- Markdown. Any GraphQL definition can be documented this way.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- """
|
||||||
|
-- Supported languages.
|
||||||
|
-- """
|
||||||
|
-- enum Language {
|
||||||
|
-- "English"
|
||||||
|
-- EN
|
||||||
|
--
|
||||||
|
-- "Russian"
|
||||||
|
-- RU
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
newtype Description = Description (Maybe Text)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Types
|
||||||
|
|
||||||
|
-- | Type definitions describe various user-defined types.
|
||||||
|
data TypeDefinition
|
||||||
|
= ScalarTypeDefinition Description Name [Directive]
|
||||||
|
| ObjectTypeDefinition
|
||||||
|
Description
|
||||||
|
Name
|
||||||
|
(ImplementsInterfaces [])
|
||||||
|
[Directive]
|
||||||
|
[FieldDefinition]
|
||||||
|
| InterfaceTypeDefinition Description Name [Directive] [FieldDefinition]
|
||||||
|
| UnionTypeDefinition Description Name [Directive] (UnionMemberTypes [])
|
||||||
|
| EnumTypeDefinition Description Name [Directive] [EnumValueDefinition]
|
||||||
|
| InputObjectTypeDefinition
|
||||||
|
Description Name [Directive] [InputValueDefinition]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Extensions for custom, already defined types.
|
||||||
|
data TypeExtension
|
||||||
|
= ScalarTypeExtension Name (NonEmpty Directive)
|
||||||
|
| ObjectTypeFieldsDefinitionExtension
|
||||||
|
Name (ImplementsInterfaces []) [Directive] (NonEmpty FieldDefinition)
|
||||||
|
| ObjectTypeDirectivesExtension
|
||||||
|
Name (ImplementsInterfaces []) (NonEmpty Directive)
|
||||||
|
| ObjectTypeImplementsInterfacesExtension
|
||||||
|
Name (ImplementsInterfaces NonEmpty)
|
||||||
|
| InterfaceTypeFieldsDefinitionExtension
|
||||||
|
Name [Directive] (NonEmpty FieldDefinition)
|
||||||
|
| InterfaceTypeDirectivesExtension Name (NonEmpty Directive)
|
||||||
|
| UnionTypeUnionMemberTypesExtension
|
||||||
|
Name [Directive] (UnionMemberTypes NonEmpty)
|
||||||
|
| UnionTypeDirectivesExtension Name (NonEmpty Directive)
|
||||||
|
| EnumTypeEnumValuesDefinitionExtension
|
||||||
|
Name [Directive] (NonEmpty EnumValueDefinition)
|
||||||
|
| EnumTypeDirectivesExtension Name (NonEmpty Directive)
|
||||||
|
| InputObjectTypeInputFieldsDefinitionExtension
|
||||||
|
Name [Directive] (NonEmpty InputValueDefinition)
|
||||||
|
| InputObjectTypeDirectivesExtension Name (NonEmpty Directive)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Objects
|
||||||
|
|
||||||
|
-- | Defines a list of interfaces implemented by the given object type.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- type Business implements NamedEntity & ValuedEntity {
|
||||||
|
-- name: String
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- Here the object type "Business" implements two interfaces: "NamedEntity" and
|
||||||
|
-- "ValuedEntity".
|
||||||
|
newtype ImplementsInterfaces t = ImplementsInterfaces (t NamedType)
|
||||||
|
|
||||||
|
instance Foldable t => Eq (ImplementsInterfaces t) where
|
||||||
|
(ImplementsInterfaces xs) == (ImplementsInterfaces ys)
|
||||||
|
= toList xs == toList ys
|
||||||
|
|
||||||
|
instance Foldable t => Show (ImplementsInterfaces t) where
|
||||||
|
show (ImplementsInterfaces interfaces) = Text.unpack
|
||||||
|
$ Text.append "implements"
|
||||||
|
$ Text.intercalate " & "
|
||||||
|
$ toList interfaces
|
||||||
|
|
||||||
|
-- | Definition of a single field in a type.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- type Person {
|
||||||
|
-- name: String
|
||||||
|
-- picture(width: Int, height: Int): Url
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- "name" and "picture", including their arguments and types, are field
|
||||||
|
-- definitions.
|
||||||
|
data FieldDefinition
|
||||||
|
= FieldDefinition Description Name ArgumentsDefinition Type [Directive]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | A list of values passed to a field.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- type Person {
|
||||||
|
-- name: String
|
||||||
|
-- picture(width: Int, height: Int): Url
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- "Person" has two fields, "name" and "picture". "name" doesn't have any
|
||||||
|
-- arguments, so 'ArgumentsDefinition' contains an empty list. "picture"
|
||||||
|
-- contains definitions for 2 arguments: "width" and "height".
|
||||||
|
newtype ArgumentsDefinition = ArgumentsDefinition [InputValueDefinition]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
instance Semigroup ArgumentsDefinition where
|
||||||
|
(ArgumentsDefinition xs) <> (ArgumentsDefinition ys) =
|
||||||
|
ArgumentsDefinition $ xs <> ys
|
||||||
|
|
||||||
|
instance Monoid ArgumentsDefinition where
|
||||||
|
mempty = ArgumentsDefinition []
|
||||||
|
|
||||||
|
-- | Defines an input value.
|
||||||
|
--
|
||||||
|
-- * Input values can define field arguments, see 'ArgumentsDefinition'.
|
||||||
|
-- * They can also be used as field definitions in an input type.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- input Point2D {
|
||||||
|
-- x: Float
|
||||||
|
-- y: Float
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- The input type "Point2D" contains two value definitions: "x" and "y".
|
||||||
|
data InputValueDefinition
|
||||||
|
= InputValueDefinition Description Name Type (Maybe ConstValue) [Directive]
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- ** Unions
|
||||||
|
|
||||||
|
-- | List of types forming a union.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- union SearchResult = Person | Photo
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- "Person" and "Photo" are member types of the union "SearchResult".
|
||||||
|
newtype UnionMemberTypes t = UnionMemberTypes (t NamedType)
|
||||||
|
|
||||||
|
instance Foldable t => Eq (UnionMemberTypes t) where
|
||||||
|
(UnionMemberTypes xs) == (UnionMemberTypes ys) = toList xs == toList ys
|
||||||
|
|
||||||
|
instance Foldable t => Show (UnionMemberTypes t) where
|
||||||
|
show (UnionMemberTypes memberTypes) = Text.unpack
|
||||||
|
$ Text.intercalate " | "
|
||||||
|
$ toList memberTypes
|
||||||
|
|
||||||
|
-- ** Enums
|
||||||
|
|
||||||
|
-- | Single value in an enum definition.
|
||||||
|
--
|
||||||
|
-- @
|
||||||
|
-- enum Direction {
|
||||||
|
-- NORTH
|
||||||
|
-- EAST
|
||||||
|
-- SOUTH
|
||||||
|
-- WEST
|
||||||
|
-- }
|
||||||
|
-- @
|
||||||
|
--
|
||||||
|
-- "NORTH, "EAST", "SOUTH", and "WEST" are value definitions of an enum type
|
||||||
|
-- definition "Direction".
|
||||||
|
data EnumValueDefinition = EnumValueDefinition Description Name [Directive]
|
||||||
|
deriving (Eq, Show)
|
@ -13,15 +13,18 @@ module Language.GraphQL.AST.Encoder
|
|||||||
, value
|
, value
|
||||||
) where
|
) where
|
||||||
|
|
||||||
|
import Data.Char (ord)
|
||||||
import Data.Foldable (fold)
|
import Data.Foldable (fold)
|
||||||
import Data.Monoid ((<>))
|
import qualified Data.List.NonEmpty as NonEmpty
|
||||||
import qualified Data.List.NonEmpty as NonEmpty (toList)
|
import Data.Text (Text)
|
||||||
import Data.Text.Lazy (Text)
|
import qualified Data.Text as Text
|
||||||
import qualified Data.Text.Lazy as Text.Lazy
|
import qualified Data.Text.Lazy as Lazy (Text)
|
||||||
import Data.Text.Lazy.Builder (toLazyText)
|
import qualified Data.Text.Lazy as Lazy.Text
|
||||||
import Data.Text.Lazy.Builder.Int (decimal)
|
import Data.Text.Lazy.Builder (Builder)
|
||||||
|
import qualified Data.Text.Lazy.Builder as Builder
|
||||||
|
import Data.Text.Lazy.Builder.Int (decimal, hexadecimal)
|
||||||
import Data.Text.Lazy.Builder.RealFloat (realFloat)
|
import Data.Text.Lazy.Builder.RealFloat (realFloat)
|
||||||
import qualified Language.GraphQL.AST as Full
|
import Language.GraphQL.AST.Document
|
||||||
|
|
||||||
-- | Instructs the encoder whether the GraphQL document should be minified or
|
-- | Instructs the encoder whether the GraphQL document should be minified or
|
||||||
-- pretty printed.
|
-- pretty printed.
|
||||||
@ -39,235 +42,311 @@ pretty = Pretty 0
|
|||||||
minified :: Formatter
|
minified :: Formatter
|
||||||
minified = Minified
|
minified = Minified
|
||||||
|
|
||||||
-- | Converts a 'Full.Document' into a string.
|
-- | Converts a Document' into a string.
|
||||||
document :: Formatter -> Full.Document -> Text
|
document :: Formatter -> Document -> Lazy.Text
|
||||||
document formatter defs
|
document formatter defs
|
||||||
| Pretty _ <- formatter = Text.Lazy.intercalate "\n" encodeDocument
|
| Pretty _ <- formatter = Lazy.Text.intercalate "\n" encodeDocument
|
||||||
| Minified <-formatter = Text.Lazy.snoc (mconcat encodeDocument) '\n'
|
| Minified <-formatter = Lazy.Text.snoc (mconcat encodeDocument) '\n'
|
||||||
where
|
where
|
||||||
encodeDocument = NonEmpty.toList $ definition formatter <$> defs
|
encodeDocument = foldr executableDefinition [] defs
|
||||||
|
executableDefinition (ExecutableDefinition x) acc = definition formatter x : acc
|
||||||
|
executableDefinition _ acc = acc
|
||||||
|
|
||||||
-- | Converts a 'Full.Definition' into a string.
|
-- | Converts a t'ExecutableDefinition' into a string.
|
||||||
definition :: Formatter -> Full.Definition -> Text
|
definition :: Formatter -> ExecutableDefinition -> Lazy.Text
|
||||||
definition formatter x
|
definition formatter x
|
||||||
| Pretty _ <- formatter = Text.Lazy.snoc (encodeDefinition x) '\n'
|
| Pretty _ <- formatter = Lazy.Text.snoc (encodeDefinition x) '\n'
|
||||||
| Minified <- formatter = encodeDefinition x
|
| Minified <- formatter = encodeDefinition x
|
||||||
where
|
where
|
||||||
encodeDefinition (Full.DefinitionOperation operation)
|
encodeDefinition (DefinitionOperation operation)
|
||||||
= operationDefinition formatter operation
|
= operationDefinition formatter operation
|
||||||
encodeDefinition (Full.DefinitionFragment fragment)
|
encodeDefinition (DefinitionFragment fragment)
|
||||||
= fragmentDefinition formatter fragment
|
= fragmentDefinition formatter fragment
|
||||||
|
|
||||||
operationDefinition :: Formatter -> Full.OperationDefinition -> Text
|
-- | Converts a 'OperationDefinition into a string.
|
||||||
operationDefinition formatter (Full.OperationSelectionSet sels)
|
operationDefinition :: Formatter -> OperationDefinition -> Lazy.Text
|
||||||
|
operationDefinition formatter (SelectionSet sels)
|
||||||
= selectionSet formatter sels
|
= selectionSet formatter sels
|
||||||
operationDefinition formatter (Full.OperationDefinition Full.Query name vars dirs sels)
|
operationDefinition formatter (OperationDefinition Query name vars dirs sels)
|
||||||
= "query " <> node formatter name vars dirs sels
|
= "query " <> node formatter name vars dirs sels
|
||||||
operationDefinition formatter (Full.OperationDefinition Full.Mutation name vars dirs sels)
|
operationDefinition formatter (OperationDefinition Mutation name vars dirs sels)
|
||||||
= "mutation " <> node formatter name vars dirs sels
|
= "mutation " <> node formatter name vars dirs sels
|
||||||
|
|
||||||
node :: Formatter
|
-- | Converts a Query or Mutation into a string.
|
||||||
-> Maybe Full.Name
|
node :: Formatter ->
|
||||||
-> [Full.VariableDefinition]
|
Maybe Name ->
|
||||||
-> [Full.Directive]
|
[VariableDefinition] ->
|
||||||
-> Full.SelectionSet
|
[Directive] ->
|
||||||
-> Text
|
SelectionSet ->
|
||||||
|
Lazy.Text
|
||||||
node formatter name vars dirs sels
|
node formatter name vars dirs sels
|
||||||
= Text.Lazy.fromStrict (fold name)
|
= Lazy.Text.fromStrict (fold name)
|
||||||
<> optempty (variableDefinitions formatter) vars
|
<> optempty (variableDefinitions formatter) vars
|
||||||
<> optempty (directives formatter) dirs
|
<> optempty (directives formatter) dirs
|
||||||
<> eitherFormat formatter " " mempty
|
<> eitherFormat formatter " " mempty
|
||||||
<> selectionSet formatter sels
|
<> selectionSet formatter sels
|
||||||
|
|
||||||
variableDefinitions :: Formatter -> [Full.VariableDefinition] -> Text
|
variableDefinitions :: Formatter -> [VariableDefinition] -> Lazy.Text
|
||||||
variableDefinitions formatter
|
variableDefinitions formatter
|
||||||
= parensCommas formatter $ variableDefinition formatter
|
= parensCommas formatter $ variableDefinition formatter
|
||||||
|
|
||||||
variableDefinition :: Formatter -> Full.VariableDefinition -> Text
|
variableDefinition :: Formatter -> VariableDefinition -> Lazy.Text
|
||||||
variableDefinition formatter (Full.VariableDefinition var ty dv)
|
variableDefinition formatter (VariableDefinition var ty defaultValue')
|
||||||
= variable var
|
= variable var
|
||||||
<> eitherFormat formatter ": " ":"
|
<> eitherFormat formatter ": " ":"
|
||||||
<> type' ty
|
<> type' ty
|
||||||
<> maybe mempty (defaultValue formatter) dv
|
<> maybe mempty (defaultValue formatter) defaultValue'
|
||||||
|
|
||||||
defaultValue :: Formatter -> Full.Value -> Text
|
defaultValue :: Formatter -> ConstValue -> Lazy.Text
|
||||||
defaultValue formatter val
|
defaultValue formatter val
|
||||||
= eitherFormat formatter " = " "="
|
= eitherFormat formatter " = " "="
|
||||||
<> value formatter val
|
<> value formatter (fromConstValue val)
|
||||||
|
|
||||||
variable :: Full.Name -> Text
|
variable :: Name -> Lazy.Text
|
||||||
variable var = "$" <> Text.Lazy.fromStrict var
|
variable var = "$" <> Lazy.Text.fromStrict var
|
||||||
|
|
||||||
selectionSet :: Formatter -> Full.SelectionSet -> Text
|
selectionSet :: Formatter -> SelectionSet -> Lazy.Text
|
||||||
selectionSet formatter
|
selectionSet formatter
|
||||||
= bracesList formatter (selection formatter)
|
= bracesList formatter (selection formatter)
|
||||||
. NonEmpty.toList
|
. NonEmpty.toList
|
||||||
|
|
||||||
selectionSetOpt :: Formatter -> Full.SelectionSetOpt -> Text
|
selectionSetOpt :: Formatter -> SelectionSetOpt -> Lazy.Text
|
||||||
selectionSetOpt formatter = bracesList formatter $ selection formatter
|
selectionSetOpt formatter = bracesList formatter $ selection formatter
|
||||||
|
|
||||||
selection :: Formatter -> Full.Selection -> Text
|
indentSymbol :: Lazy.Text
|
||||||
selection formatter = Text.Lazy.append indent . f
|
indentSymbol = " "
|
||||||
where
|
|
||||||
f (Full.SelectionField x) = field incrementIndent x
|
|
||||||
f (Full.SelectionInlineFragment x) = inlineFragment incrementIndent x
|
|
||||||
f (Full.SelectionFragmentSpread x) = fragmentSpread incrementIndent x
|
|
||||||
incrementIndent
|
|
||||||
| Pretty n <- formatter = Pretty $ n + 1
|
|
||||||
| otherwise = Minified
|
|
||||||
indent
|
|
||||||
| Pretty n <- formatter = Text.Lazy.replicate (fromIntegral $ n + 1) " "
|
|
||||||
| otherwise = mempty
|
|
||||||
|
|
||||||
field :: Formatter -> Full.Field -> Text
|
indent :: (Integral a) => a -> Lazy.Text
|
||||||
field formatter (Full.Field alias name args dirs selso)
|
indent indentation = Lazy.Text.replicate (fromIntegral indentation) indentSymbol
|
||||||
= optempty (`Text.Lazy.append` colon) (Text.Lazy.fromStrict $ fold alias)
|
|
||||||
<> Text.Lazy.fromStrict name
|
selection :: Formatter -> Selection -> Lazy.Text
|
||||||
|
selection formatter = Lazy.Text.append indent' . encodeSelection
|
||||||
|
where
|
||||||
|
encodeSelection (Field alias name args directives' selections) =
|
||||||
|
field incrementIndent alias name args directives' selections
|
||||||
|
encodeSelection (InlineFragment typeCondition directives' selections) =
|
||||||
|
inlineFragment incrementIndent typeCondition directives' selections
|
||||||
|
encodeSelection (FragmentSpread name directives') =
|
||||||
|
fragmentSpread incrementIndent name directives'
|
||||||
|
incrementIndent
|
||||||
|
| Pretty indentation <- formatter = Pretty $ indentation + 1
|
||||||
|
| otherwise = Minified
|
||||||
|
indent'
|
||||||
|
| Pretty indentation <- formatter = indent $ indentation + 1
|
||||||
|
| otherwise = ""
|
||||||
|
|
||||||
|
colon :: Formatter -> Lazy.Text
|
||||||
|
colon formatter = eitherFormat formatter ": " ":"
|
||||||
|
|
||||||
|
-- | Converts Field into a string
|
||||||
|
field :: Formatter ->
|
||||||
|
Maybe Name ->
|
||||||
|
Name ->
|
||||||
|
[Argument] ->
|
||||||
|
[Directive] ->
|
||||||
|
[Selection] ->
|
||||||
|
Lazy.Text
|
||||||
|
field formatter alias name args dirs set
|
||||||
|
= optempty prependAlias (fold alias)
|
||||||
|
<> Lazy.Text.fromStrict name
|
||||||
<> optempty (arguments formatter) args
|
<> optempty (arguments formatter) args
|
||||||
<> optempty (directives formatter) dirs
|
<> optempty (directives formatter) dirs
|
||||||
<> selectionSetOpt'
|
<> optempty selectionSetOpt' set
|
||||||
where
|
where
|
||||||
colon = eitherFormat formatter ": " ":"
|
prependAlias aliasName = Lazy.Text.fromStrict aliasName <> colon formatter
|
||||||
selectionSetOpt'
|
selectionSetOpt' = (eitherFormat formatter " " "" <>)
|
||||||
| null selso = mempty
|
. selectionSetOpt formatter
|
||||||
| otherwise = eitherFormat formatter " " mempty <> selectionSetOpt formatter selso
|
|
||||||
|
|
||||||
arguments :: Formatter -> [Full.Argument] -> Text
|
arguments :: Formatter -> [Argument] -> Lazy.Text
|
||||||
arguments formatter = parensCommas formatter $ argument formatter
|
arguments formatter = parensCommas formatter $ argument formatter
|
||||||
|
|
||||||
argument :: Formatter -> Full.Argument -> Text
|
argument :: Formatter -> Argument -> Lazy.Text
|
||||||
argument formatter (Full.Argument name v)
|
argument formatter (Argument name value')
|
||||||
= Text.Lazy.fromStrict name
|
= Lazy.Text.fromStrict name
|
||||||
<> eitherFormat formatter ": " ":"
|
<> colon formatter
|
||||||
<> value formatter v
|
<> value formatter value'
|
||||||
|
|
||||||
-- * Fragments
|
-- * Fragments
|
||||||
|
|
||||||
fragmentSpread :: Formatter -> Full.FragmentSpread -> Text
|
fragmentSpread :: Formatter -> Name -> [Directive] -> Lazy.Text
|
||||||
fragmentSpread formatter (Full.FragmentSpread name ds)
|
fragmentSpread formatter name directives'
|
||||||
= "..." <> Text.Lazy.fromStrict name <> optempty (directives formatter) ds
|
= "..." <> Lazy.Text.fromStrict name
|
||||||
|
<> optempty (directives formatter) directives'
|
||||||
|
|
||||||
inlineFragment :: Formatter -> Full.InlineFragment -> Text
|
inlineFragment ::
|
||||||
inlineFragment formatter (Full.InlineFragment tc dirs sels)
|
Formatter ->
|
||||||
= "... on "
|
Maybe TypeCondition ->
|
||||||
<> Text.Lazy.fromStrict (fold tc)
|
[Directive] ->
|
||||||
|
SelectionSet ->
|
||||||
|
Lazy.Text
|
||||||
|
inlineFragment formatter tc dirs sels = "... on "
|
||||||
|
<> Lazy.Text.fromStrict (fold tc)
|
||||||
<> directives formatter dirs
|
<> directives formatter dirs
|
||||||
<> eitherFormat formatter " " mempty
|
<> eitherFormat formatter " " mempty
|
||||||
<> selectionSet formatter sels
|
<> selectionSet formatter sels
|
||||||
|
|
||||||
fragmentDefinition :: Formatter -> Full.FragmentDefinition -> Text
|
fragmentDefinition :: Formatter -> FragmentDefinition -> Lazy.Text
|
||||||
fragmentDefinition formatter (Full.FragmentDefinition name tc dirs sels)
|
fragmentDefinition formatter (FragmentDefinition name tc dirs sels)
|
||||||
= "fragment " <> Text.Lazy.fromStrict name
|
= "fragment " <> Lazy.Text.fromStrict name
|
||||||
<> " on " <> Text.Lazy.fromStrict tc
|
<> " on " <> Lazy.Text.fromStrict tc
|
||||||
<> optempty (directives formatter) dirs
|
<> optempty (directives formatter) dirs
|
||||||
<> eitherFormat formatter " " mempty
|
<> eitherFormat formatter " " mempty
|
||||||
<> selectionSet formatter sels
|
<> selectionSet formatter sels
|
||||||
|
|
||||||
-- * Miscellaneous
|
-- * Miscellaneous
|
||||||
|
|
||||||
-- | Converts a 'Full.Directive' into a string.
|
-- | Converts a 'Directive' into a string.
|
||||||
directive :: Formatter -> Full.Directive -> Text
|
directive :: Formatter -> Directive -> Lazy.Text
|
||||||
directive formatter (Full.Directive name args)
|
directive formatter (Directive name args)
|
||||||
= "@" <> Text.Lazy.fromStrict name <> optempty (arguments formatter) args
|
= "@" <> Lazy.Text.fromStrict name <> optempty (arguments formatter) args
|
||||||
|
|
||||||
directives :: Formatter -> [Full.Directive] -> Text
|
directives :: Formatter -> [Directive] -> Lazy.Text
|
||||||
directives formatter@(Pretty _) = Text.Lazy.cons ' ' . spaces (directive formatter)
|
|
||||||
directives Minified = spaces (directive Minified)
|
directives Minified = spaces (directive Minified)
|
||||||
|
directives formatter = Lazy.Text.cons ' ' . spaces (directive formatter)
|
||||||
|
|
||||||
-- | Converts a 'Full.Value' into a string.
|
-- | Converts a 'Value' into a string.
|
||||||
value :: Formatter -> Full.Value -> Text
|
value :: Formatter -> Value -> Lazy.Text
|
||||||
value _ (Full.Variable x) = variable x
|
value _ (Variable x) = variable x
|
||||||
value _ (Full.Int x) = toLazyText $ decimal x
|
value _ (Int x) = Builder.toLazyText $ decimal x
|
||||||
value _ (Full.Float x) = toLazyText $ realFloat x
|
value _ (Float x) = Builder.toLazyText $ realFloat x
|
||||||
value _ (Full.Boolean x) = booleanValue x
|
value _ (Boolean x) = booleanValue x
|
||||||
value _ Full.Null = mempty
|
value _ Null = "null"
|
||||||
value _ (Full.String x) = stringValue $ Text.Lazy.fromStrict x
|
value formatter (String string) = stringValue formatter string
|
||||||
value _ (Full.Enum x) = Text.Lazy.fromStrict x
|
value _ (Enum x) = Lazy.Text.fromStrict x
|
||||||
value formatter (Full.List x) = listValue formatter x
|
value formatter (List x) = listValue formatter x
|
||||||
value formatter (Full.Object x) = objectValue formatter x
|
value formatter (Object x) = objectValue formatter x
|
||||||
|
|
||||||
booleanValue :: Bool -> Text
|
fromConstValue :: ConstValue -> Value
|
||||||
|
fromConstValue (ConstInt x) = Int x
|
||||||
|
fromConstValue (ConstFloat x) = Float x
|
||||||
|
fromConstValue (ConstBoolean x) = Boolean x
|
||||||
|
fromConstValue ConstNull = Null
|
||||||
|
fromConstValue (ConstString string) = String string
|
||||||
|
fromConstValue (ConstEnum x) = Enum x
|
||||||
|
fromConstValue (ConstList x) = List $ fromConstValue <$> x
|
||||||
|
fromConstValue (ConstObject x) = Object $ fromConstObjectField <$> x
|
||||||
|
where
|
||||||
|
fromConstObjectField (ObjectField key value') =
|
||||||
|
ObjectField key $ fromConstValue value'
|
||||||
|
|
||||||
|
booleanValue :: Bool -> Lazy.Text
|
||||||
booleanValue True = "true"
|
booleanValue True = "true"
|
||||||
booleanValue False = "false"
|
booleanValue False = "false"
|
||||||
|
|
||||||
stringValue :: Text -> Text
|
quote :: Builder.Builder
|
||||||
stringValue
|
quote = Builder.singleton '\"'
|
||||||
= quotes
|
|
||||||
. Text.Lazy.replace "\"" "\\\""
|
|
||||||
. Text.Lazy.replace "\\" "\\\\"
|
|
||||||
|
|
||||||
listValue :: Formatter -> [Full.Value] -> Text
|
oneLine :: Text -> Builder
|
||||||
|
oneLine string = quote <> Text.foldr (mappend . escape) quote string
|
||||||
|
|
||||||
|
stringValue :: Formatter -> Text -> Lazy.Text
|
||||||
|
stringValue Minified string = Builder.toLazyText
|
||||||
|
$ quote <> Text.foldr (mappend . escape) quote string
|
||||||
|
stringValue (Pretty indentation) string =
|
||||||
|
if hasEscaped string
|
||||||
|
then stringValue Minified string
|
||||||
|
else Builder.toLazyText $ encoded lines'
|
||||||
|
where
|
||||||
|
isWhiteSpace char = char == ' ' || char == '\t'
|
||||||
|
isNewline char = char == '\n' || char == '\r'
|
||||||
|
hasEscaped = Text.any (not . isAllowed)
|
||||||
|
isAllowed char =
|
||||||
|
char == '\t' || isNewline char || (char >= '\x0020' && char /= '\x007F')
|
||||||
|
|
||||||
|
tripleQuote = Builder.fromText "\"\"\""
|
||||||
|
start = tripleQuote <> Builder.singleton '\n'
|
||||||
|
end = Builder.fromLazyText (indent indentation) <> tripleQuote
|
||||||
|
|
||||||
|
strip = Text.dropWhile isWhiteSpace . Text.dropWhileEnd isWhiteSpace
|
||||||
|
lines' = map Builder.fromText $ Text.split isNewline (Text.replace "\r\n" "\n" $ strip string)
|
||||||
|
encoded [] = oneLine string
|
||||||
|
encoded [_] = oneLine string
|
||||||
|
encoded lines'' = start <> transformLines lines'' <> end
|
||||||
|
transformLines = foldr ((\line acc -> line <> Builder.singleton '\n' <> acc) . transformLine) mempty
|
||||||
|
transformLine line =
|
||||||
|
if Lazy.Text.null (Builder.toLazyText line)
|
||||||
|
then line
|
||||||
|
else Builder.fromLazyText (indent (indentation + 1)) <> line
|
||||||
|
|
||||||
|
escape :: Char -> Builder
|
||||||
|
escape char'
|
||||||
|
| char' == '\\' = Builder.fromString "\\\\"
|
||||||
|
| char' == '\"' = Builder.fromString "\\\""
|
||||||
|
| char' == '\b' = Builder.fromString "\\b"
|
||||||
|
| char' == '\f' = Builder.fromString "\\f"
|
||||||
|
| char' == '\n' = Builder.fromString "\\n"
|
||||||
|
| char' == '\r' = Builder.fromString "\\r"
|
||||||
|
| char' == '\t' = Builder.fromString "\\t"
|
||||||
|
| char' < '\x0010' = unicode "\\u000" char'
|
||||||
|
| char' < '\x0020' = unicode "\\u00" char'
|
||||||
|
| otherwise = Builder.singleton char'
|
||||||
|
where
|
||||||
|
unicode prefix = mappend (Builder.fromString prefix) . (hexadecimal . ord)
|
||||||
|
|
||||||
|
listValue :: Formatter -> [Value] -> Lazy.Text
|
||||||
listValue formatter = bracketsCommas formatter $ value formatter
|
listValue formatter = bracketsCommas formatter $ value formatter
|
||||||
|
|
||||||
objectValue :: Formatter -> [Full.ObjectField] -> Text
|
objectValue :: Formatter -> [ObjectField Value] -> Lazy.Text
|
||||||
objectValue formatter = intercalate $ objectField formatter
|
objectValue formatter = intercalate $ objectField formatter
|
||||||
where
|
where
|
||||||
intercalate f
|
intercalate f
|
||||||
= braces
|
= braces
|
||||||
. Text.Lazy.intercalate (eitherFormat formatter ", " ",")
|
. Lazy.Text.intercalate (eitherFormat formatter ", " ",")
|
||||||
. fmap f
|
. fmap f
|
||||||
|
|
||||||
|
objectField :: Formatter -> ObjectField Value -> Lazy.Text
|
||||||
|
objectField formatter (ObjectField name value') =
|
||||||
|
Lazy.Text.fromStrict name <> colon formatter <> value formatter value'
|
||||||
|
|
||||||
objectField :: Formatter -> Full.ObjectField -> Text
|
-- | Converts a 'Type' a type into a string.
|
||||||
objectField formatter (Full.ObjectField name v)
|
type' :: Type -> Lazy.Text
|
||||||
= Text.Lazy.fromStrict name <> colon <> value formatter v
|
type' (TypeNamed x) = Lazy.Text.fromStrict x
|
||||||
where
|
type' (TypeList x) = listType x
|
||||||
colon
|
type' (TypeNonNull x) = nonNullType x
|
||||||
| Pretty _ <- formatter = ": "
|
|
||||||
| Minified <- formatter = ":"
|
|
||||||
|
|
||||||
-- | Converts a 'Full.Type' a type into a string.
|
listType :: Type -> Lazy.Text
|
||||||
type' :: Full.Type -> Text
|
|
||||||
type' (Full.TypeNamed x) = Text.Lazy.fromStrict x
|
|
||||||
type' (Full.TypeList x) = listType x
|
|
||||||
type' (Full.TypeNonNull x) = nonNullType x
|
|
||||||
|
|
||||||
listType :: Full.Type -> Text
|
|
||||||
listType x = brackets (type' x)
|
listType x = brackets (type' x)
|
||||||
|
|
||||||
nonNullType :: Full.NonNullType -> Text
|
nonNullType :: NonNullType -> Lazy.Text
|
||||||
nonNullType (Full.NonNullTypeNamed x) = Text.Lazy.fromStrict x <> "!"
|
nonNullType (NonNullTypeNamed x) = Lazy.Text.fromStrict x <> "!"
|
||||||
nonNullType (Full.NonNullTypeList x) = listType x <> "!"
|
nonNullType (NonNullTypeList x) = listType x <> "!"
|
||||||
|
|
||||||
-- * Internal
|
-- * Internal
|
||||||
|
|
||||||
between :: Char -> Char -> Text -> Text
|
between :: Char -> Char -> Lazy.Text -> Lazy.Text
|
||||||
between open close = Text.Lazy.cons open . (`Text.Lazy.snoc` close)
|
between open close = Lazy.Text.cons open . (`Lazy.Text.snoc` close)
|
||||||
|
|
||||||
parens :: Text -> Text
|
parens :: Lazy.Text -> Lazy.Text
|
||||||
parens = between '(' ')'
|
parens = between '(' ')'
|
||||||
|
|
||||||
brackets :: Text -> Text
|
brackets :: Lazy.Text -> Lazy.Text
|
||||||
brackets = between '[' ']'
|
brackets = between '[' ']'
|
||||||
|
|
||||||
braces :: Text -> Text
|
braces :: Lazy.Text -> Lazy.Text
|
||||||
braces = between '{' '}'
|
braces = between '{' '}'
|
||||||
|
|
||||||
quotes :: Text -> Text
|
spaces :: forall a. (a -> Lazy.Text) -> [a] -> Lazy.Text
|
||||||
quotes = between '"' '"'
|
spaces f = Lazy.Text.intercalate "\SP" . fmap f
|
||||||
|
|
||||||
spaces :: forall a. (a -> Text) -> [a] -> Text
|
parensCommas :: forall a. Formatter -> (a -> Lazy.Text) -> [a] -> Lazy.Text
|
||||||
spaces f = Text.Lazy.intercalate "\SP" . fmap f
|
|
||||||
|
|
||||||
parensCommas :: forall a. Formatter -> (a -> Text) -> [a] -> Text
|
|
||||||
parensCommas formatter f
|
parensCommas formatter f
|
||||||
= parens
|
= parens
|
||||||
. Text.Lazy.intercalate (eitherFormat formatter ", " ",")
|
. Lazy.Text.intercalate (eitherFormat formatter ", " ",")
|
||||||
. fmap f
|
. fmap f
|
||||||
|
|
||||||
bracketsCommas :: Formatter -> (a -> Text) -> [a] -> Text
|
bracketsCommas :: Formatter -> (a -> Lazy.Text) -> [a] -> Lazy.Text
|
||||||
bracketsCommas formatter f
|
bracketsCommas formatter f
|
||||||
= brackets
|
= brackets
|
||||||
. Text.Lazy.intercalate (eitherFormat formatter ", " ",")
|
. Lazy.Text.intercalate (eitherFormat formatter ", " ",")
|
||||||
. fmap f
|
. fmap f
|
||||||
|
|
||||||
bracesList :: forall a. Formatter -> (a -> Text) -> [a] -> Text
|
bracesList :: forall a. Formatter -> (a -> Lazy.Text) -> [a] -> Lazy.Text
|
||||||
bracesList (Pretty intendation) f xs
|
bracesList (Pretty intendation) f xs
|
||||||
= Text.Lazy.snoc (Text.Lazy.intercalate "\n" content) '\n'
|
= Lazy.Text.snoc (Lazy.Text.intercalate "\n" content) '\n'
|
||||||
<> (Text.Lazy.snoc $ Text.Lazy.replicate (fromIntegral intendation) " ") '}'
|
<> (Lazy.Text.snoc $ Lazy.Text.replicate (fromIntegral intendation) " ") '}'
|
||||||
where
|
where
|
||||||
content = "{" : fmap f xs
|
content = "{" : fmap f xs
|
||||||
bracesList Minified f xs = braces $ Text.Lazy.intercalate "," $ fmap f xs
|
bracesList Minified f xs = braces $ Lazy.Text.intercalate "," $ fmap f xs
|
||||||
|
|
||||||
optempty :: (Eq a, Monoid a, Monoid b) => (a -> b) -> a -> b
|
optempty :: (Eq a, Monoid a, Monoid b) => (a -> b) -> a -> b
|
||||||
optempty f xs = if xs == mempty then mempty else f xs
|
optempty f xs = if xs == mempty then mempty else f xs
|
||||||
|
@ -15,6 +15,7 @@ module Language.GraphQL.AST.Lexer
|
|||||||
, dollar
|
, dollar
|
||||||
, comment
|
, comment
|
||||||
, equals
|
, equals
|
||||||
|
, extend
|
||||||
, integer
|
, integer
|
||||||
, float
|
, float
|
||||||
, lexeme
|
, lexeme
|
||||||
@ -28,20 +29,16 @@ module Language.GraphQL.AST.Lexer
|
|||||||
, unicodeBOM
|
, unicodeBOM
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Applicative ( Alternative(..)
|
import Control.Applicative (Alternative(..), liftA2)
|
||||||
, liftA2
|
import Data.Char (chr, digitToInt, isAsciiLower, isAsciiUpper, ord)
|
||||||
)
|
|
||||||
import Data.Char ( chr
|
|
||||||
, digitToInt
|
|
||||||
, isAsciiLower
|
|
||||||
, isAsciiUpper
|
|
||||||
, ord
|
|
||||||
)
|
|
||||||
import Data.Foldable (foldl')
|
import Data.Foldable (foldl')
|
||||||
import Data.List (dropWhileEnd)
|
import Data.List (dropWhileEnd)
|
||||||
|
import qualified Data.List.NonEmpty as NonEmpty
|
||||||
|
import Data.List.NonEmpty (NonEmpty(..))
|
||||||
import Data.Proxy (Proxy(..))
|
import Data.Proxy (Proxy(..))
|
||||||
import Data.Void (Void)
|
import Data.Void (Void)
|
||||||
import Text.Megaparsec ( Parsec
|
import Text.Megaparsec ( Parsec
|
||||||
|
, (<?>)
|
||||||
, between
|
, between
|
||||||
, chunk
|
, chunk
|
||||||
, chunkToTokens
|
, chunkToTokens
|
||||||
@ -56,11 +53,9 @@ import Text.Megaparsec ( Parsec
|
|||||||
, takeWhile1P
|
, takeWhile1P
|
||||||
, try
|
, try
|
||||||
)
|
)
|
||||||
import Text.Megaparsec.Char ( char
|
import Text.Megaparsec.Char (char, digitChar, space1)
|
||||||
, digitChar
|
|
||||||
, space1
|
|
||||||
)
|
|
||||||
import qualified Text.Megaparsec.Char.Lexer as Lexer
|
import qualified Text.Megaparsec.Char.Lexer as Lexer
|
||||||
|
import Data.Text (Text)
|
||||||
import qualified Data.Text as T
|
import qualified Data.Text as T
|
||||||
import qualified Data.Text.Lazy as TL
|
import qualified Data.Text.Lazy as TL
|
||||||
|
|
||||||
@ -97,8 +92,8 @@ dollar :: Parser T.Text
|
|||||||
dollar = symbol "$"
|
dollar = symbol "$"
|
||||||
|
|
||||||
-- | Parser for "@".
|
-- | Parser for "@".
|
||||||
at :: Parser Char
|
at :: Parser Text
|
||||||
at = char '@'
|
at = symbol "@"
|
||||||
|
|
||||||
-- | Parser for "&".
|
-- | Parser for "&".
|
||||||
amp :: Parser T.Text
|
amp :: Parser T.Text
|
||||||
@ -134,7 +129,7 @@ braces = between (symbol "{") (symbol "}")
|
|||||||
|
|
||||||
-- | Parser for strings.
|
-- | Parser for strings.
|
||||||
string :: Parser T.Text
|
string :: Parser T.Text
|
||||||
string = between "\"" "\"" stringValue
|
string = between "\"" "\"" stringValue <* spaceConsumer
|
||||||
where
|
where
|
||||||
stringValue = T.pack <$> many stringCharacter
|
stringValue = T.pack <$> many stringCharacter
|
||||||
stringCharacter = satisfy isStringCharacter1
|
stringCharacter = satisfy isStringCharacter1
|
||||||
@ -143,7 +138,7 @@ string = between "\"" "\"" stringValue
|
|||||||
|
|
||||||
-- | Parser for block strings.
|
-- | Parser for block strings.
|
||||||
blockString :: Parser T.Text
|
blockString :: Parser T.Text
|
||||||
blockString = between "\"\"\"" "\"\"\"" stringValue
|
blockString = between "\"\"\"" "\"\"\"" stringValue <* spaceConsumer
|
||||||
where
|
where
|
||||||
stringValue = do
|
stringValue = do
|
||||||
byLine <- sepBy (many blockStringCharacter) lineTerminator
|
byLine <- sepBy (many blockStringCharacter) lineTerminator
|
||||||
@ -226,3 +221,16 @@ escapeSequence = do
|
|||||||
-- | Parser for the "Byte Order Mark".
|
-- | Parser for the "Byte Order Mark".
|
||||||
unicodeBOM :: Parser ()
|
unicodeBOM :: Parser ()
|
||||||
unicodeBOM = optional (char '\xfeff') >> pure ()
|
unicodeBOM = optional (char '\xfeff') >> pure ()
|
||||||
|
|
||||||
|
-- | Parses "extend" followed by a 'symbol'. It is used by schema extensions.
|
||||||
|
extend :: forall a. Text -> String -> NonEmpty (Parser a) -> Parser a
|
||||||
|
extend token extensionLabel parsers
|
||||||
|
= foldr combine headParser (NonEmpty.tail parsers)
|
||||||
|
<?> extensionLabel
|
||||||
|
where
|
||||||
|
headParser = tryExtension $ NonEmpty.head parsers
|
||||||
|
combine current accumulated = accumulated <|> tryExtension current
|
||||||
|
tryExtension extensionParser = try
|
||||||
|
$ symbol "extend"
|
||||||
|
*> symbol token
|
||||||
|
*> extensionParser
|
@ -6,63 +6,358 @@ module Language.GraphQL.AST.Parser
|
|||||||
( document
|
( document
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Applicative ( Alternative(..)
|
import Control.Applicative (Alternative(..), optional)
|
||||||
, optional
|
import Control.Applicative.Combinators (sepBy1)
|
||||||
)
|
import qualified Control.Applicative.Combinators.NonEmpty as NonEmpty
|
||||||
import Data.List.NonEmpty (NonEmpty(..))
|
import Data.List.NonEmpty (NonEmpty(..))
|
||||||
import Language.GraphQL.AST
|
import Data.Text (Text)
|
||||||
|
import qualified Language.GraphQL.AST.DirectiveLocation as Directive
|
||||||
|
import Language.GraphQL.AST.DirectiveLocation
|
||||||
|
( DirectiveLocation
|
||||||
|
, ExecutableDirectiveLocation
|
||||||
|
, TypeSystemDirectiveLocation
|
||||||
|
)
|
||||||
|
import Language.GraphQL.AST.Document
|
||||||
import Language.GraphQL.AST.Lexer
|
import Language.GraphQL.AST.Lexer
|
||||||
import Text.Megaparsec ( lookAhead
|
import Text.Megaparsec (lookAhead, option, try, (<?>))
|
||||||
, option
|
|
||||||
, try
|
|
||||||
, (<?>)
|
|
||||||
)
|
|
||||||
|
|
||||||
-- | Parser for the GraphQL documents.
|
-- | Parser for the GraphQL documents.
|
||||||
document :: Parser Document
|
document :: Parser Document
|
||||||
document = unicodeBOM >> spaceConsumer >> lexeme (manyNE definition)
|
document = unicodeBOM
|
||||||
|
>> spaceConsumer
|
||||||
|
>> lexeme (NonEmpty.some definition)
|
||||||
|
|
||||||
definition :: Parser Definition
|
definition :: Parser Definition
|
||||||
definition = DefinitionOperation <$> operationDefinition
|
definition = ExecutableDefinition <$> executableDefinition
|
||||||
<|> DefinitionFragment <$> fragmentDefinition
|
<|> TypeSystemDefinition <$> typeSystemDefinition
|
||||||
<?> "definition error!"
|
<|> TypeSystemExtension <$> typeSystemExtension
|
||||||
|
<?> "Definition"
|
||||||
|
|
||||||
|
executableDefinition :: Parser ExecutableDefinition
|
||||||
|
executableDefinition = DefinitionOperation <$> operationDefinition
|
||||||
|
<|> DefinitionFragment <$> fragmentDefinition
|
||||||
|
<?> "ExecutableDefinition"
|
||||||
|
|
||||||
|
typeSystemDefinition :: Parser TypeSystemDefinition
|
||||||
|
typeSystemDefinition = schemaDefinition
|
||||||
|
<|> TypeDefinition <$> typeDefinition
|
||||||
|
<|> directiveDefinition
|
||||||
|
<?> "TypeSystemDefinition"
|
||||||
|
|
||||||
|
typeSystemExtension :: Parser TypeSystemExtension
|
||||||
|
typeSystemExtension = SchemaExtension <$> schemaExtension
|
||||||
|
<|> TypeExtension <$> typeExtension
|
||||||
|
<?> "TypeSystemExtension"
|
||||||
|
|
||||||
|
directiveDefinition :: Parser TypeSystemDefinition
|
||||||
|
directiveDefinition = DirectiveDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "directive"
|
||||||
|
<* at
|
||||||
|
<*> name
|
||||||
|
<*> argumentsDefinition
|
||||||
|
<* symbol "on"
|
||||||
|
<*> directiveLocations
|
||||||
|
<?> "DirectiveDefinition"
|
||||||
|
|
||||||
|
directiveLocations :: Parser (NonEmpty DirectiveLocation)
|
||||||
|
directiveLocations = optional pipe
|
||||||
|
*> directiveLocation `NonEmpty.sepBy1` pipe
|
||||||
|
|
||||||
|
directiveLocation :: Parser DirectiveLocation
|
||||||
|
directiveLocation
|
||||||
|
= Directive.ExecutableDirectiveLocation <$> executableDirectiveLocation
|
||||||
|
<|> Directive.TypeSystemDirectiveLocation <$> typeSystemDirectiveLocation
|
||||||
|
|
||||||
|
executableDirectiveLocation :: Parser ExecutableDirectiveLocation
|
||||||
|
executableDirectiveLocation = Directive.Query <$ symbol "QUERY"
|
||||||
|
<|> Directive.Mutation <$ symbol "MUTATION"
|
||||||
|
<|> Directive.Subscription <$ symbol "SUBSCRIPTION"
|
||||||
|
<|> Directive.Field <$ symbol "FIELD"
|
||||||
|
<|> Directive.FragmentDefinition <$ "FRAGMENT_DEFINITION"
|
||||||
|
<|> Directive.FragmentSpread <$ "FRAGMENT_SPREAD"
|
||||||
|
<|> Directive.InlineFragment <$ "INLINE_FRAGMENT"
|
||||||
|
|
||||||
|
typeSystemDirectiveLocation :: Parser TypeSystemDirectiveLocation
|
||||||
|
typeSystemDirectiveLocation = Directive.Schema <$ symbol "SCHEMA"
|
||||||
|
<|> Directive.Scalar <$ symbol "SCALAR"
|
||||||
|
<|> Directive.Object <$ symbol "OBJECT"
|
||||||
|
<|> Directive.FieldDefinition <$ symbol "FIELD_DEFINITION"
|
||||||
|
<|> Directive.ArgumentDefinition <$ symbol "ARGUMENT_DEFINITION"
|
||||||
|
<|> Directive.Interface <$ symbol "INTERFACE"
|
||||||
|
<|> Directive.Union <$ symbol "UNION"
|
||||||
|
<|> Directive.Enum <$ symbol "ENUM"
|
||||||
|
<|> Directive.EnumValue <$ symbol "ENUM_VALUE"
|
||||||
|
<|> Directive.InputObject <$ symbol "INPUT_OBJECT"
|
||||||
|
<|> Directive.InputFieldDefinition <$ symbol "INPUT_FIELD_DEFINITION"
|
||||||
|
|
||||||
|
typeDefinition :: Parser TypeDefinition
|
||||||
|
typeDefinition = scalarTypeDefinition
|
||||||
|
<|> objectTypeDefinition
|
||||||
|
<|> interfaceTypeDefinition
|
||||||
|
<|> unionTypeDefinition
|
||||||
|
<|> enumTypeDefinition
|
||||||
|
<|> inputObjectTypeDefinition
|
||||||
|
<?> "TypeDefinition"
|
||||||
|
|
||||||
|
typeExtension :: Parser TypeExtension
|
||||||
|
typeExtension = scalarTypeExtension
|
||||||
|
<|> objectTypeExtension
|
||||||
|
<|> interfaceTypeExtension
|
||||||
|
<|> unionTypeExtension
|
||||||
|
<|> enumTypeExtension
|
||||||
|
<|> inputObjectTypeExtension
|
||||||
|
<?> "TypeExtension"
|
||||||
|
|
||||||
|
scalarTypeDefinition :: Parser TypeDefinition
|
||||||
|
scalarTypeDefinition = ScalarTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "scalar"
|
||||||
|
<*> name
|
||||||
|
<*> directives
|
||||||
|
<?> "ScalarTypeDefinition"
|
||||||
|
|
||||||
|
scalarTypeExtension :: Parser TypeExtension
|
||||||
|
scalarTypeExtension = extend "scalar" "ScalarTypeExtension"
|
||||||
|
$ (ScalarTypeExtension <$> name <*> NonEmpty.some directive) :| []
|
||||||
|
|
||||||
|
objectTypeDefinition :: Parser TypeDefinition
|
||||||
|
objectTypeDefinition = ObjectTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "type"
|
||||||
|
<*> name
|
||||||
|
<*> option (ImplementsInterfaces []) (implementsInterfaces sepBy1)
|
||||||
|
<*> directives
|
||||||
|
<*> braces (many fieldDefinition)
|
||||||
|
<?> "ObjectTypeDefinition"
|
||||||
|
|
||||||
|
objectTypeExtension :: Parser TypeExtension
|
||||||
|
objectTypeExtension = extend "type" "ObjectTypeExtension"
|
||||||
|
$ fieldsDefinitionExtension :|
|
||||||
|
[ directivesExtension
|
||||||
|
, implementsInterfacesExtension
|
||||||
|
]
|
||||||
|
where
|
||||||
|
fieldsDefinitionExtension = ObjectTypeFieldsDefinitionExtension
|
||||||
|
<$> name
|
||||||
|
<*> option (ImplementsInterfaces []) (implementsInterfaces sepBy1)
|
||||||
|
<*> directives
|
||||||
|
<*> braces (NonEmpty.some fieldDefinition)
|
||||||
|
directivesExtension = ObjectTypeDirectivesExtension
|
||||||
|
<$> name
|
||||||
|
<*> option (ImplementsInterfaces []) (implementsInterfaces sepBy1)
|
||||||
|
<*> NonEmpty.some directive
|
||||||
|
implementsInterfacesExtension = ObjectTypeImplementsInterfacesExtension
|
||||||
|
<$> name
|
||||||
|
<*> implementsInterfaces NonEmpty.sepBy1
|
||||||
|
|
||||||
|
description :: Parser Description
|
||||||
|
description = Description
|
||||||
|
<$> optional (string <|> blockString)
|
||||||
|
<?> "Description"
|
||||||
|
|
||||||
|
unionTypeDefinition :: Parser TypeDefinition
|
||||||
|
unionTypeDefinition = UnionTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "union"
|
||||||
|
<*> name
|
||||||
|
<*> directives
|
||||||
|
<*> option (UnionMemberTypes []) (unionMemberTypes sepBy1)
|
||||||
|
<?> "UnionTypeDefinition"
|
||||||
|
|
||||||
|
unionTypeExtension :: Parser TypeExtension
|
||||||
|
unionTypeExtension = extend "union" "UnionTypeExtension"
|
||||||
|
$ unionMemberTypesExtension :| [directivesExtension]
|
||||||
|
where
|
||||||
|
unionMemberTypesExtension = UnionTypeUnionMemberTypesExtension
|
||||||
|
<$> name
|
||||||
|
<*> directives
|
||||||
|
<*> unionMemberTypes NonEmpty.sepBy1
|
||||||
|
directivesExtension = UnionTypeDirectivesExtension
|
||||||
|
<$> name
|
||||||
|
<*> NonEmpty.some directive
|
||||||
|
|
||||||
|
unionMemberTypes ::
|
||||||
|
Foldable t =>
|
||||||
|
(Parser Text -> Parser Text -> Parser (t NamedType)) ->
|
||||||
|
Parser (UnionMemberTypes t)
|
||||||
|
unionMemberTypes sepBy' = UnionMemberTypes
|
||||||
|
<$ equals
|
||||||
|
<* optional pipe
|
||||||
|
<*> name `sepBy'` pipe
|
||||||
|
<?> "UnionMemberTypes"
|
||||||
|
|
||||||
|
interfaceTypeDefinition :: Parser TypeDefinition
|
||||||
|
interfaceTypeDefinition = InterfaceTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "interface"
|
||||||
|
<*> name
|
||||||
|
<*> directives
|
||||||
|
<*> braces (many fieldDefinition)
|
||||||
|
<?> "InterfaceTypeDefinition"
|
||||||
|
|
||||||
|
interfaceTypeExtension :: Parser TypeExtension
|
||||||
|
interfaceTypeExtension = extend "interface" "InterfaceTypeExtension"
|
||||||
|
$ fieldsDefinitionExtension :| [directivesExtension]
|
||||||
|
where
|
||||||
|
fieldsDefinitionExtension = InterfaceTypeFieldsDefinitionExtension
|
||||||
|
<$> name
|
||||||
|
<*> directives
|
||||||
|
<*> braces (NonEmpty.some fieldDefinition)
|
||||||
|
directivesExtension = InterfaceTypeDirectivesExtension
|
||||||
|
<$> name
|
||||||
|
<*> NonEmpty.some directive
|
||||||
|
|
||||||
|
enumTypeDefinition :: Parser TypeDefinition
|
||||||
|
enumTypeDefinition = EnumTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "enum"
|
||||||
|
<*> name
|
||||||
|
<*> directives
|
||||||
|
<*> listOptIn braces enumValueDefinition
|
||||||
|
<?> "EnumTypeDefinition"
|
||||||
|
|
||||||
|
enumTypeExtension :: Parser TypeExtension
|
||||||
|
enumTypeExtension = extend "enum" "EnumTypeExtension"
|
||||||
|
$ enumValuesDefinitionExtension :| [directivesExtension]
|
||||||
|
where
|
||||||
|
enumValuesDefinitionExtension = EnumTypeEnumValuesDefinitionExtension
|
||||||
|
<$> name
|
||||||
|
<*> directives
|
||||||
|
<*> braces (NonEmpty.some enumValueDefinition)
|
||||||
|
directivesExtension = EnumTypeDirectivesExtension
|
||||||
|
<$> name
|
||||||
|
<*> NonEmpty.some directive
|
||||||
|
|
||||||
|
inputObjectTypeDefinition :: Parser TypeDefinition
|
||||||
|
inputObjectTypeDefinition = InputObjectTypeDefinition
|
||||||
|
<$> description
|
||||||
|
<* symbol "input"
|
||||||
|
<*> name
|
||||||
|
<*> directives
|
||||||
|
<*> listOptIn braces inputValueDefinition
|
||||||
|
<?> "InputObjectTypeDefinition"
|
||||||
|
|
||||||
|
inputObjectTypeExtension :: Parser TypeExtension
|
||||||
|
inputObjectTypeExtension = extend "input" "InputObjectTypeExtension"
|
||||||
|
$ inputFieldsDefinitionExtension :| [directivesExtension]
|
||||||
|
where
|
||||||
|
inputFieldsDefinitionExtension = InputObjectTypeInputFieldsDefinitionExtension
|
||||||
|
<$> name
|
||||||
|
<*> directives
|
||||||
|
<*> braces (NonEmpty.some inputValueDefinition)
|
||||||
|
directivesExtension = InputObjectTypeDirectivesExtension
|
||||||
|
<$> name
|
||||||
|
<*> NonEmpty.some directive
|
||||||
|
|
||||||
|
enumValueDefinition :: Parser EnumValueDefinition
|
||||||
|
enumValueDefinition = EnumValueDefinition
|
||||||
|
<$> description
|
||||||
|
<*> enumValue
|
||||||
|
<*> directives
|
||||||
|
<?> "EnumValueDefinition"
|
||||||
|
|
||||||
|
implementsInterfaces ::
|
||||||
|
Foldable t =>
|
||||||
|
(Parser Text -> Parser Text -> Parser (t NamedType)) ->
|
||||||
|
Parser (ImplementsInterfaces t)
|
||||||
|
implementsInterfaces sepBy' = ImplementsInterfaces
|
||||||
|
<$ symbol "implements"
|
||||||
|
<* optional amp
|
||||||
|
<*> name `sepBy'` amp
|
||||||
|
<?> "ImplementsInterfaces"
|
||||||
|
|
||||||
|
inputValueDefinition :: Parser InputValueDefinition
|
||||||
|
inputValueDefinition = InputValueDefinition
|
||||||
|
<$> description
|
||||||
|
<*> name
|
||||||
|
<* colon
|
||||||
|
<*> type'
|
||||||
|
<*> defaultValue
|
||||||
|
<*> directives
|
||||||
|
<?> "InputValueDefinition"
|
||||||
|
|
||||||
|
argumentsDefinition :: Parser ArgumentsDefinition
|
||||||
|
argumentsDefinition = ArgumentsDefinition
|
||||||
|
<$> listOptIn parens inputValueDefinition
|
||||||
|
<?> "ArgumentsDefinition"
|
||||||
|
|
||||||
|
fieldDefinition :: Parser FieldDefinition
|
||||||
|
fieldDefinition = FieldDefinition
|
||||||
|
<$> description
|
||||||
|
<*> name
|
||||||
|
<*> argumentsDefinition
|
||||||
|
<* colon
|
||||||
|
<*> type'
|
||||||
|
<*> directives
|
||||||
|
<?> "FieldDefinition"
|
||||||
|
|
||||||
|
schemaDefinition :: Parser TypeSystemDefinition
|
||||||
|
schemaDefinition = SchemaDefinition
|
||||||
|
<$ symbol "schema"
|
||||||
|
<*> directives
|
||||||
|
<*> operationTypeDefinitions
|
||||||
|
<?> "SchemaDefinition"
|
||||||
|
|
||||||
|
operationTypeDefinitions :: Parser (NonEmpty OperationTypeDefinition)
|
||||||
|
operationTypeDefinitions = braces $ NonEmpty.some operationTypeDefinition
|
||||||
|
|
||||||
|
schemaExtension :: Parser SchemaExtension
|
||||||
|
schemaExtension = extend "schema" "SchemaExtension"
|
||||||
|
$ schemaOperationExtension :| [directivesExtension]
|
||||||
|
where
|
||||||
|
directivesExtension = SchemaDirectivesExtension
|
||||||
|
<$> NonEmpty.some directive
|
||||||
|
schemaOperationExtension = SchemaOperationExtension
|
||||||
|
<$> directives
|
||||||
|
<*> operationTypeDefinitions
|
||||||
|
|
||||||
|
operationTypeDefinition :: Parser OperationTypeDefinition
|
||||||
|
operationTypeDefinition = OperationTypeDefinition
|
||||||
|
<$> operationType <* colon
|
||||||
|
<*> name
|
||||||
|
<?> "OperationTypeDefinition"
|
||||||
|
|
||||||
operationDefinition :: Parser OperationDefinition
|
operationDefinition :: Parser OperationDefinition
|
||||||
operationDefinition = OperationSelectionSet <$> selectionSet
|
operationDefinition = SelectionSet <$> selectionSet
|
||||||
<|> OperationDefinition <$> operationType
|
<|> operationDefinition'
|
||||||
<*> optional name
|
<?> "operationDefinition error"
|
||||||
<*> opt variableDefinitions
|
where
|
||||||
<*> opt directives
|
operationDefinition'
|
||||||
<*> selectionSet
|
= OperationDefinition <$> operationType
|
||||||
<?> "operationDefinition error"
|
<*> optional name
|
||||||
|
<*> variableDefinitions
|
||||||
|
<*> directives
|
||||||
|
<*> selectionSet
|
||||||
|
|
||||||
operationType :: Parser OperationType
|
operationType :: Parser OperationType
|
||||||
operationType = Query <$ symbol "query"
|
operationType = Query <$ symbol "query"
|
||||||
<|> Mutation <$ symbol "mutation"
|
<|> Mutation <$ symbol "mutation"
|
||||||
<?> "operationType error"
|
-- <?> Keep default error message
|
||||||
|
|
||||||
-- * SelectionSet
|
-- * SelectionSet
|
||||||
|
|
||||||
selectionSet :: Parser SelectionSet
|
selectionSet :: Parser SelectionSet
|
||||||
selectionSet = braces $ manyNE selection
|
selectionSet = braces $ NonEmpty.some selection
|
||||||
|
|
||||||
selectionSetOpt :: Parser SelectionSetOpt
|
selectionSetOpt :: Parser SelectionSetOpt
|
||||||
selectionSetOpt = braces $ some selection
|
selectionSetOpt = listOptIn braces selection
|
||||||
|
|
||||||
selection :: Parser Selection
|
selection :: Parser Selection
|
||||||
selection = SelectionField <$> field
|
selection = field
|
||||||
<|> try (SelectionFragmentSpread <$> fragmentSpread)
|
<|> try fragmentSpread
|
||||||
<|> SelectionInlineFragment <$> inlineFragment
|
<|> inlineFragment
|
||||||
<?> "selection error!"
|
<?> "selection error!"
|
||||||
|
|
||||||
-- * Field
|
-- * Field
|
||||||
|
|
||||||
field :: Parser Field
|
field :: Parser Selection
|
||||||
field = Field <$> optional alias
|
field = Field
|
||||||
<*> name
|
<$> optional alias
|
||||||
<*> opt arguments
|
<*> name
|
||||||
<*> opt directives
|
<*> arguments
|
||||||
<*> opt selectionSetOpt
|
<*> directives
|
||||||
|
<*> selectionSetOpt
|
||||||
|
|
||||||
alias :: Parser Alias
|
alias :: Parser Alias
|
||||||
alias = try $ name <* colon
|
alias = try $ name <* colon
|
||||||
@ -70,30 +365,32 @@ alias = try $ name <* colon
|
|||||||
-- * Arguments
|
-- * Arguments
|
||||||
|
|
||||||
arguments :: Parser [Argument]
|
arguments :: Parser [Argument]
|
||||||
arguments = parens $ some argument
|
arguments = listOptIn parens argument
|
||||||
|
|
||||||
argument :: Parser Argument
|
argument :: Parser Argument
|
||||||
argument = Argument <$> name <* colon <*> value
|
argument = Argument <$> name <* colon <*> value
|
||||||
|
|
||||||
-- * Fragments
|
-- * Fragments
|
||||||
|
|
||||||
fragmentSpread :: Parser FragmentSpread
|
fragmentSpread :: Parser Selection
|
||||||
fragmentSpread = FragmentSpread <$ spread
|
fragmentSpread = FragmentSpread
|
||||||
<*> fragmentName
|
<$ spread
|
||||||
<*> opt directives
|
<*> fragmentName
|
||||||
|
<*> directives
|
||||||
|
|
||||||
inlineFragment :: Parser InlineFragment
|
inlineFragment :: Parser Selection
|
||||||
inlineFragment = InlineFragment <$ spread
|
inlineFragment = InlineFragment
|
||||||
<*> optional typeCondition
|
<$ spread
|
||||||
<*> opt directives
|
<*> optional typeCondition
|
||||||
<*> selectionSet
|
<*> directives
|
||||||
|
<*> selectionSet
|
||||||
|
|
||||||
fragmentDefinition :: Parser FragmentDefinition
|
fragmentDefinition :: Parser FragmentDefinition
|
||||||
fragmentDefinition = FragmentDefinition
|
fragmentDefinition = FragmentDefinition
|
||||||
<$ symbol "fragment"
|
<$ symbol "fragment"
|
||||||
<*> name
|
<*> name
|
||||||
<*> typeCondition
|
<*> typeCondition
|
||||||
<*> opt directives
|
<*> directives
|
||||||
<*> selectionSet
|
<*> selectionSet
|
||||||
|
|
||||||
fragmentName :: Parser Name
|
fragmentName :: Parser Name
|
||||||
@ -106,83 +403,89 @@ typeCondition = symbol "on" *> name
|
|||||||
|
|
||||||
value :: Parser Value
|
value :: Parser Value
|
||||||
value = Variable <$> variable
|
value = Variable <$> variable
|
||||||
<|> Float <$> try float
|
<|> Float <$> try float
|
||||||
<|> Int <$> integer
|
<|> Int <$> integer
|
||||||
<|> Boolean <$> booleanValue
|
<|> Boolean <$> booleanValue
|
||||||
<|> Null <$ symbol "null"
|
<|> Null <$ symbol "null"
|
||||||
<|> String <$> blockString
|
<|> String <$> blockString
|
||||||
<|> String <$> string
|
<|> String <$> string
|
||||||
<|> Enum <$> try enumValue
|
<|> Enum <$> try enumValue
|
||||||
<|> List <$> listValue
|
<|> List <$> brackets (some value)
|
||||||
<|> Object <$> objectValue
|
<|> Object <$> braces (some $ objectField value)
|
||||||
<?> "value error!"
|
<?> "value error!"
|
||||||
where
|
|
||||||
booleanValue :: Parser Bool
|
|
||||||
booleanValue = True <$ symbol "true"
|
|
||||||
<|> False <$ symbol "false"
|
|
||||||
|
|
||||||
enumValue :: Parser Name
|
constValue :: Parser ConstValue
|
||||||
enumValue = but (symbol "true") *> but (symbol "false") *> but (symbol "null") *> name
|
constValue = ConstFloat <$> try float
|
||||||
|
<|> ConstInt <$> integer
|
||||||
|
<|> ConstBoolean <$> booleanValue
|
||||||
|
<|> ConstNull <$ symbol "null"
|
||||||
|
<|> ConstString <$> blockString
|
||||||
|
<|> ConstString <$> string
|
||||||
|
<|> ConstEnum <$> try enumValue
|
||||||
|
<|> ConstList <$> brackets (some constValue)
|
||||||
|
<|> ConstObject <$> braces (some $ objectField constValue)
|
||||||
|
<?> "value error!"
|
||||||
|
|
||||||
listValue :: Parser [Value]
|
booleanValue :: Parser Bool
|
||||||
listValue = brackets $ some value
|
booleanValue = True <$ symbol "true"
|
||||||
|
<|> False <$ symbol "false"
|
||||||
|
|
||||||
objectValue :: Parser [ObjectField]
|
enumValue :: Parser Name
|
||||||
objectValue = braces $ some objectField
|
enumValue = but (symbol "true") *> but (symbol "false") *> but (symbol "null") *> name
|
||||||
|
|
||||||
objectField :: Parser ObjectField
|
objectField :: Parser a -> Parser (ObjectField a)
|
||||||
objectField = ObjectField <$> name <* symbol ":" <*> value
|
objectField valueParser = ObjectField <$> name <* colon <*> valueParser
|
||||||
|
|
||||||
-- * Variables
|
-- * Variables
|
||||||
|
|
||||||
variableDefinitions :: Parser [VariableDefinition]
|
variableDefinitions :: Parser [VariableDefinition]
|
||||||
variableDefinitions = parens $ some variableDefinition
|
variableDefinitions = listOptIn parens variableDefinition
|
||||||
|
|
||||||
variableDefinition :: Parser VariableDefinition
|
variableDefinition :: Parser VariableDefinition
|
||||||
variableDefinition = VariableDefinition <$> variable
|
variableDefinition = VariableDefinition
|
||||||
<* colon
|
<$> variable
|
||||||
<*> type_
|
<* colon
|
||||||
<*> optional defaultValue
|
<*> type'
|
||||||
|
<*> defaultValue
|
||||||
|
<?> "VariableDefinition"
|
||||||
|
|
||||||
variable :: Parser Name
|
variable :: Parser Name
|
||||||
variable = dollar *> name
|
variable = dollar *> name
|
||||||
|
|
||||||
defaultValue :: Parser Value
|
defaultValue :: Parser (Maybe ConstValue)
|
||||||
defaultValue = equals *> value
|
defaultValue = optional (equals *> constValue) <?> "DefaultValue"
|
||||||
|
|
||||||
-- * Input Types
|
-- * Input Types
|
||||||
|
|
||||||
type_ :: Parser Type
|
type' :: Parser Type
|
||||||
type_ = try (TypeNonNull <$> nonNullType)
|
type' = try (TypeNonNull <$> nonNullType)
|
||||||
<|> TypeList <$> brackets type_
|
<|> TypeList <$> brackets type'
|
||||||
<|> TypeNamed <$> name
|
<|> TypeNamed <$> name
|
||||||
<?> "type_ error!"
|
<?> "Type"
|
||||||
|
|
||||||
nonNullType :: Parser NonNullType
|
nonNullType :: Parser NonNullType
|
||||||
nonNullType = NonNullTypeNamed <$> name <* bang
|
nonNullType = NonNullTypeNamed <$> name <* bang
|
||||||
<|> NonNullTypeList <$> brackets type_ <* bang
|
<|> NonNullTypeList <$> brackets type' <* bang
|
||||||
<?> "nonNullType error!"
|
<?> "nonNullType error!"
|
||||||
|
|
||||||
-- * Directives
|
-- * Directives
|
||||||
|
|
||||||
directives :: Parser [Directive]
|
directives :: Parser [Directive]
|
||||||
directives = some directive
|
directives = many directive
|
||||||
|
|
||||||
directive :: Parser Directive
|
directive :: Parser Directive
|
||||||
directive = Directive
|
directive = Directive
|
||||||
<$ at
|
<$ at
|
||||||
<*> name
|
<*> name
|
||||||
<*> opt arguments
|
<*> arguments
|
||||||
|
|
||||||
-- * Internal
|
-- * Internal
|
||||||
|
|
||||||
opt :: Monoid a => Parser a -> Parser a
|
listOptIn :: (Parser [a] -> Parser [a]) -> Parser a -> Parser [a]
|
||||||
opt = option mempty
|
listOptIn surround = option [] . surround . some
|
||||||
|
|
||||||
-- Hack to reverse parser success
|
-- Hack to reverse parser success
|
||||||
but :: Parser a -> Parser ()
|
but :: Parser a -> Parser ()
|
||||||
but pn = False <$ lookAhead pn <|> pure True >>= \case
|
but pn = False <$ lookAhead pn <|> pure True >>= \case
|
||||||
False -> empty
|
False -> empty
|
||||||
True -> pure ()
|
True -> pure ()
|
||||||
|
|
||||||
manyNE :: Alternative f => f a -> f (NonEmpty a)
|
|
||||||
manyNE p = (:|) <$> p <*> many p
|
|
||||||
|
@ -1,150 +0,0 @@
|
|||||||
{-# LANGUAGE TupleSections #-}
|
|
||||||
{-# LANGUAGE ExplicitForAll #-}
|
|
||||||
|
|
||||||
-- | After the document is parsed, before getting executed the AST is
|
|
||||||
-- transformed into a similar, simpler AST. This module is responsible for
|
|
||||||
-- this transformation.
|
|
||||||
module Language.GraphQL.AST.Transform
|
|
||||||
( document
|
|
||||||
) where
|
|
||||||
|
|
||||||
import Control.Arrow (first)
|
|
||||||
import Control.Monad (foldM, unless)
|
|
||||||
import Control.Monad.Trans.Class (lift)
|
|
||||||
import Control.Monad.Trans.Reader (ReaderT, ask, runReaderT)
|
|
||||||
import Control.Monad.Trans.State (StateT, evalStateT, gets, modify)
|
|
||||||
import Data.HashMap.Strict (HashMap)
|
|
||||||
import qualified Data.HashMap.Strict as HashMap
|
|
||||||
import qualified Data.List.NonEmpty as NonEmpty
|
|
||||||
import Data.Sequence (Seq, (<|), (><))
|
|
||||||
import qualified Language.GraphQL.AST as Full
|
|
||||||
import qualified Language.GraphQL.AST.Core as Core
|
|
||||||
import qualified Language.GraphQL.Schema as Schema
|
|
||||||
|
|
||||||
-- | Associates a fragment name with a list of 'Core.Field's.
|
|
||||||
data Replacement = Replacement
|
|
||||||
{ fragments :: HashMap Core.Name (Seq Core.Selection)
|
|
||||||
, fragmentDefinitions :: HashMap Full.Name Full.FragmentDefinition
|
|
||||||
}
|
|
||||||
|
|
||||||
type TransformT a = StateT Replacement (ReaderT Schema.Subs Maybe) a
|
|
||||||
|
|
||||||
-- | Rewrites the original syntax tree into an intermediate representation used
|
|
||||||
-- for query execution.
|
|
||||||
document :: Schema.Subs -> Full.Document -> Maybe Core.Document
|
|
||||||
document subs document' =
|
|
||||||
flip runReaderT subs
|
|
||||||
$ evalStateT (collectFragments >> operations operationDefinitions)
|
|
||||||
$ Replacement HashMap.empty fragmentTable
|
|
||||||
where
|
|
||||||
(fragmentTable, operationDefinitions) = foldr defragment mempty document'
|
|
||||||
defragment (Full.DefinitionOperation definition) acc =
|
|
||||||
(definition :) <$> acc
|
|
||||||
defragment (Full.DefinitionFragment definition) acc =
|
|
||||||
let (Full.FragmentDefinition name _ _ _) = definition
|
|
||||||
in first (HashMap.insert name definition) acc
|
|
||||||
|
|
||||||
-- * Operation
|
|
||||||
|
|
||||||
-- TODO: Replace Maybe by MonadThrow CustomError
|
|
||||||
operations :: [Full.OperationDefinition] -> TransformT Core.Document
|
|
||||||
operations operations' = do
|
|
||||||
coreOperations <- traverse operation operations'
|
|
||||||
lift . lift $ NonEmpty.nonEmpty coreOperations
|
|
||||||
|
|
||||||
operation :: Full.OperationDefinition -> TransformT Core.Operation
|
|
||||||
operation (Full.OperationSelectionSet sels) =
|
|
||||||
operation $ Full.OperationDefinition Full.Query mempty mempty mempty sels
|
|
||||||
-- TODO: Validate Variable definitions with substituter
|
|
||||||
operation (Full.OperationDefinition Full.Query name _vars _dirs sels) =
|
|
||||||
Core.Query name <$> appendSelection sels
|
|
||||||
operation (Full.OperationDefinition Full.Mutation name _vars _dirs sels) =
|
|
||||||
Core.Mutation name <$> appendSelection sels
|
|
||||||
|
|
||||||
selection ::
|
|
||||||
Full.Selection ->
|
|
||||||
TransformT (Either (Seq Core.Selection) Core.Selection)
|
|
||||||
selection (Full.SelectionField fld) = Right . Core.SelectionField <$> field fld
|
|
||||||
selection (Full.SelectionFragmentSpread (Full.FragmentSpread name _)) = do
|
|
||||||
fragments' <- gets fragments
|
|
||||||
Left <$> maybe lookupDefinition liftJust (HashMap.lookup name fragments')
|
|
||||||
where
|
|
||||||
lookupDefinition :: TransformT (Seq Core.Selection)
|
|
||||||
lookupDefinition = do
|
|
||||||
fragmentDefinitions' <- gets fragmentDefinitions
|
|
||||||
found <- lift . lift $ HashMap.lookup name fragmentDefinitions'
|
|
||||||
fragmentDefinition found
|
|
||||||
selection (Full.SelectionInlineFragment fragment)
|
|
||||||
| (Full.InlineFragment (Just typeCondition) _ selectionSet) <- fragment
|
|
||||||
= Right
|
|
||||||
. Core.SelectionFragment
|
|
||||||
. Core.Fragment typeCondition
|
|
||||||
<$> appendSelection selectionSet
|
|
||||||
| (Full.InlineFragment Nothing _ selectionSet) <- fragment
|
|
||||||
= Left <$> appendSelection selectionSet
|
|
||||||
|
|
||||||
-- * Fragment replacement
|
|
||||||
|
|
||||||
-- | Extract fragment definitions into a single 'HashMap'.
|
|
||||||
collectFragments :: TransformT ()
|
|
||||||
collectFragments = do
|
|
||||||
fragDefs <- gets fragmentDefinitions
|
|
||||||
let nextValue = head $ HashMap.elems fragDefs
|
|
||||||
unless (HashMap.null fragDefs) $ do
|
|
||||||
_ <- fragmentDefinition nextValue
|
|
||||||
collectFragments
|
|
||||||
|
|
||||||
fragmentDefinition ::
|
|
||||||
Full.FragmentDefinition ->
|
|
||||||
TransformT (Seq Core.Selection)
|
|
||||||
fragmentDefinition (Full.FragmentDefinition name _tc _dirs selections) = do
|
|
||||||
modify deleteFragmentDefinition
|
|
||||||
newValue <- appendSelection selections
|
|
||||||
modify $ insertFragment newValue
|
|
||||||
liftJust newValue
|
|
||||||
where
|
|
||||||
deleteFragmentDefinition (Replacement fragments' fragmentDefinitions') =
|
|
||||||
Replacement fragments' $ HashMap.delete name fragmentDefinitions'
|
|
||||||
insertFragment newValue (Replacement fragments' fragmentDefinitions') =
|
|
||||||
let newFragments = HashMap.insert name newValue fragments'
|
|
||||||
in Replacement newFragments fragmentDefinitions'
|
|
||||||
|
|
||||||
field :: Full.Field -> TransformT Core.Field
|
|
||||||
field (Full.Field a n args _dirs sels) = do
|
|
||||||
arguments <- traverse argument args
|
|
||||||
selection' <- appendSelection sels
|
|
||||||
return $ Core.Field a n arguments selection'
|
|
||||||
|
|
||||||
argument :: Full.Argument -> TransformT Core.Argument
|
|
||||||
argument (Full.Argument n v) = Core.Argument n <$> value v
|
|
||||||
|
|
||||||
value :: Full.Value -> TransformT Core.Value
|
|
||||||
value (Full.Variable n) = do
|
|
||||||
substitute' <- lift ask
|
|
||||||
lift . lift $ substitute' n
|
|
||||||
value (Full.Int i) = pure $ Core.Int i
|
|
||||||
value (Full.Float f) = pure $ Core.Float f
|
|
||||||
value (Full.String x) = pure $ Core.String x
|
|
||||||
value (Full.Boolean b) = pure $ Core.Boolean b
|
|
||||||
value Full.Null = pure Core.Null
|
|
||||||
value (Full.Enum e) = pure $ Core.Enum e
|
|
||||||
value (Full.List l) =
|
|
||||||
Core.List <$> traverse value l
|
|
||||||
value (Full.Object o) =
|
|
||||||
Core.Object . HashMap.fromList <$> traverse objectField o
|
|
||||||
|
|
||||||
objectField :: Full.ObjectField -> TransformT (Core.Name, Core.Value)
|
|
||||||
objectField (Full.ObjectField n v) = (n,) <$> value v
|
|
||||||
|
|
||||||
appendSelection ::
|
|
||||||
Traversable t =>
|
|
||||||
t Full.Selection ->
|
|
||||||
TransformT (Seq Core.Selection)
|
|
||||||
appendSelection = foldM go mempty
|
|
||||||
where
|
|
||||||
go acc sel = append acc <$> selection sel
|
|
||||||
append acc (Left list) = list >< acc
|
|
||||||
append acc (Right one) = one <| acc
|
|
||||||
|
|
||||||
liftJust :: forall a. a -> TransformT a
|
|
||||||
liftJust = lift . lift . Just
|
|
@ -5,33 +5,40 @@
|
|||||||
module Language.GraphQL.Error
|
module Language.GraphQL.Error
|
||||||
( parseError
|
( parseError
|
||||||
, CollectErrsT
|
, CollectErrsT
|
||||||
|
, Resolution(..)
|
||||||
, addErr
|
, addErr
|
||||||
, addErrMsg
|
, addErrMsg
|
||||||
, runCollectErrs
|
, runCollectErrs
|
||||||
, runAppendErrs
|
|
||||||
, singleError
|
, singleError
|
||||||
) where
|
) where
|
||||||
|
|
||||||
|
import Control.Monad.Trans.State (StateT, modify, runStateT)
|
||||||
import qualified Data.Aeson as Aeson
|
import qualified Data.Aeson as Aeson
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import Data.Void (Void)
|
import Data.Void (Void)
|
||||||
import Control.Monad.Trans.Class (lift)
|
import Language.GraphQL.AST.Document (Name)
|
||||||
import Control.Monad.Trans.State ( StateT
|
import Language.GraphQL.Type.Schema
|
||||||
, modify
|
import Text.Megaparsec
|
||||||
, runStateT
|
( ParseErrorBundle(..)
|
||||||
)
|
, PosState(..)
|
||||||
import Text.Megaparsec ( ParseErrorBundle(..)
|
, SourcePos(..)
|
||||||
, SourcePos(..)
|
, errorOffset
|
||||||
, errorOffset
|
, parseErrorTextPretty
|
||||||
, parseErrorTextPretty
|
, reachOffset
|
||||||
, reachOffset
|
, unPos
|
||||||
, unPos
|
)
|
||||||
)
|
|
||||||
|
-- | Executor context.
|
||||||
|
data Resolution m = Resolution
|
||||||
|
{ errors :: [Aeson.Value]
|
||||||
|
, types :: HashMap Name (Type m)
|
||||||
|
}
|
||||||
|
|
||||||
-- | Wraps a parse error into a list of errors.
|
-- | Wraps a parse error into a list of errors.
|
||||||
parseError :: Applicative f => ParseErrorBundle Text Void -> f Aeson.Value
|
parseError :: Applicative f => ParseErrorBundle Text Void -> f Aeson.Value
|
||||||
parseError ParseErrorBundle{..} =
|
parseError ParseErrorBundle{..} =
|
||||||
pure $ Aeson.object [("errors", Aeson.toJSON $ fst $ foldl go ([], bundlePosState) bundleErrors)]
|
pure $ Aeson.object [("errors", Aeson.toJSON $ fst $ foldl go ([], bundlePosState) bundleErrors)]
|
||||||
where
|
where
|
||||||
errorObject s SourcePos{..} = Aeson.object
|
errorObject s SourcePos{..} = Aeson.object
|
||||||
[ ("message", Aeson.toJSON $ init $ parseErrorTextPretty s)
|
[ ("message", Aeson.toJSON $ init $ parseErrorTextPretty s)
|
||||||
@ -39,15 +46,18 @@ parseError ParseErrorBundle{..} =
|
|||||||
, ("column", Aeson.toJSON $ unPos sourceColumn)
|
, ("column", Aeson.toJSON $ unPos sourceColumn)
|
||||||
]
|
]
|
||||||
go (result, state) x =
|
go (result, state) x =
|
||||||
let (sourcePosition, _, newState) = reachOffset (errorOffset x) state
|
let (_, newState) = reachOffset (errorOffset x) state
|
||||||
|
sourcePosition = pstateSourcePos newState
|
||||||
in (errorObject x sourcePosition : result, newState)
|
in (errorObject x sourcePosition : result, newState)
|
||||||
|
|
||||||
-- | A wrapper to pass error messages around.
|
-- | A wrapper to pass error messages around.
|
||||||
type CollectErrsT m = StateT [Aeson.Value] m
|
type CollectErrsT m = StateT (Resolution m) m
|
||||||
|
|
||||||
-- | Adds an error to the list of errors.
|
-- | Adds an error to the list of errors.
|
||||||
addErr :: Monad m => Aeson.Value -> CollectErrsT m ()
|
addErr :: Monad m => Aeson.Value -> CollectErrsT m ()
|
||||||
addErr v = modify (v :)
|
addErr v = modify appender
|
||||||
|
where
|
||||||
|
appender resolution@Resolution{..} = resolution{ errors = v : errors }
|
||||||
|
|
||||||
makeErrorMessage :: Text -> Aeson.Value
|
makeErrorMessage :: Text -> Aeson.Value
|
||||||
makeErrorMessage s = Aeson.object [("message", Aeson.toJSON s)]
|
makeErrorMessage s = Aeson.object [("message", Aeson.toJSON s)]
|
||||||
@ -63,23 +73,17 @@ singleError message = Aeson.object
|
|||||||
addErrMsg :: Monad m => Text -> CollectErrsT m ()
|
addErrMsg :: Monad m => Text -> CollectErrsT m ()
|
||||||
addErrMsg = addErr . makeErrorMessage
|
addErrMsg = addErr . makeErrorMessage
|
||||||
|
|
||||||
-- | Appends the given list of errors to the current list of errors.
|
|
||||||
appendErrs :: Monad m => [Aeson.Value] -> CollectErrsT m ()
|
|
||||||
appendErrs errs = modify (errs ++)
|
|
||||||
|
|
||||||
-- | Runs the given query computation, but collects the errors into an error
|
-- | Runs the given query computation, but collects the errors into an error
|
||||||
-- list, which is then sent back with the data.
|
-- list, which is then sent back with the data.
|
||||||
runCollectErrs :: Monad m => CollectErrsT m Aeson.Value -> m Aeson.Value
|
runCollectErrs :: Monad m
|
||||||
runCollectErrs res = do
|
=> HashMap Name (Type m)
|
||||||
(dat, errs) <- runStateT res []
|
-> CollectErrsT m Aeson.Value
|
||||||
if null errs
|
-> m Aeson.Value
|
||||||
|
runCollectErrs types' res = do
|
||||||
|
(dat, Resolution{..}) <- runStateT res $ Resolution{ errors = [], types = types' }
|
||||||
|
if null errors
|
||||||
then return $ Aeson.object [("data", dat)]
|
then return $ Aeson.object [("data", dat)]
|
||||||
else return $ Aeson.object [("data", dat), ("errors", Aeson.toJSON $ reverse errs)]
|
else return $ Aeson.object
|
||||||
|
[ ("data", dat)
|
||||||
-- | Runs the given computation, collecting the errors and appending them
|
, ("errors", Aeson.toJSON $ reverse errors)
|
||||||
-- to the previous list of errors.
|
]
|
||||||
runAppendErrs :: Monad m => CollectErrsT m a -> CollectErrsT m a
|
|
||||||
runAppendErrs f = do
|
|
||||||
(v, errs) <- lift $ runStateT f []
|
|
||||||
appendErrs errs
|
|
||||||
return v
|
|
||||||
|
@ -1,38 +1,34 @@
|
|||||||
{-# LANGUAGE OverloadedStrings #-}
|
|
||||||
|
|
||||||
-- | This module provides functions to execute a @GraphQL@ request.
|
-- | This module provides functions to execute a @GraphQL@ request.
|
||||||
module Language.GraphQL.Execute
|
module Language.GraphQL.Execute
|
||||||
( execute
|
( execute
|
||||||
, executeWithName
|
, executeWithName
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Monad.IO.Class (MonadIO)
|
|
||||||
import qualified Data.Aeson as Aeson
|
import qualified Data.Aeson as Aeson
|
||||||
import Data.Foldable (toList)
|
import Data.HashMap.Strict (HashMap)
|
||||||
import Data.List.NonEmpty (NonEmpty(..))
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
import qualified Data.List.NonEmpty as NE
|
import Data.Sequence (Seq(..))
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import qualified Data.Text as Text
|
import Language.GraphQL.AST.Document (Document, Name)
|
||||||
import qualified Language.GraphQL.AST as AST
|
import Language.GraphQL.Execute.Coerce
|
||||||
import qualified Language.GraphQL.AST.Core as AST.Core
|
import Language.GraphQL.Execute.Execution
|
||||||
import qualified Language.GraphQL.AST.Transform as Transform
|
import qualified Language.GraphQL.Execute.Transform as Transform
|
||||||
import Language.GraphQL.Error
|
import Language.GraphQL.Error
|
||||||
import qualified Language.GraphQL.Schema as Schema
|
import qualified Language.GraphQL.Type.Definition as Definition
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
import Language.GraphQL.Type.Schema
|
||||||
|
|
||||||
-- | The substitution is applied to the document, and the resolvers are applied
|
-- | The substitution is applied to the document, and the resolvers are applied
|
||||||
-- to the resulting fields.
|
-- to the resulting fields.
|
||||||
--
|
--
|
||||||
-- Returns the result of the query against the schema wrapped in a /data/
|
-- Returns the result of the query against the schema wrapped in a /data/
|
||||||
-- field, or errors wrapped in an /errors/ field.
|
-- field, or errors wrapped in an /errors/ field.
|
||||||
execute :: MonadIO m
|
execute :: (Monad m, VariableValue a)
|
||||||
=> NonEmpty (Schema.Resolver m) -- ^ Resolvers.
|
=> Schema m -- ^ Resolvers.
|
||||||
-> Schema.Subs -- ^ Variable substitution function.
|
-> HashMap.HashMap Name a -- ^ Variable substitution function.
|
||||||
-> AST.Document -- @GraphQL@ document.
|
-> Document -- @GraphQL@ document.
|
||||||
-> m Aeson.Value
|
-> m Aeson.Value
|
||||||
execute schema subs doc =
|
execute schema = executeRequest schema Nothing
|
||||||
maybe transformError (document schema Nothing) $ Transform.document subs doc
|
|
||||||
where
|
|
||||||
transformError = return $ singleError "Schema transformation error."
|
|
||||||
|
|
||||||
-- | The substitution is applied to the document, and the resolvers are applied
|
-- | The substitution is applied to the document, and the resolvers are applied
|
||||||
-- to the resulting fields. The operation name can be used if the document
|
-- to the resulting fields. The operation name can be used if the document
|
||||||
@ -40,38 +36,36 @@ execute schema subs doc =
|
|||||||
--
|
--
|
||||||
-- Returns the result of the query against the schema wrapped in a /data/
|
-- Returns the result of the query against the schema wrapped in a /data/
|
||||||
-- field, or errors wrapped in an /errors/ field.
|
-- field, or errors wrapped in an /errors/ field.
|
||||||
executeWithName :: MonadIO m
|
executeWithName :: (Monad m, VariableValue a)
|
||||||
=> NonEmpty (Schema.Resolver m) -- ^ Resolvers
|
=> Schema m -- ^ Resolvers
|
||||||
-> Text -- ^ Operation name.
|
-> Text -- ^ Operation name.
|
||||||
-> Schema.Subs -- ^ Variable substitution function.
|
-> HashMap.HashMap Name a -- ^ Variable substitution function.
|
||||||
-> AST.Document -- ^ @GraphQL@ Document.
|
-> Document -- ^ @GraphQL@ Document.
|
||||||
-> m Aeson.Value
|
-> m Aeson.Value
|
||||||
executeWithName schema name subs doc =
|
executeWithName schema operationName =
|
||||||
maybe transformError (document schema $ Just name) $ Transform.document subs doc
|
executeRequest schema (Just operationName)
|
||||||
where
|
|
||||||
transformError = return $ singleError "Schema transformation error."
|
|
||||||
|
|
||||||
document :: MonadIO m
|
executeRequest :: (Monad m, VariableValue a)
|
||||||
=> NonEmpty (Schema.Resolver m)
|
=> Schema m
|
||||||
-> Maybe Text
|
-> Maybe Text
|
||||||
-> AST.Core.Document
|
-> HashMap.HashMap Name a
|
||||||
|
-> Document
|
||||||
-> m Aeson.Value
|
-> m Aeson.Value
|
||||||
document schema Nothing (op :| []) = operation schema op
|
executeRequest schema operationName subs document =
|
||||||
document schema (Just name) operations = case NE.dropWhile matchingName operations of
|
case Transform.document schema operationName subs document of
|
||||||
[] -> return $ singleError
|
Left queryError -> pure $ singleError $ Transform.queryError queryError
|
||||||
$ Text.unwords ["Operation", name, "couldn't be found in the document."]
|
Right (Transform.Document types' rootObjectType operation)
|
||||||
(op:_) -> operation schema op
|
| (Transform.Query _ fields) <- operation ->
|
||||||
where
|
executeOperation types' rootObjectType fields
|
||||||
matchingName (AST.Core.Query (Just name') _) = name == name'
|
| (Transform.Mutation _ fields) <- operation ->
|
||||||
matchingName (AST.Core.Mutation (Just name') _) = name == name'
|
executeOperation types' rootObjectType fields
|
||||||
matchingName _ = False
|
|
||||||
document _ _ _ = return $ singleError "Missing operation name."
|
|
||||||
|
|
||||||
operation :: MonadIO m
|
-- This is actually executeMutation, but we don't distinguish between queries
|
||||||
=> NonEmpty (Schema.Resolver m)
|
-- and mutations yet.
|
||||||
-> AST.Core.Operation
|
executeOperation :: Monad m
|
||||||
|
=> HashMap Name (Type m)
|
||||||
|
-> Out.ObjectType m
|
||||||
|
-> Seq (Transform.Selection m)
|
||||||
-> m Aeson.Value
|
-> m Aeson.Value
|
||||||
operation schema (AST.Core.Query _ flds)
|
executeOperation types' objectType fields =
|
||||||
= runCollectErrs (Schema.resolve (toList schema) flds)
|
runCollectErrs types' $ executeSelectionSet Definition.Null objectType fields
|
||||||
operation schema (AST.Core.Mutation _ flds)
|
|
||||||
= runCollectErrs (Schema.resolve (toList schema) flds)
|
|
||||||
|
230
src/Language/GraphQL/Execute/Coerce.hs
Normal file
230
src/Language/GraphQL/Execute/Coerce.hs
Normal file
@ -0,0 +1,230 @@
|
|||||||
|
{-# LANGUAGE ExplicitForAll #-}
|
||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE ViewPatterns #-}
|
||||||
|
|
||||||
|
-- | Types and functions used for input and result coercion.
|
||||||
|
module Language.GraphQL.Execute.Coerce
|
||||||
|
( Output(..)
|
||||||
|
, Serialize(..)
|
||||||
|
, VariableValue(..)
|
||||||
|
, coerceInputLiteral
|
||||||
|
, matchFieldValues
|
||||||
|
) where
|
||||||
|
|
||||||
|
import qualified Data.Aeson as Aeson
|
||||||
|
import Data.Int (Int32)
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Data.Map.Strict (Map)
|
||||||
|
import Data.String (IsString(..))
|
||||||
|
import Data.Text (Text)
|
||||||
|
import qualified Data.Text.Lazy as Text.Lazy
|
||||||
|
import qualified Data.Text.Lazy.Builder as Text.Builder
|
||||||
|
import qualified Data.Text.Lazy.Builder.Int as Text.Builder
|
||||||
|
import Data.Scientific (toBoundedInteger, toRealFloat)
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import qualified Language.GraphQL.Type as Type
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
|
||||||
|
-- | Since variables are passed separately from the query, in an independent
|
||||||
|
-- format, they should be first coerced to the internal representation used by
|
||||||
|
-- this implementation.
|
||||||
|
class VariableValue a where
|
||||||
|
-- | Only a basic, format-specific, coercion must be done here. Type
|
||||||
|
-- correctness or nullability shouldn't be validated here, they will be
|
||||||
|
-- validated later. The type information is provided only as a hint.
|
||||||
|
--
|
||||||
|
-- For example @GraphQL@ prohibits the coercion from a 't:Float' to an
|
||||||
|
-- 't:Int', but @JSON@ doesn't have integers, so whole numbers should be
|
||||||
|
-- coerced to 't:Int` when receiving variables as a JSON object. The same
|
||||||
|
-- holds for 't:Enum'. There are formats that support enumerations, @JSON@
|
||||||
|
-- doesn't, so the type information is given and 'coerceVariableValue' can
|
||||||
|
-- check that an 't:Enum' is expected and treat the given value
|
||||||
|
-- appropriately. Even checking whether this value is a proper member of the
|
||||||
|
-- corresponding 't:Enum' type isn't required here, since this can be
|
||||||
|
-- checked independently.
|
||||||
|
--
|
||||||
|
-- Another example is an @ID@. @GraphQL@ explicitly allows to coerce
|
||||||
|
-- integers and strings to @ID@s, so if an @ID@ is received as an integer,
|
||||||
|
-- it can be left as is and will be coerced later.
|
||||||
|
--
|
||||||
|
-- If a value cannot be coerced without losing information, 'Nothing' should
|
||||||
|
-- be returned, the coercion will fail then and the query won't be executed.
|
||||||
|
coerceVariableValue
|
||||||
|
:: In.Type -- ^ Expected type (variable type given in the query).
|
||||||
|
-> a -- ^ Variable value being coerced.
|
||||||
|
-> Maybe Type.Value -- ^ Coerced value on success, 'Nothing' otherwise.
|
||||||
|
|
||||||
|
instance VariableValue Aeson.Value where
|
||||||
|
coerceVariableValue _ Aeson.Null = Just Type.Null
|
||||||
|
coerceVariableValue (In.ScalarBaseType scalarType) value
|
||||||
|
| (Aeson.String stringValue) <- value = Just $ Type.String stringValue
|
||||||
|
| (Aeson.Bool booleanValue) <- value = Just $ Type.Boolean booleanValue
|
||||||
|
| (Aeson.Number numberValue) <- value
|
||||||
|
, (Type.ScalarType "Float" _) <- scalarType =
|
||||||
|
Just $ Type.Float $ toRealFloat numberValue
|
||||||
|
| (Aeson.Number numberValue) <- value = -- ID or Int
|
||||||
|
Type.Int <$> toBoundedInteger numberValue
|
||||||
|
coerceVariableValue (In.EnumBaseType _) (Aeson.String stringValue) =
|
||||||
|
Just $ Type.Enum stringValue
|
||||||
|
coerceVariableValue (In.InputObjectBaseType objectType) value
|
||||||
|
| (Aeson.Object objectValue) <- value = do
|
||||||
|
let (In.InputObjectType _ _ inputFields) = objectType
|
||||||
|
(newObjectValue, resultMap) <- foldWithKey objectValue inputFields
|
||||||
|
if HashMap.null newObjectValue
|
||||||
|
then Just $ Type.Object resultMap
|
||||||
|
else Nothing
|
||||||
|
where
|
||||||
|
foldWithKey objectValue = HashMap.foldrWithKey matchFieldValues'
|
||||||
|
$ Just (objectValue, HashMap.empty)
|
||||||
|
matchFieldValues' _ _ Nothing = Nothing
|
||||||
|
matchFieldValues' fieldName inputField (Just (objectValue, resultMap)) =
|
||||||
|
let (In.InputField _ fieldType _) = inputField
|
||||||
|
insert = flip (HashMap.insert fieldName) resultMap
|
||||||
|
newObjectValue = HashMap.delete fieldName objectValue
|
||||||
|
in case HashMap.lookup fieldName objectValue of
|
||||||
|
Just variableValue -> do
|
||||||
|
coerced <- coerceVariableValue fieldType variableValue
|
||||||
|
pure (newObjectValue, insert coerced)
|
||||||
|
Nothing -> Just (objectValue, resultMap)
|
||||||
|
coerceVariableValue (In.ListBaseType listType) value
|
||||||
|
| (Aeson.Array arrayValue) <- value =
|
||||||
|
Type.List <$> foldr foldVector (Just []) arrayValue
|
||||||
|
| otherwise = coerceVariableValue listType value
|
||||||
|
where
|
||||||
|
foldVector _ Nothing = Nothing
|
||||||
|
foldVector variableValue (Just list) = do
|
||||||
|
coerced <- coerceVariableValue listType variableValue
|
||||||
|
pure $ coerced : list
|
||||||
|
coerceVariableValue _ _ = Nothing
|
||||||
|
|
||||||
|
-- | Looks up a value by name in the given map, coerces it and inserts into the
|
||||||
|
-- result map. If the coercion fails, returns 'Nothing'. If the value isn't
|
||||||
|
-- given, but a default value is known, inserts the default value into the
|
||||||
|
-- result map. Otherwise it fails with 'Nothing' if the Input Type is a
|
||||||
|
-- Non-Nullable type, or returns the unchanged, original map.
|
||||||
|
matchFieldValues :: forall a
|
||||||
|
. (In.Type -> a -> Maybe Type.Value)
|
||||||
|
-> HashMap Name a
|
||||||
|
-> Name
|
||||||
|
-> In.Type
|
||||||
|
-> Maybe Type.Value
|
||||||
|
-> Maybe (HashMap Name Type.Value)
|
||||||
|
-> Maybe (HashMap Name Type.Value)
|
||||||
|
matchFieldValues coerce values' fieldName type' defaultValue resultMap =
|
||||||
|
case HashMap.lookup fieldName values' of
|
||||||
|
Just variableValue -> coerceRuntimeValue $ coerce type' variableValue
|
||||||
|
Nothing
|
||||||
|
| Just value <- defaultValue ->
|
||||||
|
HashMap.insert fieldName value <$> resultMap
|
||||||
|
| Nothing <- defaultValue
|
||||||
|
, In.isNonNullType type' -> Nothing
|
||||||
|
| otherwise -> resultMap
|
||||||
|
where
|
||||||
|
coerceRuntimeValue (Just Type.Null)
|
||||||
|
| In.isNonNullType type' = Nothing
|
||||||
|
coerceRuntimeValue coercedValue =
|
||||||
|
HashMap.insert fieldName <$> coercedValue <*> resultMap
|
||||||
|
|
||||||
|
-- | Coerces operation arguments according to the input coercion rules for the
|
||||||
|
-- corresponding types.
|
||||||
|
coerceInputLiteral :: In.Type -> Type.Value -> Maybe Type.Value
|
||||||
|
coerceInputLiteral (In.isNonNullType -> False) Type.Null = Just Type.Null
|
||||||
|
coerceInputLiteral (In.ScalarBaseType type') value
|
||||||
|
| (Type.String stringValue) <- value
|
||||||
|
, (Type.ScalarType "String" _) <- type' = Just $ Type.String stringValue
|
||||||
|
| (Type.Boolean booleanValue) <- value
|
||||||
|
, (Type.ScalarType "Boolean" _) <- type' = Just $ Type.Boolean booleanValue
|
||||||
|
| (Type.Int intValue) <- value
|
||||||
|
, (Type.ScalarType "Int" _) <- type' = Just $ Type.Int intValue
|
||||||
|
| (Type.Float floatValue) <- value
|
||||||
|
, (Type.ScalarType "Float" _) <- type' = Just $ Type.Float floatValue
|
||||||
|
| (Type.Int intValue) <- value
|
||||||
|
, (Type.ScalarType "Float" _) <- type' =
|
||||||
|
Just $ Type.Float $ fromIntegral intValue
|
||||||
|
| (Type.String stringValue) <- value
|
||||||
|
, (Type.ScalarType "ID" _) <- type' = Just $ Type.String stringValue
|
||||||
|
| (Type.Int intValue) <- value
|
||||||
|
, (Type.ScalarType "ID" _) <- type' = Just $ decimal intValue
|
||||||
|
where
|
||||||
|
decimal = Type.String
|
||||||
|
. Text.Lazy.toStrict
|
||||||
|
. Text.Builder.toLazyText
|
||||||
|
. Text.Builder.decimal
|
||||||
|
coerceInputLiteral (In.EnumBaseType type') (Type.Enum enumValue)
|
||||||
|
| member enumValue type' = Just $ Type.Enum enumValue
|
||||||
|
where
|
||||||
|
member value (Type.EnumType _ _ members) = HashMap.member value members
|
||||||
|
coerceInputLiteral (In.InputObjectBaseType type') (Type.Object values) =
|
||||||
|
let (In.InputObjectType _ _ inputFields) = type'
|
||||||
|
in Type.Object
|
||||||
|
<$> HashMap.foldrWithKey (matchFieldValues' values) (Just HashMap.empty) inputFields
|
||||||
|
where
|
||||||
|
matchFieldValues' values' fieldName (In.InputField _ inputFieldType defaultValue) =
|
||||||
|
matchFieldValues coerceInputLiteral values' fieldName inputFieldType defaultValue
|
||||||
|
coerceInputLiteral (In.ListBaseType listType) (Type.List list) =
|
||||||
|
Type.List <$> traverse (coerceInputLiteral listType) list
|
||||||
|
coerceInputLiteral (In.ListBaseType listType) singleton =
|
||||||
|
wrapSingleton listType singleton
|
||||||
|
where
|
||||||
|
wrapSingleton (In.ListBaseType listType') singleton' =
|
||||||
|
Type.List <$> sequence [wrapSingleton listType' singleton']
|
||||||
|
wrapSingleton listType' singleton' =
|
||||||
|
Type.List <$> sequence [coerceInputLiteral listType' singleton']
|
||||||
|
coerceInputLiteral _ _ = Nothing
|
||||||
|
|
||||||
|
-- | 'Serialize' describes how a @GraphQL@ value should be serialized.
|
||||||
|
class Serialize a where
|
||||||
|
-- | Serializes a @GraphQL@ value according to the given serialization
|
||||||
|
-- format.
|
||||||
|
--
|
||||||
|
-- Type infomration is given as a hint, e.g. if you need to know what type
|
||||||
|
-- is being serialized to serialize it properly. Don't do any validation for
|
||||||
|
-- @GraphQL@ built-in types here.
|
||||||
|
--
|
||||||
|
-- If the value cannot be serialized without losing information, return
|
||||||
|
-- 'Nothing' — it will cause a field error.
|
||||||
|
serialize :: forall m
|
||||||
|
. Out.Type m -- ^ Expected output type.
|
||||||
|
-> Output a -- ^ The value to be serialized.
|
||||||
|
-> Maybe a -- ^ Serialized value on success or 'Nothing'.
|
||||||
|
-- | __null__ representation in the given serialization format.
|
||||||
|
null :: a
|
||||||
|
|
||||||
|
-- | Intermediate type used to serialize a @GraphQL@ value.
|
||||||
|
--
|
||||||
|
-- The serialization is done during the execution, and 'Output' contains
|
||||||
|
-- already serialized data (in 'List' and 'Object') as well as the new layer
|
||||||
|
-- that has to be serialized in the current step. So 'Output' is parameterized
|
||||||
|
-- by the serialization format.
|
||||||
|
data Output a
|
||||||
|
= Int Int32
|
||||||
|
| Float Double
|
||||||
|
| String Text
|
||||||
|
| Boolean Bool
|
||||||
|
| Enum Name
|
||||||
|
| List [a]
|
||||||
|
| Object (Map Name a)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
instance forall a. IsString (Output a) where
|
||||||
|
fromString = String . fromString
|
||||||
|
|
||||||
|
instance Serialize Aeson.Value where
|
||||||
|
serialize (Out.ScalarBaseType scalarType) value
|
||||||
|
| Type.ScalarType "Int" _ <- scalarType
|
||||||
|
, Int int <- value = Just $ Aeson.toJSON int
|
||||||
|
| Type.ScalarType "Float" _ <- scalarType
|
||||||
|
, Float float <- value = Just $ Aeson.toJSON float
|
||||||
|
| Type.ScalarType "String" _ <- scalarType
|
||||||
|
, String string <- value = Just $ Aeson.String string
|
||||||
|
| Type.ScalarType "ID" _ <- scalarType
|
||||||
|
, String string <- value = Just $ Aeson.String string
|
||||||
|
| Type.ScalarType "Boolean" _ <- scalarType
|
||||||
|
, Boolean boolean <- value = Just $ Aeson.Bool boolean
|
||||||
|
serialize _ (Enum enum) = Just $ Aeson.String enum
|
||||||
|
serialize _ (List list) = Just $ Aeson.toJSON list
|
||||||
|
serialize _ (Object object) = Just $ Aeson.toJSON object
|
||||||
|
serialize _ _ = Nothing
|
||||||
|
null = Aeson.Null
|
229
src/Language/GraphQL/Execute/Execution.hs
Normal file
229
src/Language/GraphQL/Execute/Execution.hs
Normal file
@ -0,0 +1,229 @@
|
|||||||
|
{-# LANGUAGE ExplicitForAll #-}
|
||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE ViewPatterns #-}
|
||||||
|
|
||||||
|
module Language.GraphQL.Execute.Execution
|
||||||
|
( executeSelectionSet
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Control.Monad.Trans.Class (lift)
|
||||||
|
import Control.Monad.Trans.Except (runExceptT)
|
||||||
|
import Control.Monad.Trans.Reader (runReaderT)
|
||||||
|
import Control.Monad.Trans.State (gets)
|
||||||
|
import Data.List.NonEmpty (NonEmpty(..))
|
||||||
|
import Data.Map.Strict (Map)
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import qualified Data.Map.Strict as Map
|
||||||
|
import Data.Maybe (fromMaybe)
|
||||||
|
import Data.Sequence (Seq(..))
|
||||||
|
import Data.Text (Text)
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.AST.Core
|
||||||
|
import Language.GraphQL.Error
|
||||||
|
import Language.GraphQL.Execute.Coerce
|
||||||
|
import qualified Language.GraphQL.Execute.Transform as Transform
|
||||||
|
import Language.GraphQL.Trans
|
||||||
|
import qualified Language.GraphQL.Type as Type
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
import Language.GraphQL.Type.Schema
|
||||||
|
import Prelude hiding (null)
|
||||||
|
|
||||||
|
resolveFieldValue :: Monad m
|
||||||
|
=> Type.Value
|
||||||
|
-> Type.Subs
|
||||||
|
-> ActionT m a
|
||||||
|
-> m (Either Text a)
|
||||||
|
resolveFieldValue result args =
|
||||||
|
flip runReaderT (Context {arguments = Arguments args, values = result})
|
||||||
|
. runExceptT
|
||||||
|
. runActionT
|
||||||
|
|
||||||
|
collectFields :: Monad m
|
||||||
|
=> Out.ObjectType m
|
||||||
|
-> Seq (Transform.Selection m)
|
||||||
|
-> Map Name (NonEmpty (Transform.Field m))
|
||||||
|
collectFields objectType = foldl forEach Map.empty
|
||||||
|
where
|
||||||
|
forEach groupedFields (Transform.SelectionField field) =
|
||||||
|
let responseKey = aliasOrName field
|
||||||
|
in Map.insertWith (<>) responseKey (field :| []) groupedFields
|
||||||
|
forEach groupedFields (Transform.SelectionFragment selectionFragment)
|
||||||
|
| Transform.Fragment fragmentType fragmentSelectionSet <- selectionFragment
|
||||||
|
, doesFragmentTypeApply fragmentType objectType =
|
||||||
|
let fragmentGroupedFieldSet = collectFields objectType fragmentSelectionSet
|
||||||
|
in Map.unionWith (<>) groupedFields fragmentGroupedFieldSet
|
||||||
|
| otherwise = groupedFields
|
||||||
|
|
||||||
|
aliasOrName :: forall m. Transform.Field m -> Name
|
||||||
|
aliasOrName (Transform.Field alias name _ _) = fromMaybe name alias
|
||||||
|
|
||||||
|
resolveAbstractType :: Monad m
|
||||||
|
=> AbstractType m
|
||||||
|
-> Type.Subs
|
||||||
|
-> CollectErrsT m (Maybe (Out.ObjectType m))
|
||||||
|
resolveAbstractType abstractType values'
|
||||||
|
| Just (Type.String typeName) <- HashMap.lookup "__typename" values' = do
|
||||||
|
types' <- gets types
|
||||||
|
case HashMap.lookup typeName types' of
|
||||||
|
Just (ObjectType objectType) ->
|
||||||
|
if instanceOf objectType abstractType
|
||||||
|
then pure $ Just objectType
|
||||||
|
else pure Nothing
|
||||||
|
_ -> pure Nothing
|
||||||
|
| otherwise = pure Nothing
|
||||||
|
|
||||||
|
doesFragmentTypeApply :: forall m
|
||||||
|
. CompositeType m
|
||||||
|
-> Out.ObjectType m
|
||||||
|
-> Bool
|
||||||
|
doesFragmentTypeApply (CompositeObjectType fragmentType) objectType =
|
||||||
|
fragmentType == objectType
|
||||||
|
doesFragmentTypeApply (CompositeInterfaceType fragmentType) objectType =
|
||||||
|
instanceOf objectType $ AbstractInterfaceType fragmentType
|
||||||
|
doesFragmentTypeApply (CompositeUnionType fragmentType) objectType =
|
||||||
|
instanceOf objectType $ AbstractUnionType fragmentType
|
||||||
|
|
||||||
|
instanceOf :: forall m. Out.ObjectType m -> AbstractType m -> Bool
|
||||||
|
instanceOf objectType (AbstractInterfaceType interfaceType) =
|
||||||
|
let Out.ObjectType _ _ interfaces _ = objectType
|
||||||
|
in foldr go False interfaces
|
||||||
|
where
|
||||||
|
go objectInterfaceType@(Out.InterfaceType _ _ interfaces _) acc =
|
||||||
|
acc || foldr go (interfaceType == objectInterfaceType) interfaces
|
||||||
|
instanceOf objectType (AbstractUnionType unionType) =
|
||||||
|
let Out.UnionType _ _ members = unionType
|
||||||
|
in foldr go False members
|
||||||
|
where
|
||||||
|
go unionMemberType acc = acc || objectType == unionMemberType
|
||||||
|
|
||||||
|
executeField :: (Monad m, Serialize a)
|
||||||
|
=> Out.Resolver m
|
||||||
|
-> Type.Value
|
||||||
|
-> NonEmpty (Transform.Field m)
|
||||||
|
-> CollectErrsT m a
|
||||||
|
executeField (Out.Resolver fieldDefinition resolver) prev fields = do
|
||||||
|
let Out.Field _ fieldType argumentDefinitions = fieldDefinition
|
||||||
|
let (Transform.Field _ _ arguments' _ :| []) = fields
|
||||||
|
case coerceArgumentValues argumentDefinitions arguments' of
|
||||||
|
Nothing -> errmsg "Argument coercing failed."
|
||||||
|
Just argumentValues -> do
|
||||||
|
answer <- lift $ resolveFieldValue prev argumentValues resolver
|
||||||
|
case answer of
|
||||||
|
Right result -> completeValue fieldType fields result
|
||||||
|
Left errorMessage -> errmsg errorMessage
|
||||||
|
|
||||||
|
completeValue :: (Monad m, Serialize a)
|
||||||
|
=> Out.Type m
|
||||||
|
-> NonEmpty (Transform.Field m)
|
||||||
|
-> Type.Value
|
||||||
|
-> CollectErrsT m a
|
||||||
|
completeValue (Out.isNonNullType -> False) _ Type.Null = pure null
|
||||||
|
completeValue outputType@(Out.ListBaseType listType) fields (Type.List list)
|
||||||
|
= traverse (completeValue listType fields) list
|
||||||
|
>>= coerceResult outputType . List
|
||||||
|
completeValue outputType@(Out.ScalarBaseType _) _ (Type.Int int) =
|
||||||
|
coerceResult outputType $ Int int
|
||||||
|
completeValue outputType@(Out.ScalarBaseType _) _ (Type.Boolean boolean) =
|
||||||
|
coerceResult outputType $ Boolean boolean
|
||||||
|
completeValue outputType@(Out.ScalarBaseType _) _ (Type.Float float) =
|
||||||
|
coerceResult outputType $ Float float
|
||||||
|
completeValue outputType@(Out.ScalarBaseType _) _ (Type.String string) =
|
||||||
|
coerceResult outputType $ String string
|
||||||
|
completeValue outputType@(Out.EnumBaseType enumType) _ (Type.Enum enum) =
|
||||||
|
let Type.EnumType _ _ enumMembers = enumType
|
||||||
|
in if HashMap.member enum enumMembers
|
||||||
|
then coerceResult outputType $ Enum enum
|
||||||
|
else errmsg "Value completion failed."
|
||||||
|
completeValue (Out.ObjectBaseType objectType) fields result =
|
||||||
|
executeSelectionSet result objectType $ mergeSelectionSets fields
|
||||||
|
completeValue (Out.InterfaceBaseType interfaceType) fields result
|
||||||
|
| Type.Object objectMap <- result = do
|
||||||
|
let abstractType = AbstractInterfaceType interfaceType
|
||||||
|
concreteType <- resolveAbstractType abstractType objectMap
|
||||||
|
case concreteType of
|
||||||
|
Just objectType -> executeSelectionSet result objectType
|
||||||
|
$ mergeSelectionSets fields
|
||||||
|
Nothing -> errmsg "Value completion failed."
|
||||||
|
completeValue (Out.UnionBaseType unionType) fields result
|
||||||
|
| Type.Object objectMap <- result = do
|
||||||
|
let abstractType = AbstractUnionType unionType
|
||||||
|
concreteType <- resolveAbstractType abstractType objectMap
|
||||||
|
case concreteType of
|
||||||
|
Just objectType -> executeSelectionSet result objectType
|
||||||
|
$ mergeSelectionSets fields
|
||||||
|
Nothing -> errmsg "Value completion failed."
|
||||||
|
completeValue _ _ _ = errmsg "Value completion failed."
|
||||||
|
|
||||||
|
mergeSelectionSets :: Monad m => NonEmpty (Transform.Field m) -> Seq (Transform.Selection m)
|
||||||
|
mergeSelectionSets = foldr forEach mempty
|
||||||
|
where
|
||||||
|
forEach (Transform.Field _ _ _ fieldSelectionSet) selectionSet =
|
||||||
|
selectionSet <> fieldSelectionSet
|
||||||
|
|
||||||
|
errmsg :: (Monad m, Serialize a) => Text -> CollectErrsT m a
|
||||||
|
errmsg errorMessage = addErrMsg errorMessage >> pure null
|
||||||
|
|
||||||
|
coerceResult :: (Monad m, Serialize a)
|
||||||
|
=> Out.Type m
|
||||||
|
-> Output a
|
||||||
|
-> CollectErrsT m a
|
||||||
|
coerceResult outputType result
|
||||||
|
| Just serialized <- serialize outputType result = pure serialized
|
||||||
|
| otherwise = errmsg "Result coercion failed."
|
||||||
|
|
||||||
|
-- | Takes an 'Out.ObjectType' and a list of 'Transform.Selection's and applies
|
||||||
|
-- each field to each 'Transform.Selection'. Resolves into a value containing
|
||||||
|
-- the resolved 'Transform.Selection', or a null value and error information.
|
||||||
|
executeSelectionSet :: (Monad m, Serialize a)
|
||||||
|
=> Type.Value
|
||||||
|
-> Out.ObjectType m
|
||||||
|
-> Seq (Transform.Selection m)
|
||||||
|
-> CollectErrsT m a
|
||||||
|
executeSelectionSet result objectType@(Out.ObjectType _ _ _ resolvers) selectionSet = do
|
||||||
|
let fields = collectFields objectType selectionSet
|
||||||
|
resolvedValues <- Map.traverseMaybeWithKey forEach fields
|
||||||
|
coerceResult (Out.NonNullObjectType objectType) $ Object resolvedValues
|
||||||
|
where
|
||||||
|
forEach _ fields@(field :| _) =
|
||||||
|
let Transform.Field _ name _ _ = field
|
||||||
|
in traverse (tryResolver fields) $ lookupResolver name
|
||||||
|
lookupResolver = flip HashMap.lookup resolvers
|
||||||
|
tryResolver fields resolver =
|
||||||
|
executeField resolver result fields >>= lift . pure
|
||||||
|
|
||||||
|
coerceArgumentValues
|
||||||
|
:: HashMap Name In.Argument
|
||||||
|
-> HashMap Name Transform.Input
|
||||||
|
-> Maybe Type.Subs
|
||||||
|
coerceArgumentValues argumentDefinitions argumentValues =
|
||||||
|
HashMap.foldrWithKey forEach (pure mempty) argumentDefinitions
|
||||||
|
where
|
||||||
|
forEach variableName (In.Argument _ variableType defaultValue) =
|
||||||
|
matchFieldValues coerceArgumentValue argumentValues variableName variableType defaultValue
|
||||||
|
coerceArgumentValue inputType (Transform.Int integer) =
|
||||||
|
coerceInputLiteral inputType (Type.Int integer)
|
||||||
|
coerceArgumentValue inputType (Transform.Boolean boolean) =
|
||||||
|
coerceInputLiteral inputType (Type.Boolean boolean)
|
||||||
|
coerceArgumentValue inputType (Transform.String string) =
|
||||||
|
coerceInputLiteral inputType (Type.String string)
|
||||||
|
coerceArgumentValue inputType (Transform.Float float) =
|
||||||
|
coerceInputLiteral inputType (Type.Float float)
|
||||||
|
coerceArgumentValue inputType (Transform.Enum enum) =
|
||||||
|
coerceInputLiteral inputType (Type.Enum enum)
|
||||||
|
coerceArgumentValue inputType Transform.Null
|
||||||
|
| In.isNonNullType inputType = Nothing
|
||||||
|
| otherwise = coerceInputLiteral inputType Type.Null
|
||||||
|
coerceArgumentValue (In.ListBaseType inputType) (Transform.List list) =
|
||||||
|
let coerceItem = coerceInputLiteral inputType
|
||||||
|
in Type.List <$> traverse coerceItem list
|
||||||
|
coerceArgumentValue (In.InputObjectBaseType inputType) (Transform.Object object)
|
||||||
|
| In.InputObjectType _ _ inputFields <- inputType =
|
||||||
|
let go = forEachField object
|
||||||
|
resultMap = HashMap.foldrWithKey go (pure mempty) inputFields
|
||||||
|
in Type.Object <$> resultMap
|
||||||
|
coerceArgumentValue _ (Transform.Variable variable) = pure variable
|
||||||
|
coerceArgumentValue _ _ = Nothing
|
||||||
|
forEachField object variableName (In.InputField _ variableType defaultValue) =
|
||||||
|
matchFieldValues coerceArgumentValue object variableName variableType defaultValue
|
436
src/Language/GraphQL/Execute/Transform.hs
Normal file
436
src/Language/GraphQL/Execute/Transform.hs
Normal file
@ -0,0 +1,436 @@
|
|||||||
|
{-# LANGUAGE ExplicitForAll #-}
|
||||||
|
{-# LANGUAGE LambdaCase #-}
|
||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE RecordWildCards #-}
|
||||||
|
{-# LANGUAGE TupleSections #-}
|
||||||
|
|
||||||
|
-- | After the document is parsed, before getting executed, the AST is
|
||||||
|
-- transformed into a similar, simpler AST. Performed transformations include:
|
||||||
|
--
|
||||||
|
-- * Replacing variables with their values.
|
||||||
|
-- * Inlining fragments. Some fragments can be completely eliminated and
|
||||||
|
-- replaced by the selection set they represent. Invalid (recursive and
|
||||||
|
-- non-existing) fragments are skipped. The most fragments are inlined, so the
|
||||||
|
-- executor doesn't have to perform additional lookups later.
|
||||||
|
-- * Evaluating directives (@\@include@ and @\@skip@).
|
||||||
|
--
|
||||||
|
-- This module is also responsible for smaller rewrites that touch only parts of
|
||||||
|
-- the original AST.
|
||||||
|
module Language.GraphQL.Execute.Transform
|
||||||
|
( Document(..)
|
||||||
|
, Field(..)
|
||||||
|
, Fragment(..)
|
||||||
|
, Input(..)
|
||||||
|
, Operation(..)
|
||||||
|
, QueryError(..)
|
||||||
|
, Selection(..)
|
||||||
|
, document
|
||||||
|
, queryError
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Control.Monad (foldM, unless)
|
||||||
|
import Control.Monad.Trans.Class (lift)
|
||||||
|
import Control.Monad.Trans.State (State, evalStateT, gets, modify)
|
||||||
|
import Data.Foldable (find)
|
||||||
|
import Data.Functor.Identity (Identity(..))
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Data.Int (Int32)
|
||||||
|
import Data.Maybe (fromMaybe)
|
||||||
|
import Data.List.NonEmpty (NonEmpty(..))
|
||||||
|
import qualified Data.List.NonEmpty as NonEmpty
|
||||||
|
import Data.Sequence (Seq, (<|), (><))
|
||||||
|
import Data.Text (Text)
|
||||||
|
import qualified Data.Text as Text
|
||||||
|
import qualified Language.GraphQL.AST as Full
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.AST.Core
|
||||||
|
import qualified Language.GraphQL.Execute.Coerce as Coerce
|
||||||
|
import Language.GraphQL.Type.Directive (Directive(..))
|
||||||
|
import qualified Language.GraphQL.Type.Directive as Directive
|
||||||
|
import qualified Language.GraphQL.Type as Type
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
import Language.GraphQL.Type.Schema
|
||||||
|
|
||||||
|
-- | Associates a fragment name with a list of 'Field's.
|
||||||
|
data Replacement m = Replacement
|
||||||
|
{ fragments :: HashMap Full.Name (Fragment m)
|
||||||
|
, fragmentDefinitions :: FragmentDefinitions
|
||||||
|
, variableValues :: Type.Subs
|
||||||
|
, types :: HashMap Full.Name (Type m)
|
||||||
|
}
|
||||||
|
|
||||||
|
type FragmentDefinitions = HashMap Full.Name Full.FragmentDefinition
|
||||||
|
|
||||||
|
-- | Represents fragments and inline fragments.
|
||||||
|
data Fragment m
|
||||||
|
= Fragment (CompositeType m) (Seq (Selection m))
|
||||||
|
|
||||||
|
-- | Single selection element.
|
||||||
|
data Selection m
|
||||||
|
= SelectionFragment (Fragment m)
|
||||||
|
| SelectionField (Field m)
|
||||||
|
|
||||||
|
-- | GraphQL has 3 operation types: queries, mutations and subscribtions.
|
||||||
|
--
|
||||||
|
-- Currently only queries and mutations are supported.
|
||||||
|
data Operation m
|
||||||
|
= Query (Maybe Text) (Seq (Selection m))
|
||||||
|
| Mutation (Maybe Text) (Seq (Selection m))
|
||||||
|
|
||||||
|
-- | Single GraphQL field.
|
||||||
|
data Field m = Field
|
||||||
|
(Maybe Full.Name) Full.Name (HashMap Full.Name Input) (Seq (Selection m))
|
||||||
|
|
||||||
|
-- | Contains the operation to be executed along with its root type.
|
||||||
|
data Document m = Document
|
||||||
|
(HashMap Full.Name (Type m)) (Out.ObjectType m) (Operation m)
|
||||||
|
|
||||||
|
data OperationDefinition = OperationDefinition
|
||||||
|
Full.OperationType
|
||||||
|
(Maybe Full.Name)
|
||||||
|
[Full.VariableDefinition]
|
||||||
|
[Full.Directive]
|
||||||
|
Full.SelectionSet
|
||||||
|
|
||||||
|
-- | Query error types.
|
||||||
|
data QueryError
|
||||||
|
= OperationNotFound Text
|
||||||
|
| OperationNameRequired
|
||||||
|
| CoercionError
|
||||||
|
| TransformationError
|
||||||
|
| EmptyDocument
|
||||||
|
| UnsupportedRootOperation
|
||||||
|
|
||||||
|
data Input
|
||||||
|
= Int Int32
|
||||||
|
| Float Double
|
||||||
|
| String Text
|
||||||
|
| Boolean Bool
|
||||||
|
| Null
|
||||||
|
| Enum Name
|
||||||
|
| List [Type.Value]
|
||||||
|
| Object (HashMap Name Input)
|
||||||
|
| Variable Type.Value
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
queryError :: QueryError -> Text
|
||||||
|
queryError (OperationNotFound operationName) = Text.unwords
|
||||||
|
["Operation", operationName, "couldn't be found in the document."]
|
||||||
|
queryError OperationNameRequired = "Missing operation name."
|
||||||
|
queryError CoercionError = "Coercion error."
|
||||||
|
queryError TransformationError = "Schema transformation error."
|
||||||
|
queryError EmptyDocument =
|
||||||
|
"The document doesn't contain any executable operations."
|
||||||
|
queryError UnsupportedRootOperation =
|
||||||
|
"Root operation type couldn't be found in the schema."
|
||||||
|
|
||||||
|
getOperation
|
||||||
|
:: Maybe Full.Name
|
||||||
|
-> NonEmpty OperationDefinition
|
||||||
|
-> Either QueryError OperationDefinition
|
||||||
|
getOperation Nothing (operation' :| []) = pure operation'
|
||||||
|
getOperation Nothing _ = Left OperationNameRequired
|
||||||
|
getOperation (Just operationName) operations
|
||||||
|
| Just operation' <- find matchingName operations = pure operation'
|
||||||
|
| otherwise = Left $ OperationNotFound operationName
|
||||||
|
where
|
||||||
|
matchingName (OperationDefinition _ name _ _ _) =
|
||||||
|
name == Just operationName
|
||||||
|
|
||||||
|
lookupInputType
|
||||||
|
:: Full.Type
|
||||||
|
-> HashMap.HashMap Full.Name (Type m)
|
||||||
|
-> Maybe In.Type
|
||||||
|
lookupInputType (Full.TypeNamed name) types =
|
||||||
|
case HashMap.lookup name types of
|
||||||
|
Just (ScalarType scalarType) ->
|
||||||
|
Just $ In.NamedScalarType scalarType
|
||||||
|
Just (EnumType enumType) ->
|
||||||
|
Just $ In.NamedEnumType enumType
|
||||||
|
Just (InputObjectType objectType) ->
|
||||||
|
Just $ In.NamedInputObjectType objectType
|
||||||
|
_ -> Nothing
|
||||||
|
lookupInputType (Full.TypeList list) types
|
||||||
|
= In.ListType
|
||||||
|
<$> lookupInputType list types
|
||||||
|
lookupInputType (Full.TypeNonNull (Full.NonNullTypeNamed nonNull)) types =
|
||||||
|
case HashMap.lookup nonNull types of
|
||||||
|
Just (ScalarType scalarType) ->
|
||||||
|
Just $ In.NonNullScalarType scalarType
|
||||||
|
Just (EnumType enumType) ->
|
||||||
|
Just $ In.NonNullEnumType enumType
|
||||||
|
Just (InputObjectType objectType) ->
|
||||||
|
Just $ In.NonNullInputObjectType objectType
|
||||||
|
_ -> Nothing
|
||||||
|
lookupInputType (Full.TypeNonNull (Full.NonNullTypeList nonNull)) types
|
||||||
|
= In.NonNullListType
|
||||||
|
<$> lookupInputType nonNull types
|
||||||
|
|
||||||
|
coerceVariableValues :: Coerce.VariableValue a
|
||||||
|
=> forall m
|
||||||
|
. HashMap Full.Name (Type m)
|
||||||
|
-> OperationDefinition
|
||||||
|
-> HashMap.HashMap Full.Name a
|
||||||
|
-> Either QueryError Type.Subs
|
||||||
|
coerceVariableValues types operationDefinition variableValues =
|
||||||
|
let OperationDefinition _ _ variableDefinitions _ _ = operationDefinition
|
||||||
|
in maybe (Left CoercionError) Right
|
||||||
|
$ foldr forEach (Just HashMap.empty) variableDefinitions
|
||||||
|
where
|
||||||
|
forEach variableDefinition coercedValues = do
|
||||||
|
let Full.VariableDefinition variableName variableTypeName defaultValue =
|
||||||
|
variableDefinition
|
||||||
|
let defaultValue' = constValue <$> defaultValue
|
||||||
|
variableType <- lookupInputType variableTypeName types
|
||||||
|
|
||||||
|
Coerce.matchFieldValues
|
||||||
|
coerceVariableValue'
|
||||||
|
variableValues
|
||||||
|
variableName
|
||||||
|
variableType
|
||||||
|
defaultValue'
|
||||||
|
coercedValues
|
||||||
|
coerceVariableValue' variableType value'
|
||||||
|
= Coerce.coerceVariableValue variableType value'
|
||||||
|
>>= Coerce.coerceInputLiteral variableType
|
||||||
|
|
||||||
|
constValue :: Full.ConstValue -> Type.Value
|
||||||
|
constValue (Full.ConstInt i) = Type.Int i
|
||||||
|
constValue (Full.ConstFloat f) = Type.Float f
|
||||||
|
constValue (Full.ConstString x) = Type.String x
|
||||||
|
constValue (Full.ConstBoolean b) = Type.Boolean b
|
||||||
|
constValue Full.ConstNull = Type.Null
|
||||||
|
constValue (Full.ConstEnum e) = Type.Enum e
|
||||||
|
constValue (Full.ConstList l) = Type.List $ constValue <$> l
|
||||||
|
constValue (Full.ConstObject o) =
|
||||||
|
Type.Object $ HashMap.fromList $ constObjectField <$> o
|
||||||
|
where
|
||||||
|
constObjectField (Full.ObjectField key value') = (key, constValue value')
|
||||||
|
|
||||||
|
-- | Rewrites the original syntax tree into an intermediate representation used
|
||||||
|
-- for query execution.
|
||||||
|
document :: Coerce.VariableValue a
|
||||||
|
=> forall m
|
||||||
|
. Schema m
|
||||||
|
-> Maybe Full.Name
|
||||||
|
-> HashMap Full.Name a
|
||||||
|
-> Full.Document
|
||||||
|
-> Either QueryError (Document m)
|
||||||
|
document schema operationName subs ast = do
|
||||||
|
let referencedTypes = collectReferencedTypes schema
|
||||||
|
|
||||||
|
(operations, fragmentTable) <- defragment ast
|
||||||
|
chosenOperation <- getOperation operationName operations
|
||||||
|
coercedValues <- coerceVariableValues referencedTypes chosenOperation subs
|
||||||
|
|
||||||
|
let replacement = Replacement
|
||||||
|
{ fragments = HashMap.empty
|
||||||
|
, fragmentDefinitions = fragmentTable
|
||||||
|
, variableValues = coercedValues
|
||||||
|
, types = referencedTypes
|
||||||
|
}
|
||||||
|
case chosenOperation of
|
||||||
|
OperationDefinition Full.Query _ _ _ _ ->
|
||||||
|
pure $ Document referencedTypes (query schema)
|
||||||
|
$ operation chosenOperation replacement
|
||||||
|
OperationDefinition Full.Mutation _ _ _ _
|
||||||
|
| Just mutationType <- mutation schema ->
|
||||||
|
pure $ Document referencedTypes mutationType
|
||||||
|
$ operation chosenOperation replacement
|
||||||
|
_ -> Left UnsupportedRootOperation
|
||||||
|
|
||||||
|
defragment
|
||||||
|
:: Full.Document
|
||||||
|
-> Either QueryError (NonEmpty OperationDefinition, FragmentDefinitions)
|
||||||
|
defragment ast =
|
||||||
|
let (operations, fragmentTable) = foldr defragment' ([], HashMap.empty) ast
|
||||||
|
nonEmptyOperations = NonEmpty.nonEmpty operations
|
||||||
|
emptyDocument = Left EmptyDocument
|
||||||
|
in (, fragmentTable) <$> maybe emptyDocument Right nonEmptyOperations
|
||||||
|
where
|
||||||
|
defragment' definition (operations, fragments')
|
||||||
|
| (Full.ExecutableDefinition executable) <- definition
|
||||||
|
, (Full.DefinitionOperation operation') <- executable =
|
||||||
|
(transform operation' : operations, fragments')
|
||||||
|
| (Full.ExecutableDefinition executable) <- definition
|
||||||
|
, (Full.DefinitionFragment fragment) <- executable
|
||||||
|
, (Full.FragmentDefinition name _ _ _) <- fragment =
|
||||||
|
(operations, HashMap.insert name fragment fragments')
|
||||||
|
defragment' _ acc = acc
|
||||||
|
transform = \case
|
||||||
|
Full.OperationDefinition type' name variables directives' selections ->
|
||||||
|
OperationDefinition type' name variables directives' selections
|
||||||
|
Full.SelectionSet selectionSet ->
|
||||||
|
OperationDefinition Full.Query Nothing mempty mempty selectionSet
|
||||||
|
|
||||||
|
-- * Operation
|
||||||
|
|
||||||
|
operation :: OperationDefinition -> Replacement m -> Operation m
|
||||||
|
operation operationDefinition replacement
|
||||||
|
= runIdentity
|
||||||
|
$ evalStateT (collectFragments >> transform operationDefinition) replacement
|
||||||
|
where
|
||||||
|
transform (OperationDefinition Full.Query name _ _ sels) =
|
||||||
|
Query name <$> appendSelection sels
|
||||||
|
transform (OperationDefinition Full.Mutation name _ _ sels) =
|
||||||
|
Mutation name <$> appendSelection sels
|
||||||
|
|
||||||
|
-- * Selection
|
||||||
|
|
||||||
|
selection
|
||||||
|
:: Full.Selection
|
||||||
|
-> State (Replacement m) (Either (Seq (Selection m)) (Selection m))
|
||||||
|
selection (Full.Field alias name arguments' directives' selections) =
|
||||||
|
maybe (Left mempty) (Right . SelectionField) <$> do
|
||||||
|
fieldArguments <- foldM go HashMap.empty arguments'
|
||||||
|
fieldSelections <- appendSelection selections
|
||||||
|
fieldDirectives <- Directive.selection <$> directives directives'
|
||||||
|
let field' = Field alias name fieldArguments fieldSelections
|
||||||
|
pure $ field' <$ fieldDirectives
|
||||||
|
where
|
||||||
|
go arguments (Full.Argument name' value') =
|
||||||
|
inputField arguments name' value'
|
||||||
|
|
||||||
|
selection (Full.FragmentSpread name directives') =
|
||||||
|
maybe (Left mempty) (Right . SelectionFragment) <$> do
|
||||||
|
spreadDirectives <- Directive.selection <$> directives directives'
|
||||||
|
fragments' <- gets fragments
|
||||||
|
|
||||||
|
fragmentDefinitions' <- gets fragmentDefinitions
|
||||||
|
case HashMap.lookup name fragments' of
|
||||||
|
Just definition -> lift $ pure $ definition <$ spreadDirectives
|
||||||
|
Nothing
|
||||||
|
| Just definition <- HashMap.lookup name fragmentDefinitions' -> do
|
||||||
|
fragDef <- fragmentDefinition definition
|
||||||
|
case fragDef of
|
||||||
|
Just fragment -> lift $ pure $ fragment <$ spreadDirectives
|
||||||
|
_ -> lift $ pure Nothing
|
||||||
|
| otherwise -> lift $ pure Nothing
|
||||||
|
selection (Full.InlineFragment type' directives' selections) = do
|
||||||
|
fragmentDirectives <- Directive.selection <$> directives directives'
|
||||||
|
case fragmentDirectives of
|
||||||
|
Nothing -> pure $ Left mempty
|
||||||
|
_ -> do
|
||||||
|
fragmentSelectionSet <- appendSelection selections
|
||||||
|
|
||||||
|
case type' of
|
||||||
|
Nothing -> pure $ Left fragmentSelectionSet
|
||||||
|
Just typeName -> do
|
||||||
|
typeCondition' <- lookupTypeCondition typeName
|
||||||
|
case typeCondition' of
|
||||||
|
Just typeCondition -> pure $
|
||||||
|
selectionFragment typeCondition fragmentSelectionSet
|
||||||
|
Nothing -> pure $ Left mempty
|
||||||
|
where
|
||||||
|
selectionFragment typeName = Right
|
||||||
|
. SelectionFragment
|
||||||
|
. Fragment typeName
|
||||||
|
|
||||||
|
appendSelection :: Traversable t
|
||||||
|
=> t Full.Selection
|
||||||
|
-> State (Replacement m) (Seq (Selection m))
|
||||||
|
appendSelection = foldM go mempty
|
||||||
|
where
|
||||||
|
go acc sel = append acc <$> selection sel
|
||||||
|
append acc (Left list) = list >< acc
|
||||||
|
append acc (Right one) = one <| acc
|
||||||
|
|
||||||
|
directives :: [Full.Directive] -> State (Replacement m) [Directive]
|
||||||
|
directives = traverse directive
|
||||||
|
where
|
||||||
|
directive (Full.Directive directiveName directiveArguments)
|
||||||
|
= Directive directiveName . Arguments
|
||||||
|
<$> foldM go HashMap.empty directiveArguments
|
||||||
|
go arguments (Full.Argument name value') = do
|
||||||
|
substitutedValue <- value value'
|
||||||
|
return $ HashMap.insert name substitutedValue arguments
|
||||||
|
|
||||||
|
-- * Fragment replacement
|
||||||
|
|
||||||
|
-- | Extract fragment definitions into a single 'HashMap'.
|
||||||
|
collectFragments :: State (Replacement m) ()
|
||||||
|
collectFragments = do
|
||||||
|
fragDefs <- gets fragmentDefinitions
|
||||||
|
let nextValue = head $ HashMap.elems fragDefs
|
||||||
|
unless (HashMap.null fragDefs) $ do
|
||||||
|
_ <- fragmentDefinition nextValue
|
||||||
|
collectFragments
|
||||||
|
|
||||||
|
lookupTypeCondition :: Full.Name -> State (Replacement m) (Maybe (CompositeType m))
|
||||||
|
lookupTypeCondition type' = do
|
||||||
|
types' <- gets types
|
||||||
|
case HashMap.lookup type' types' of
|
||||||
|
Just (ObjectType objectType) ->
|
||||||
|
lift $ pure $ Just $ CompositeObjectType objectType
|
||||||
|
Just (UnionType unionType) ->
|
||||||
|
lift $ pure $ Just $ CompositeUnionType unionType
|
||||||
|
Just (InterfaceType interfaceType) ->
|
||||||
|
lift $ pure $ Just $ CompositeInterfaceType interfaceType
|
||||||
|
_ -> lift $ pure Nothing
|
||||||
|
|
||||||
|
fragmentDefinition
|
||||||
|
:: Full.FragmentDefinition
|
||||||
|
-> State (Replacement m) (Maybe (Fragment m))
|
||||||
|
fragmentDefinition (Full.FragmentDefinition name type' _ selections) = do
|
||||||
|
modify deleteFragmentDefinition
|
||||||
|
fragmentSelection <- appendSelection selections
|
||||||
|
compositeType <- lookupTypeCondition type'
|
||||||
|
|
||||||
|
case compositeType of
|
||||||
|
Just compositeType' -> do
|
||||||
|
let newValue = Fragment compositeType' fragmentSelection
|
||||||
|
modify $ insertFragment newValue
|
||||||
|
lift $ pure $ Just newValue
|
||||||
|
_ -> lift $ pure Nothing
|
||||||
|
where
|
||||||
|
deleteFragmentDefinition replacement@Replacement{..} =
|
||||||
|
let newDefinitions = HashMap.delete name fragmentDefinitions
|
||||||
|
in replacement{ fragmentDefinitions = newDefinitions }
|
||||||
|
insertFragment newValue replacement@Replacement{..} =
|
||||||
|
let newFragments = HashMap.insert name newValue fragments
|
||||||
|
in replacement{ fragments = newFragments }
|
||||||
|
|
||||||
|
value :: forall m. Full.Value -> State (Replacement m) Type.Value
|
||||||
|
value (Full.Variable name) =
|
||||||
|
gets (fromMaybe Type.Null . HashMap.lookup name . variableValues)
|
||||||
|
value (Full.Int int) = pure $ Type.Int int
|
||||||
|
value (Full.Float float) = pure $ Type.Float float
|
||||||
|
value (Full.String string) = pure $ Type.String string
|
||||||
|
value (Full.Boolean boolean) = pure $ Type.Boolean boolean
|
||||||
|
value Full.Null = pure Type.Null
|
||||||
|
value (Full.Enum enum) = pure $ Type.Enum enum
|
||||||
|
value (Full.List list) = Type.List <$> traverse value list
|
||||||
|
value (Full.Object object) =
|
||||||
|
Type.Object . HashMap.fromList <$> traverse objectField object
|
||||||
|
where
|
||||||
|
objectField (Full.ObjectField name value') = (name,) <$> value value'
|
||||||
|
|
||||||
|
input :: forall m. Full.Value -> State (Replacement m) (Maybe Input)
|
||||||
|
input (Full.Variable name) =
|
||||||
|
gets (fmap Variable . HashMap.lookup name . variableValues)
|
||||||
|
input (Full.Int int) = pure $ pure $ Int int
|
||||||
|
input (Full.Float float) = pure $ pure $ Float float
|
||||||
|
input (Full.String string) = pure $ pure $ String string
|
||||||
|
input (Full.Boolean boolean) = pure $ pure $ Boolean boolean
|
||||||
|
input Full.Null = pure $ pure Null
|
||||||
|
input (Full.Enum enum) = pure $ pure $ Enum enum
|
||||||
|
input (Full.List list) = pure . List <$> traverse value list
|
||||||
|
input (Full.Object object) = do
|
||||||
|
objectFields <- foldM objectField HashMap.empty object
|
||||||
|
pure $ pure $ Object objectFields
|
||||||
|
where
|
||||||
|
objectField resultMap (Full.ObjectField name value') =
|
||||||
|
inputField resultMap name value'
|
||||||
|
|
||||||
|
inputField :: forall m
|
||||||
|
. HashMap Full.Name Input
|
||||||
|
-> Full.Name
|
||||||
|
-> Full.Value
|
||||||
|
-> State (Replacement m) (HashMap Full.Name Input)
|
||||||
|
inputField resultMap name value' = do
|
||||||
|
objectFieldValue <- input value'
|
||||||
|
case objectFieldValue of
|
||||||
|
Just fieldValue -> pure $ HashMap.insert name fieldValue resultMap
|
||||||
|
Nothing -> pure resultMap
|
@ -1,145 +0,0 @@
|
|||||||
{-# LANGUAGE OverloadedStrings #-}
|
|
||||||
|
|
||||||
-- | This module provides a representation of a @GraphQL@ Schema in addition to
|
|
||||||
-- functions for defining and manipulating schemas.
|
|
||||||
module Language.GraphQL.Schema
|
|
||||||
( Resolver
|
|
||||||
, Subs
|
|
||||||
, object
|
|
||||||
, objectA
|
|
||||||
, scalar
|
|
||||||
, scalarA
|
|
||||||
, resolve
|
|
||||||
, wrappedObject
|
|
||||||
, wrappedObjectA
|
|
||||||
, wrappedScalar
|
|
||||||
, wrappedScalarA
|
|
||||||
-- * AST Reexports
|
|
||||||
, Field
|
|
||||||
, Argument(..)
|
|
||||||
, Value(..)
|
|
||||||
) where
|
|
||||||
|
|
||||||
import Control.Monad.IO.Class (MonadIO(..))
|
|
||||||
import Control.Monad.Trans.Class (lift)
|
|
||||||
import Control.Monad.Trans.Except (runExceptT)
|
|
||||||
import Control.Monad.Trans.Reader (runReaderT)
|
|
||||||
import Data.Foldable (find, fold)
|
|
||||||
import Data.Maybe (fromMaybe)
|
|
||||||
import qualified Data.Aeson as Aeson
|
|
||||||
import Data.HashMap.Strict (HashMap)
|
|
||||||
import qualified Data.HashMap.Strict as HashMap
|
|
||||||
import Data.Sequence (Seq)
|
|
||||||
import Data.Text (Text)
|
|
||||||
import qualified Data.Text as T
|
|
||||||
import Language.GraphQL.AST.Core
|
|
||||||
import Language.GraphQL.Error
|
|
||||||
import Language.GraphQL.Trans
|
|
||||||
import qualified Language.GraphQL.Type as Type
|
|
||||||
|
|
||||||
-- | Resolves a 'Field' into an @Aeson.@'Data.Aeson.Types.Object' with error
|
|
||||||
-- information (if an error has occurred). @m@ is usually expected to be an
|
|
||||||
-- instance of 'MonadIO'.
|
|
||||||
data Resolver m = Resolver
|
|
||||||
Text -- ^ Name
|
|
||||||
(Field -> CollectErrsT m Aeson.Object) -- ^ Resolver
|
|
||||||
|
|
||||||
-- | Variable substitution function.
|
|
||||||
type Subs = Name -> Maybe Value
|
|
||||||
|
|
||||||
-- | Create a new 'Resolver' with the given 'Name' from the given 'Resolver's.
|
|
||||||
object :: MonadIO m => Name -> ActionT m [Resolver m] -> Resolver m
|
|
||||||
object name = objectA name . const
|
|
||||||
|
|
||||||
-- | Like 'object' but also taking 'Argument's.
|
|
||||||
objectA :: MonadIO m
|
|
||||||
=> Name -> ([Argument] -> ActionT m [Resolver m]) -> Resolver m
|
|
||||||
objectA name f = Resolver name $ resolveFieldValue f resolveRight
|
|
||||||
where
|
|
||||||
resolveRight fld@(Field _ _ _ flds) resolver = withField (resolve resolver flds) fld
|
|
||||||
|
|
||||||
-- | Like 'object' but also taking 'Argument's and can be null or a list of objects.
|
|
||||||
wrappedObjectA :: MonadIO m
|
|
||||||
=> Name -> ([Argument] -> ActionT m (Type.Wrapping [Resolver m])) -> Resolver m
|
|
||||||
wrappedObjectA name f = Resolver name $ resolveFieldValue f resolveRight
|
|
||||||
where
|
|
||||||
resolveRight fld@(Field _ _ _ sels) resolver
|
|
||||||
= withField (traverse (`resolve` sels) resolver) fld
|
|
||||||
|
|
||||||
-- | Like 'object' but can be null or a list of objects.
|
|
||||||
wrappedObject :: MonadIO m
|
|
||||||
=> Name -> ActionT m (Type.Wrapping [Resolver m]) -> Resolver m
|
|
||||||
wrappedObject name = wrappedObjectA name . const
|
|
||||||
|
|
||||||
-- | A scalar represents a primitive value, like a string or an integer.
|
|
||||||
scalar :: (MonadIO m, Aeson.ToJSON a) => Name -> ActionT m a -> Resolver m
|
|
||||||
scalar name = scalarA name . const
|
|
||||||
|
|
||||||
-- | Like 'scalar' but also taking 'Argument's.
|
|
||||||
scalarA :: (MonadIO m, Aeson.ToJSON a)
|
|
||||||
=> Name -> ([Argument] -> ActionT m a) -> Resolver m
|
|
||||||
scalarA name f = Resolver name $ resolveFieldValue f resolveRight
|
|
||||||
where
|
|
||||||
resolveRight fld result = withField (return result) fld
|
|
||||||
|
|
||||||
-- | Like 'scalar' but also taking 'Argument's and can be null or a list of scalars.
|
|
||||||
wrappedScalarA :: (MonadIO m, Aeson.ToJSON a)
|
|
||||||
=> Name -> ([Argument] -> ActionT m (Type.Wrapping a)) -> Resolver m
|
|
||||||
wrappedScalarA name f = Resolver name $ resolveFieldValue f resolveRight
|
|
||||||
where
|
|
||||||
resolveRight fld (Type.Named result) = withField (return result) fld
|
|
||||||
resolveRight fld Type.Null
|
|
||||||
= return $ HashMap.singleton (aliasOrName fld) Aeson.Null
|
|
||||||
resolveRight fld (Type.List result) = withField (return result) fld
|
|
||||||
|
|
||||||
-- | Like 'scalar' but can be null or a list of scalars.
|
|
||||||
wrappedScalar :: (MonadIO m, Aeson.ToJSON a)
|
|
||||||
=> Name -> ActionT m (Type.Wrapping a) -> Resolver m
|
|
||||||
wrappedScalar name = wrappedScalarA name . const
|
|
||||||
|
|
||||||
resolveFieldValue :: MonadIO m
|
|
||||||
=> ([Argument] -> ActionT m a)
|
|
||||||
-> (Field -> a -> CollectErrsT m (HashMap Text Aeson.Value))
|
|
||||||
-> Field
|
|
||||||
-> CollectErrsT m (HashMap Text Aeson.Value)
|
|
||||||
resolveFieldValue f resolveRight fld@(Field _ _ args _) = do
|
|
||||||
result <- lift $ reader . runExceptT . runActionT $ f args
|
|
||||||
either resolveLeft (resolveRight fld) result
|
|
||||||
where
|
|
||||||
reader = flip runReaderT $ Context mempty
|
|
||||||
resolveLeft err = do
|
|
||||||
_ <- addErrMsg err
|
|
||||||
return $ HashMap.singleton (aliasOrName fld) Aeson.Null
|
|
||||||
|
|
||||||
-- | Helper function to facilitate 'Argument' handling.
|
|
||||||
withField :: (MonadIO m, Aeson.ToJSON a)
|
|
||||||
=> CollectErrsT m a -> Field -> CollectErrsT m (HashMap Text Aeson.Value)
|
|
||||||
withField v fld
|
|
||||||
= HashMap.singleton (aliasOrName fld) . Aeson.toJSON <$> runAppendErrs v
|
|
||||||
|
|
||||||
-- | Takes a list of 'Resolver's and a list of 'Field's and applies each
|
|
||||||
-- 'Resolver' to each 'Field'. Resolves into a value containing the
|
|
||||||
-- resolved 'Field', or a null value and error information.
|
|
||||||
resolve :: MonadIO m
|
|
||||||
=> [Resolver m] -> Seq Selection -> CollectErrsT m Aeson.Value
|
|
||||||
resolve resolvers = fmap (Aeson.toJSON . fold) . traverse tryResolvers
|
|
||||||
where
|
|
||||||
resolveTypeName (Resolver "__typename" f) = do
|
|
||||||
value <- f $ Field Nothing "__typename" mempty mempty
|
|
||||||
return $ HashMap.lookupDefault "" "__typename" value
|
|
||||||
resolveTypeName _ = return ""
|
|
||||||
tryResolvers (SelectionField fld@(Field _ name _ _))
|
|
||||||
= maybe (errmsg fld) (tryResolver fld) $ find (compareResolvers name) resolvers
|
|
||||||
tryResolvers (SelectionFragment (Fragment typeCondition selections')) = do
|
|
||||||
that <- maybe (return "") resolveTypeName (find (compareResolvers "__typename") resolvers)
|
|
||||||
if Aeson.String typeCondition == that
|
|
||||||
then fmap fold . traverse tryResolvers $ selections'
|
|
||||||
else return mempty
|
|
||||||
compareResolvers name (Resolver name' _) = name == name'
|
|
||||||
tryResolver fld (Resolver _ resolver) = resolver fld
|
|
||||||
errmsg fld@(Field _ name _ _) = do
|
|
||||||
addErrMsg $ T.unwords ["field", name, "not resolved."]
|
|
||||||
return $ HashMap.singleton (aliasOrName fld) Aeson.Null
|
|
||||||
|
|
||||||
aliasOrName :: Field -> Text
|
|
||||||
aliasOrName (Field alias name _ _) = fromMaybe name alias
|
|
@ -1,7 +1,8 @@
|
|||||||
-- | Monad transformer stack used by the @GraphQL@ resolvers.
|
-- | Monad transformer stack used by the @GraphQL@ resolvers.
|
||||||
module Language.GraphQL.Trans
|
module Language.GraphQL.Trans
|
||||||
( ActionT(..)
|
( argument
|
||||||
, Context(Context)
|
, ActionT(..)
|
||||||
|
, Context(..)
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Applicative (Alternative(..))
|
import Control.Applicative (Alternative(..))
|
||||||
@ -9,13 +10,20 @@ import Control.Monad (MonadPlus(..))
|
|||||||
import Control.Monad.IO.Class (MonadIO(..))
|
import Control.Monad.IO.Class (MonadIO(..))
|
||||||
import Control.Monad.Trans.Class (MonadTrans(..))
|
import Control.Monad.Trans.Class (MonadTrans(..))
|
||||||
import Control.Monad.Trans.Except (ExceptT)
|
import Control.Monad.Trans.Except (ExceptT)
|
||||||
import Control.Monad.Trans.Reader (ReaderT)
|
import Control.Monad.Trans.Reader (ReaderT, asks)
|
||||||
import Data.HashMap.Strict (HashMap)
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Data.Maybe (fromMaybe)
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import Language.GraphQL.AST.Core (Name, Value)
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.AST.Core
|
||||||
|
import Language.GraphQL.Type.Definition
|
||||||
|
import Prelude hiding (lookup)
|
||||||
|
|
||||||
-- | Resolution context holds resolver arguments.
|
-- | Resolution context holds resolver arguments.
|
||||||
newtype Context = Context (HashMap Name Value)
|
data Context = Context
|
||||||
|
{ arguments :: Arguments
|
||||||
|
, values :: Value
|
||||||
|
}
|
||||||
|
|
||||||
-- | Monad transformer stack used by the resolvers to provide error handling
|
-- | Monad transformer stack used by the resolvers to provide error handling
|
||||||
-- and resolution context (resolver arguments).
|
-- and resolution context (resolver arguments).
|
||||||
@ -47,3 +55,13 @@ instance Monad m => Alternative (ActionT m) where
|
|||||||
instance Monad m => MonadPlus (ActionT m) where
|
instance Monad m => MonadPlus (ActionT m) where
|
||||||
mzero = empty
|
mzero = empty
|
||||||
mplus = (<|>)
|
mplus = (<|>)
|
||||||
|
|
||||||
|
-- | Retrieves an argument by its name. If the argument with this name couldn't
|
||||||
|
-- be found, returns 'Null' (i.e. the argument is assumed to
|
||||||
|
-- be optional then).
|
||||||
|
argument :: Monad m => Name -> ActionT m Value
|
||||||
|
argument argumentName = do
|
||||||
|
argumentValue <- ActionT $ lift $ asks $ lookup . arguments
|
||||||
|
pure $ fromMaybe Null argumentValue
|
||||||
|
where
|
||||||
|
lookup (Arguments argumentMap) = HashMap.lookup argumentName argumentMap
|
||||||
|
@ -1,55 +1,16 @@
|
|||||||
-- | Definitions for @GraphQL@ input types.
|
-- | Reexports non-conflicting type system and schema definitions.
|
||||||
module Language.GraphQL.Type
|
module Language.GraphQL.Type
|
||||||
( Wrapping(..)
|
( In.InputField(..)
|
||||||
|
, In.InputObjectType(..)
|
||||||
|
, Out.Field(..)
|
||||||
|
, Out.InterfaceType(..)
|
||||||
|
, Out.ObjectType(..)
|
||||||
|
, Out.UnionType(..)
|
||||||
|
, module Language.GraphQL.Type.Definition
|
||||||
|
, module Language.GraphQL.Type.Schema
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Data.Aeson as Aeson (ToJSON, toJSON)
|
import Language.GraphQL.Type.Definition
|
||||||
import qualified Data.Aeson as Aeson
|
import Language.GraphQL.Type.Schema (Schema(..))
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
-- | GraphQL distinguishes between "wrapping" and "named" types. Each wrapping
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
-- type can wrap other wrapping or named types. Wrapping types are lists and
|
|
||||||
-- Non-Null types (named types are nullable by default).
|
|
||||||
--
|
|
||||||
-- This 'Wrapping' type doesn\'t reflect this distinction exactly but it is
|
|
||||||
-- used in the resolvers to take into account that the returned value can be
|
|
||||||
-- nullable or an (arbitrary nested) list.
|
|
||||||
data Wrapping a
|
|
||||||
= List [Wrapping a] -- ^ Arbitrary nested list
|
|
||||||
| Named a -- ^ Named type without further wrapping
|
|
||||||
| Null -- ^ Null
|
|
||||||
deriving (Eq, Show)
|
|
||||||
|
|
||||||
instance Functor Wrapping where
|
|
||||||
fmap f (List list) = List $ fmap (fmap f) list
|
|
||||||
fmap f (Named named) = Named $ f named
|
|
||||||
fmap _ Null = Null
|
|
||||||
|
|
||||||
instance Foldable Wrapping where
|
|
||||||
foldr f acc (List list) = foldr (flip $ foldr f) acc list
|
|
||||||
foldr f acc (Named named) = f named acc
|
|
||||||
foldr _ acc Null = acc
|
|
||||||
|
|
||||||
instance Traversable Wrapping where
|
|
||||||
traverse f (List list) = List <$> traverse (traverse f) list
|
|
||||||
traverse f (Named named) = Named <$> f named
|
|
||||||
traverse _ Null = pure Null
|
|
||||||
|
|
||||||
instance Applicative Wrapping where
|
|
||||||
pure = Named
|
|
||||||
Null <*> _ = Null
|
|
||||||
_ <*> Null = Null
|
|
||||||
(Named f) <*> (Named x) = Named $ f x
|
|
||||||
(List fs) <*> (List xs) = List $ (<*>) <$> fs <*> xs
|
|
||||||
(Named f) <*> list = f <$> list
|
|
||||||
(List fs) <*> named = List $ (<*> named) <$> fs
|
|
||||||
|
|
||||||
instance Monad Wrapping where
|
|
||||||
return = pure
|
|
||||||
Null >>= _ = Null
|
|
||||||
(Named x) >>= f = f x
|
|
||||||
(List xs) >>= f = List $ fmap (>>= f) xs
|
|
||||||
|
|
||||||
instance ToJSON a => ToJSON (Wrapping a) where
|
|
||||||
toJSON (List list) = toJSON list
|
|
||||||
toJSON (Named named) = toJSON named
|
|
||||||
toJSON Null = Aeson.Null
|
|
||||||
|
115
src/Language/GraphQL/Type/Definition.hs
Normal file
115
src/Language/GraphQL/Type/Definition.hs
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
|
||||||
|
-- | Types that can be used as both input and output types.
|
||||||
|
module Language.GraphQL.Type.Definition
|
||||||
|
( EnumType(..)
|
||||||
|
, EnumValue(..)
|
||||||
|
, ScalarType(..)
|
||||||
|
, Subs
|
||||||
|
, Value(..)
|
||||||
|
, boolean
|
||||||
|
, float
|
||||||
|
, id
|
||||||
|
, int
|
||||||
|
, string
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Int (Int32)
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import Data.String (IsString(..))
|
||||||
|
import Data.Text (Text)
|
||||||
|
import Language.GraphQL.AST.Document (Name)
|
||||||
|
import Prelude hiding (id)
|
||||||
|
|
||||||
|
-- | Represents accordingly typed GraphQL values.
|
||||||
|
data Value
|
||||||
|
= Int Int32
|
||||||
|
| Float Double -- ^ GraphQL Float is double precision.
|
||||||
|
| String Text
|
||||||
|
| Boolean Bool
|
||||||
|
| Null
|
||||||
|
| Enum Name
|
||||||
|
| List [Value] -- ^ Arbitrary nested list.
|
||||||
|
| Object (HashMap Name Value)
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
instance IsString Value where
|
||||||
|
fromString = String . fromString
|
||||||
|
|
||||||
|
-- | Contains variables for the query. The key of the map is a variable name,
|
||||||
|
-- and the value is the variable value.
|
||||||
|
type Subs = HashMap Name Value
|
||||||
|
|
||||||
|
-- | Scalar type definition.
|
||||||
|
--
|
||||||
|
-- The leaf values of any request and input values to arguments are Scalars (or
|
||||||
|
-- Enums) .
|
||||||
|
data ScalarType = ScalarType Name (Maybe Text)
|
||||||
|
|
||||||
|
instance Eq ScalarType where
|
||||||
|
(ScalarType this _) == (ScalarType that _) = this == that
|
||||||
|
|
||||||
|
-- | Enum type definition.
|
||||||
|
--
|
||||||
|
-- Some leaf values of requests and input values are Enums. GraphQL serializes
|
||||||
|
-- Enum values as strings, however internally Enums can be represented by any
|
||||||
|
-- kind of type, often integers.
|
||||||
|
data EnumType = EnumType Name (Maybe Text) (HashMap Name EnumValue)
|
||||||
|
|
||||||
|
instance Eq EnumType where
|
||||||
|
(EnumType this _ _) == (EnumType that _ _) = this == that
|
||||||
|
|
||||||
|
-- | Enum value is a single member of an 'EnumType'.
|
||||||
|
newtype EnumValue = EnumValue (Maybe Text)
|
||||||
|
|
||||||
|
-- | The @String@ scalar type represents textual data, represented as UTF-8
|
||||||
|
-- character sequences. The String type is most often used by GraphQL to
|
||||||
|
-- represent free-form human-readable text.
|
||||||
|
string :: ScalarType
|
||||||
|
string = ScalarType "String" (Just description)
|
||||||
|
where
|
||||||
|
description =
|
||||||
|
"The `String` scalar type represents textual data, represented as \
|
||||||
|
\UTF-8 character sequences. The String type is most often used by \
|
||||||
|
\GraphQL to represent free-form human-readable text."
|
||||||
|
|
||||||
|
-- | The @Boolean@ scalar type represents @true@ or @false@.
|
||||||
|
boolean :: ScalarType
|
||||||
|
boolean = ScalarType "Boolean" (Just description)
|
||||||
|
where
|
||||||
|
description = "The `Boolean` scalar type represents `true` or `false`."
|
||||||
|
|
||||||
|
-- | The @Int@ scalar type represents non-fractional signed whole numeric
|
||||||
|
-- values. Int can represent values between \(-2^{31}\) and \(2^{31 - 1}\).
|
||||||
|
int :: ScalarType
|
||||||
|
int = ScalarType "Int" (Just description)
|
||||||
|
where
|
||||||
|
description =
|
||||||
|
"The `Int` scalar type represents non-fractional signed whole numeric \
|
||||||
|
\values. Int can represent values between -(2^31) and 2^31 - 1."
|
||||||
|
|
||||||
|
-- | The @Float@ scalar type represents signed double-precision fractional
|
||||||
|
-- values as specified by
|
||||||
|
-- [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
|
||||||
|
float :: ScalarType
|
||||||
|
float = ScalarType "Float" (Just description)
|
||||||
|
where
|
||||||
|
description =
|
||||||
|
"The `Float` scalar type represents signed double-precision fractional \
|
||||||
|
\values as specified by \
|
||||||
|
\[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point)."
|
||||||
|
|
||||||
|
-- | The @ID@ scalar type represents a unique identifier, often used to refetch
|
||||||
|
-- an object or as key for a cache. The ID type appears in a JSON response as a
|
||||||
|
-- String; however, it is not intended to be human-readable. When expected as an
|
||||||
|
-- input type, any string (such as @"4"@) or integer (such as @4@) input value
|
||||||
|
-- will be accepted as an ID.
|
||||||
|
id :: ScalarType
|
||||||
|
id = ScalarType "ID" (Just description)
|
||||||
|
where
|
||||||
|
description =
|
||||||
|
"The `ID` scalar type represents a unique identifier, often used to \
|
||||||
|
\refetch an object or as key for a cache. The ID type appears in a \
|
||||||
|
\JSON response as a String; however, it is not intended to be \
|
||||||
|
\human-readable. When expected as an input type, any string (such as \
|
||||||
|
\`\"4\"`) or integer (such as `4`) input value will be accepted as an ID."
|
57
src/Language/GraphQL/Type/Directive.hs
Normal file
57
src/Language/GraphQL/Type/Directive.hs
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
|
||||||
|
module Language.GraphQL.Type.Directive
|
||||||
|
( Directive(..)
|
||||||
|
, selection
|
||||||
|
) where
|
||||||
|
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.AST.Core
|
||||||
|
import Language.GraphQL.Type.Definition
|
||||||
|
|
||||||
|
-- | Directive.
|
||||||
|
data Directive = Directive Name Arguments
|
||||||
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
-- | Directive processing status.
|
||||||
|
data Status
|
||||||
|
= Skip -- ^ Skip the selection and stop directive processing
|
||||||
|
| Include Directive -- ^ The directive was processed, try other handlers
|
||||||
|
| Continue Directive -- ^ Directive handler mismatch, try other handlers
|
||||||
|
|
||||||
|
-- | Takes a list of directives, handles supported directives and excludes them
|
||||||
|
-- from the result. If the selection should be skipped, returns 'Nothing'.
|
||||||
|
selection :: [Directive] -> Maybe [Directive]
|
||||||
|
selection = foldr go (Just [])
|
||||||
|
where
|
||||||
|
go directive' directives' =
|
||||||
|
case (skip . include) (Continue directive') of
|
||||||
|
(Include _) -> directives'
|
||||||
|
Skip -> Nothing
|
||||||
|
(Continue x) -> (x :) <$> directives'
|
||||||
|
|
||||||
|
handle :: (Directive -> Status) -> Status -> Status
|
||||||
|
handle _ Skip = Skip
|
||||||
|
handle handler (Continue directive) = handler directive
|
||||||
|
handle handler (Include directive) = handler directive
|
||||||
|
|
||||||
|
-- * Directive implementations
|
||||||
|
|
||||||
|
skip :: Status -> Status
|
||||||
|
skip = handle skip'
|
||||||
|
where
|
||||||
|
skip' directive'@(Directive "skip" (Arguments arguments)) =
|
||||||
|
case HashMap.lookup "if" arguments of
|
||||||
|
(Just (Boolean True)) -> Skip
|
||||||
|
_ -> Include directive'
|
||||||
|
skip' directive' = Continue directive'
|
||||||
|
|
||||||
|
include :: Status -> Status
|
||||||
|
include = handle include'
|
||||||
|
where
|
||||||
|
include' directive'@(Directive "include" (Arguments arguments)) =
|
||||||
|
case HashMap.lookup "if" arguments of
|
||||||
|
(Just (Boolean True)) -> Include directive'
|
||||||
|
_ -> Skip
|
||||||
|
include' directive' = Continue directive'
|
101
src/Language/GraphQL/Type/In.hs
Normal file
101
src/Language/GraphQL/Type/In.hs
Normal file
@ -0,0 +1,101 @@
|
|||||||
|
{-# LANGUAGE PatternSynonyms #-}
|
||||||
|
{-# LANGUAGE ViewPatterns #-}
|
||||||
|
|
||||||
|
-- | Input types and values.
|
||||||
|
--
|
||||||
|
-- This module is intended to be imported qualified, to avoid name clashes
|
||||||
|
-- with 'Language.GraphQL.Type.Out'.
|
||||||
|
module Language.GraphQL.Type.In
|
||||||
|
( Argument(..)
|
||||||
|
, InputField(..)
|
||||||
|
, InputObjectType(..)
|
||||||
|
, Type(..)
|
||||||
|
, isNonNullType
|
||||||
|
, pattern EnumBaseType
|
||||||
|
, pattern ListBaseType
|
||||||
|
, pattern InputObjectBaseType
|
||||||
|
, pattern ScalarBaseType
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import Data.Text (Text)
|
||||||
|
import Language.GraphQL.AST.Document (Name)
|
||||||
|
import Language.GraphQL.Type.Definition
|
||||||
|
|
||||||
|
-- | Single field of an 'InputObjectType'.
|
||||||
|
data InputField = InputField (Maybe Text) Type (Maybe Value)
|
||||||
|
|
||||||
|
-- | Input object type definition.
|
||||||
|
--
|
||||||
|
-- An input object defines a structured collection of fields which may be
|
||||||
|
-- supplied to a field argument.
|
||||||
|
data InputObjectType = InputObjectType
|
||||||
|
Name (Maybe Text) (HashMap Name InputField)
|
||||||
|
|
||||||
|
instance Eq InputObjectType where
|
||||||
|
(InputObjectType this _ _) == (InputObjectType that _ _) = this == that
|
||||||
|
|
||||||
|
-- | These types may be used as input types for arguments and directives.
|
||||||
|
--
|
||||||
|
-- GraphQL distinguishes between "wrapping" and "named" types. Each wrapping
|
||||||
|
-- type can wrap other wrapping or named types. Wrapping types are lists and
|
||||||
|
-- Non-Null types (named types are nullable by default).
|
||||||
|
data Type
|
||||||
|
= NamedScalarType ScalarType
|
||||||
|
| NamedEnumType EnumType
|
||||||
|
| NamedInputObjectType InputObjectType
|
||||||
|
| ListType Type
|
||||||
|
| NonNullScalarType ScalarType
|
||||||
|
| NonNullEnumType EnumType
|
||||||
|
| NonNullInputObjectType InputObjectType
|
||||||
|
| NonNullListType Type
|
||||||
|
deriving Eq
|
||||||
|
|
||||||
|
-- | Field argument definition.
|
||||||
|
data Argument = Argument (Maybe Text) Type (Maybe Value)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedScalarType' or 'NonNullScalarType'.
|
||||||
|
pattern ScalarBaseType :: ScalarType -> Type
|
||||||
|
pattern ScalarBaseType scalarType <- (isScalarType -> Just scalarType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedEnumType' or 'NonNullEnumType'.
|
||||||
|
pattern EnumBaseType :: EnumType -> Type
|
||||||
|
pattern EnumBaseType enumType <- (isEnumType -> Just enumType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedInputObjectType' or 'NonNullInputObjectType'.
|
||||||
|
pattern InputObjectBaseType :: InputObjectType -> Type
|
||||||
|
pattern InputObjectBaseType objectType <- (isInputObjectType -> Just objectType)
|
||||||
|
|
||||||
|
-- | Matches either 'ListType' or 'NonNullListType'.
|
||||||
|
pattern ListBaseType :: Type -> Type
|
||||||
|
pattern ListBaseType listType <- (isListType -> Just listType)
|
||||||
|
|
||||||
|
{-# COMPLETE EnumBaseType, ListBaseType, InputObjectBaseType, ScalarBaseType #-}
|
||||||
|
|
||||||
|
isScalarType :: Type -> Maybe ScalarType
|
||||||
|
isScalarType (NamedScalarType inputType) = Just inputType
|
||||||
|
isScalarType (NonNullScalarType inputType) = Just inputType
|
||||||
|
isScalarType _ = Nothing
|
||||||
|
|
||||||
|
isInputObjectType :: Type -> Maybe InputObjectType
|
||||||
|
isInputObjectType (NamedInputObjectType inputType) = Just inputType
|
||||||
|
isInputObjectType (NonNullInputObjectType inputType) = Just inputType
|
||||||
|
isInputObjectType _ = Nothing
|
||||||
|
|
||||||
|
isEnumType :: Type -> Maybe EnumType
|
||||||
|
isEnumType (NamedEnumType inputType) = Just inputType
|
||||||
|
isEnumType (NonNullEnumType inputType) = Just inputType
|
||||||
|
isEnumType _ = Nothing
|
||||||
|
|
||||||
|
isListType :: Type -> Maybe Type
|
||||||
|
isListType (ListType inputType) = Just inputType
|
||||||
|
isListType (NonNullListType inputType) = Just inputType
|
||||||
|
isListType _ = Nothing
|
||||||
|
|
||||||
|
-- | Checks whether the given input type is a non-null type.
|
||||||
|
isNonNullType :: Type -> Bool
|
||||||
|
isNonNullType (NonNullScalarType _) = True
|
||||||
|
isNonNullType (NonNullEnumType _) = True
|
||||||
|
isNonNullType (NonNullInputObjectType _) = True
|
||||||
|
isNonNullType (NonNullListType _) = True
|
||||||
|
isNonNullType _ = False
|
168
src/Language/GraphQL/Type/Out.hs
Normal file
168
src/Language/GraphQL/Type/Out.hs
Normal file
@ -0,0 +1,168 @@
|
|||||||
|
{-# LANGUAGE ExplicitForAll #-}
|
||||||
|
{-# LANGUAGE PatternSynonyms #-}
|
||||||
|
{-# LANGUAGE ViewPatterns #-}
|
||||||
|
|
||||||
|
-- | Output types and values.
|
||||||
|
--
|
||||||
|
-- This module is intended to be imported qualified, to avoid name clashes
|
||||||
|
-- with 'Language.GraphQL.Type.In'.
|
||||||
|
module Language.GraphQL.Type.Out
|
||||||
|
( Field(..)
|
||||||
|
, InterfaceType(..)
|
||||||
|
, ObjectType(..)
|
||||||
|
, Resolver(..)
|
||||||
|
, Type(..)
|
||||||
|
, UnionType(..)
|
||||||
|
, isNonNullType
|
||||||
|
, pattern EnumBaseType
|
||||||
|
, pattern InterfaceBaseType
|
||||||
|
, pattern ListBaseType
|
||||||
|
, pattern ObjectBaseType
|
||||||
|
, pattern ScalarBaseType
|
||||||
|
, pattern UnionBaseType
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import Data.Text (Text)
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.Trans
|
||||||
|
import Language.GraphQL.Type.Definition
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
|
||||||
|
-- | Resolves a 'Field' into an @Aeson.@'Data.Aeson.Types.Object' with error
|
||||||
|
-- information (if an error has occurred). @m@ is an arbitrary monad, usually
|
||||||
|
-- 'IO'.
|
||||||
|
--
|
||||||
|
-- Resolving a field can result in a leaf value or an object, which is
|
||||||
|
-- represented as a list of nested resolvers, used to resolve the fields of that
|
||||||
|
-- object.
|
||||||
|
data Resolver m = Resolver (Field m) (ActionT m Value)
|
||||||
|
|
||||||
|
-- | Object type definition.
|
||||||
|
--
|
||||||
|
-- Almost all of the GraphQL types you define will be object types. Object
|
||||||
|
-- types have a name, but most importantly describe their fields.
|
||||||
|
data ObjectType m = ObjectType
|
||||||
|
Name (Maybe Text) [InterfaceType m] (HashMap Name (Resolver m))
|
||||||
|
|
||||||
|
instance forall a. Eq (ObjectType a) where
|
||||||
|
(ObjectType this _ _ _) == (ObjectType that _ _ _) = this == that
|
||||||
|
|
||||||
|
-- | Interface Type Definition.
|
||||||
|
--
|
||||||
|
-- When a field can return one of a heterogeneous set of types, a Interface type
|
||||||
|
-- is used to describe what types are possible, and what fields are in common
|
||||||
|
-- across all types.
|
||||||
|
data InterfaceType m = InterfaceType
|
||||||
|
Name (Maybe Text) [InterfaceType m] (HashMap Name (Field m))
|
||||||
|
|
||||||
|
instance forall a. Eq (InterfaceType a) where
|
||||||
|
(InterfaceType this _ _ _) == (InterfaceType that _ _ _) = this == that
|
||||||
|
|
||||||
|
-- | Union Type Definition.
|
||||||
|
--
|
||||||
|
-- When a field can return one of a heterogeneous set of types, a Union type is
|
||||||
|
-- used to describe what types are possible.
|
||||||
|
data UnionType m = UnionType Name (Maybe Text) [ObjectType m]
|
||||||
|
|
||||||
|
instance forall a. Eq (UnionType a) where
|
||||||
|
(UnionType this _ _) == (UnionType that _ _) = this == that
|
||||||
|
|
||||||
|
-- | Output object field definition.
|
||||||
|
data Field m = Field
|
||||||
|
(Maybe Text) -- ^ Description.
|
||||||
|
(Type m) -- ^ Field type.
|
||||||
|
(HashMap Name In.Argument) -- ^ Arguments.
|
||||||
|
|
||||||
|
-- | These types may be used as output types as the result of fields.
|
||||||
|
--
|
||||||
|
-- GraphQL distinguishes between "wrapping" and "named" types. Each wrapping
|
||||||
|
-- type can wrap other wrapping or named types. Wrapping types are lists and
|
||||||
|
-- Non-Null types (named types are nullable by default).
|
||||||
|
data Type m
|
||||||
|
= NamedScalarType ScalarType
|
||||||
|
| NamedEnumType EnumType
|
||||||
|
| NamedObjectType (ObjectType m)
|
||||||
|
| NamedInterfaceType (InterfaceType m)
|
||||||
|
| NamedUnionType (UnionType m)
|
||||||
|
| ListType (Type m)
|
||||||
|
| NonNullScalarType ScalarType
|
||||||
|
| NonNullEnumType EnumType
|
||||||
|
| NonNullObjectType (ObjectType m)
|
||||||
|
| NonNullInterfaceType (InterfaceType m)
|
||||||
|
| NonNullUnionType (UnionType m)
|
||||||
|
| NonNullListType (Type m)
|
||||||
|
deriving Eq
|
||||||
|
|
||||||
|
-- | Matches either 'NamedScalarType' or 'NonNullScalarType'.
|
||||||
|
pattern ScalarBaseType :: forall m. ScalarType -> Type m
|
||||||
|
pattern ScalarBaseType scalarType <- (isScalarType -> Just scalarType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedEnumType' or 'NonNullEnumType'.
|
||||||
|
pattern EnumBaseType :: forall m. EnumType -> Type m
|
||||||
|
pattern EnumBaseType enumType <- (isEnumType -> Just enumType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedObjectType' or 'NonNullObjectType'.
|
||||||
|
pattern ObjectBaseType :: forall m. ObjectType m -> Type m
|
||||||
|
pattern ObjectBaseType objectType <- (isObjectType -> Just objectType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedInterfaceType' or 'NonNullInterfaceType'.
|
||||||
|
pattern InterfaceBaseType :: forall m. InterfaceType m -> Type m
|
||||||
|
pattern InterfaceBaseType interfaceType <-
|
||||||
|
(isInterfaceType -> Just interfaceType)
|
||||||
|
|
||||||
|
-- | Matches either 'NamedUnionType' or 'NonNullUnionType'.
|
||||||
|
pattern UnionBaseType :: forall m. UnionType m -> Type m
|
||||||
|
pattern UnionBaseType unionType <- (isUnionType -> Just unionType)
|
||||||
|
|
||||||
|
-- | Matches either 'ListType' or 'NonNullListType'.
|
||||||
|
pattern ListBaseType :: forall m. Type m -> Type m
|
||||||
|
pattern ListBaseType listType <- (isListType -> Just listType)
|
||||||
|
|
||||||
|
{-# COMPLETE ScalarBaseType
|
||||||
|
, EnumBaseType
|
||||||
|
, ObjectBaseType
|
||||||
|
, ListBaseType
|
||||||
|
, InterfaceBaseType
|
||||||
|
, UnionBaseType
|
||||||
|
#-}
|
||||||
|
|
||||||
|
isScalarType :: forall m. Type m -> Maybe ScalarType
|
||||||
|
isScalarType (NamedScalarType outputType) = Just outputType
|
||||||
|
isScalarType (NonNullScalarType outputType) = Just outputType
|
||||||
|
isScalarType _ = Nothing
|
||||||
|
|
||||||
|
isObjectType :: forall m. Type m -> Maybe (ObjectType m)
|
||||||
|
isObjectType (NamedObjectType outputType) = Just outputType
|
||||||
|
isObjectType (NonNullObjectType outputType) = Just outputType
|
||||||
|
isObjectType _ = Nothing
|
||||||
|
|
||||||
|
isEnumType :: forall m. Type m -> Maybe EnumType
|
||||||
|
isEnumType (NamedEnumType outputType) = Just outputType
|
||||||
|
isEnumType (NonNullEnumType outputType) = Just outputType
|
||||||
|
isEnumType _ = Nothing
|
||||||
|
|
||||||
|
isInterfaceType :: forall m. Type m -> Maybe (InterfaceType m)
|
||||||
|
isInterfaceType (NamedInterfaceType interfaceType) = Just interfaceType
|
||||||
|
isInterfaceType (NonNullInterfaceType interfaceType) = Just interfaceType
|
||||||
|
isInterfaceType _ = Nothing
|
||||||
|
|
||||||
|
isUnionType :: forall m. Type m -> Maybe (UnionType m)
|
||||||
|
isUnionType (NamedUnionType unionType) = Just unionType
|
||||||
|
isUnionType (NonNullUnionType unionType) = Just unionType
|
||||||
|
isUnionType _ = Nothing
|
||||||
|
|
||||||
|
isListType :: forall m. Type m -> Maybe (Type m)
|
||||||
|
isListType (ListType outputType) = Just outputType
|
||||||
|
isListType (NonNullListType outputType) = Just outputType
|
||||||
|
isListType _ = Nothing
|
||||||
|
|
||||||
|
-- | Checks whether the given output type is a non-null type.
|
||||||
|
isNonNullType :: forall m. Type m -> Bool
|
||||||
|
isNonNullType (NonNullScalarType _) = True
|
||||||
|
isNonNullType (NonNullEnumType _) = True
|
||||||
|
isNonNullType (NonNullObjectType _) = True
|
||||||
|
isNonNullType (NonNullInterfaceType _) = True
|
||||||
|
isNonNullType (NonNullUnionType _) = True
|
||||||
|
isNonNullType (NonNullListType _) = True
|
||||||
|
isNonNullType _ = False
|
112
src/Language/GraphQL/Type/Schema.hs
Normal file
112
src/Language/GraphQL/Type/Schema.hs
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
{-# LANGUAGE ExplicitForAll #-}
|
||||||
|
|
||||||
|
-- | This module provides a representation of a @GraphQL@ Schema in addition to
|
||||||
|
-- functions for defining and manipulating schemas.
|
||||||
|
module Language.GraphQL.Type.Schema
|
||||||
|
( AbstractType(..)
|
||||||
|
, CompositeType(..)
|
||||||
|
, Schema(..)
|
||||||
|
, Type(..)
|
||||||
|
, collectReferencedTypes
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Language.GraphQL.AST.Document (Name)
|
||||||
|
import qualified Language.GraphQL.Type.Definition as Definition
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
|
||||||
|
-- | These are all of the possible kinds of types.
|
||||||
|
data Type m
|
||||||
|
= ScalarType Definition.ScalarType
|
||||||
|
| EnumType Definition.EnumType
|
||||||
|
| ObjectType (Out.ObjectType m)
|
||||||
|
| InputObjectType In.InputObjectType
|
||||||
|
| InterfaceType (Out.InterfaceType m)
|
||||||
|
| UnionType (Out.UnionType m)
|
||||||
|
deriving Eq
|
||||||
|
|
||||||
|
-- | These types may describe the parent context of a selection set.
|
||||||
|
data CompositeType m
|
||||||
|
= CompositeUnionType (Out.UnionType m)
|
||||||
|
| CompositeObjectType (Out.ObjectType m)
|
||||||
|
| CompositeInterfaceType (Out.InterfaceType m)
|
||||||
|
deriving Eq
|
||||||
|
|
||||||
|
-- | These types may describe the parent context of a selection set.
|
||||||
|
data AbstractType m
|
||||||
|
= AbstractUnionType (Out.UnionType m)
|
||||||
|
| AbstractInterfaceType (Out.InterfaceType m)
|
||||||
|
deriving Eq
|
||||||
|
|
||||||
|
-- | A Schema is created by supplying the root types of each type of operation,
|
||||||
|
-- query and mutation (optional). A schema definition is then supplied to the
|
||||||
|
-- validator and executor.
|
||||||
|
--
|
||||||
|
-- __Note:__ When the schema is constructed, by default only the types that
|
||||||
|
-- are reachable by traversing the root types are included, other types must
|
||||||
|
-- be explicitly referenced.
|
||||||
|
data Schema m = Schema
|
||||||
|
{ query :: Out.ObjectType m
|
||||||
|
, mutation :: Maybe (Out.ObjectType m)
|
||||||
|
}
|
||||||
|
|
||||||
|
-- | Traverses the schema and finds all referenced types.
|
||||||
|
collectReferencedTypes :: forall m. Schema m -> HashMap Name (Type m)
|
||||||
|
collectReferencedTypes schema =
|
||||||
|
let queryTypes = traverseObjectType (query schema) HashMap.empty
|
||||||
|
in maybe queryTypes (`traverseObjectType` queryTypes) $ mutation schema
|
||||||
|
where
|
||||||
|
collect traverser typeName element foundTypes
|
||||||
|
| HashMap.member typeName foundTypes = foundTypes
|
||||||
|
| otherwise = traverser $ HashMap.insert typeName element foundTypes
|
||||||
|
visitFields (Out.Field _ outputType arguments) foundTypes
|
||||||
|
= traverseOutputType outputType
|
||||||
|
$ foldr visitArguments foundTypes arguments
|
||||||
|
visitArguments (In.Argument _ inputType _) = traverseInputType inputType
|
||||||
|
visitInputFields (In.InputField _ inputType _) = traverseInputType inputType
|
||||||
|
traverseInputType (In.InputObjectBaseType objectType) =
|
||||||
|
let (In.InputObjectType typeName _ inputFields) = objectType
|
||||||
|
element = InputObjectType objectType
|
||||||
|
traverser = flip (foldr visitInputFields) inputFields
|
||||||
|
in collect traverser typeName element
|
||||||
|
traverseInputType (In.ListBaseType listType) =
|
||||||
|
traverseInputType listType
|
||||||
|
traverseInputType (In.ScalarBaseType scalarType) =
|
||||||
|
let (Definition.ScalarType typeName _) = scalarType
|
||||||
|
in collect Prelude.id typeName (ScalarType scalarType)
|
||||||
|
traverseInputType (In.EnumBaseType enumType) =
|
||||||
|
let (Definition.EnumType typeName _ _) = enumType
|
||||||
|
in collect Prelude.id typeName (EnumType enumType)
|
||||||
|
traverseOutputType (Out.ObjectBaseType objectType) =
|
||||||
|
traverseObjectType objectType
|
||||||
|
traverseOutputType (Out.InterfaceBaseType interfaceType) =
|
||||||
|
traverseInterfaceType interfaceType
|
||||||
|
traverseOutputType (Out.UnionBaseType unionType) =
|
||||||
|
let (Out.UnionType typeName _ types) = unionType
|
||||||
|
traverser = flip (foldr traverseObjectType) types
|
||||||
|
in collect traverser typeName (UnionType unionType)
|
||||||
|
traverseOutputType (Out.ListBaseType listType) =
|
||||||
|
traverseOutputType listType
|
||||||
|
traverseOutputType (Out.ScalarBaseType scalarType) =
|
||||||
|
let (Definition.ScalarType typeName _) = scalarType
|
||||||
|
in collect Prelude.id typeName (ScalarType scalarType)
|
||||||
|
traverseOutputType (Out.EnumBaseType enumType) =
|
||||||
|
let (Definition.EnumType typeName _ _) = enumType
|
||||||
|
in collect Prelude.id typeName (EnumType enumType)
|
||||||
|
traverseObjectType objectType foundTypes =
|
||||||
|
let (Out.ObjectType typeName _ interfaces resolvers) = objectType
|
||||||
|
element = ObjectType objectType
|
||||||
|
fields = extractObjectField <$> resolvers
|
||||||
|
traverser = polymorphicTraverser interfaces fields
|
||||||
|
in collect traverser typeName element foundTypes
|
||||||
|
traverseInterfaceType interfaceType foundTypes =
|
||||||
|
let (Out.InterfaceType typeName _ interfaces fields) = interfaceType
|
||||||
|
element = InterfaceType interfaceType
|
||||||
|
traverser = polymorphicTraverser interfaces fields
|
||||||
|
in collect traverser typeName element foundTypes
|
||||||
|
polymorphicTraverser interfaces fields
|
||||||
|
= flip (foldr visitFields) fields
|
||||||
|
. flip (foldr traverseInterfaceType) interfaces
|
||||||
|
extractObjectField (Out.Resolver field _) = field
|
@ -1,4 +1,4 @@
|
|||||||
resolver: lts-14.16
|
resolver: lts-16.1
|
||||||
|
|
||||||
packages:
|
packages:
|
||||||
- .
|
- .
|
||||||
|
@ -1,19 +1,133 @@
|
|||||||
{-# LANGUAGE OverloadedStrings #-}
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE QuasiQuotes #-}
|
||||||
module Language.GraphQL.AST.EncoderSpec
|
module Language.GraphQL.AST.EncoderSpec
|
||||||
( spec
|
( spec
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Language.GraphQL.AST (Value(..))
|
import Language.GraphQL.AST
|
||||||
import Language.GraphQL.AST.Encoder
|
import Language.GraphQL.AST.Encoder
|
||||||
import Test.Hspec ( Spec
|
import Test.Hspec (Spec, context, describe, it, shouldBe, shouldStartWith, shouldEndWith, shouldNotContain)
|
||||||
, describe
|
import Test.QuickCheck (choose, oneof, forAll)
|
||||||
, it
|
import Text.RawString.QQ (r)
|
||||||
, shouldBe
|
import Data.Text.Lazy (cons, toStrict, unpack)
|
||||||
)
|
|
||||||
|
|
||||||
spec :: Spec
|
spec :: Spec
|
||||||
spec = describe "value" $ do
|
spec = do
|
||||||
it "escapes \\" $
|
describe "value" $ do
|
||||||
value minified (String "\\") `shouldBe` "\"\\\\\""
|
context "null value" $ do
|
||||||
it "escapes quotes" $
|
let testNull formatter = value formatter Null `shouldBe` "null"
|
||||||
value minified (String "\"") `shouldBe` "\"\\\"\""
|
it "minified" $ testNull minified
|
||||||
|
it "pretty" $ testNull pretty
|
||||||
|
|
||||||
|
context "minified" $ do
|
||||||
|
it "escapes \\" $
|
||||||
|
value minified (String "\\") `shouldBe` "\"\\\\\""
|
||||||
|
it "escapes double quotes" $
|
||||||
|
value minified (String "\"") `shouldBe` "\"\\\"\""
|
||||||
|
it "escapes \\f" $
|
||||||
|
value minified (String "\f") `shouldBe` "\"\\f\""
|
||||||
|
it "escapes \\n" $
|
||||||
|
value minified (String "\n") `shouldBe` "\"\\n\""
|
||||||
|
it "escapes \\r" $
|
||||||
|
value minified (String "\r") `shouldBe` "\"\\r\""
|
||||||
|
it "escapes \\t" $
|
||||||
|
value minified (String "\t") `shouldBe` "\"\\t\""
|
||||||
|
it "escapes backspace" $
|
||||||
|
value minified (String "a\bc") `shouldBe` "\"a\\bc\""
|
||||||
|
context "escapes Unicode for chars less than 0010" $ do
|
||||||
|
it "Null" $ value minified (String "\x0000") `shouldBe` "\"\\u0000\""
|
||||||
|
it "bell" $ value minified (String "\x0007") `shouldBe` "\"\\u0007\""
|
||||||
|
context "escapes Unicode for char less than 0020" $ do
|
||||||
|
it "DLE" $ value minified (String "\x0010") `shouldBe` "\"\\u0010\""
|
||||||
|
it "EM" $ value minified (String "\x0019") `shouldBe` "\"\\u0019\""
|
||||||
|
context "encodes without escape" $ do
|
||||||
|
it "space" $ value minified (String "\x0020") `shouldBe` "\" \""
|
||||||
|
it "~" $ value minified (String "\x007E") `shouldBe` "\"~\""
|
||||||
|
|
||||||
|
context "pretty" $ do
|
||||||
|
it "uses strings for short string values" $
|
||||||
|
value pretty (String "Short text") `shouldBe` "\"Short text\""
|
||||||
|
it "uses block strings for text with new lines, with newline symbol" $
|
||||||
|
value pretty (String "Line 1\nLine 2")
|
||||||
|
`shouldBe` [r|"""
|
||||||
|
Line 1
|
||||||
|
Line 2
|
||||||
|
"""|]
|
||||||
|
it "uses block strings for text with new lines, with CR symbol" $
|
||||||
|
value pretty (String "Line 1\rLine 2")
|
||||||
|
`shouldBe` [r|"""
|
||||||
|
Line 1
|
||||||
|
Line 2
|
||||||
|
"""|]
|
||||||
|
it "uses block strings for text with new lines, with CR symbol followed by newline" $
|
||||||
|
value pretty (String "Line 1\r\nLine 2")
|
||||||
|
`shouldBe` [r|"""
|
||||||
|
Line 1
|
||||||
|
Line 2
|
||||||
|
"""|]
|
||||||
|
it "encodes as one line string if has escaped symbols" $ do
|
||||||
|
let
|
||||||
|
genNotAllowedSymbol = oneof
|
||||||
|
[ choose ('\x0000', '\x0008')
|
||||||
|
, choose ('\x000B', '\x000C')
|
||||||
|
, choose ('\x000E', '\x001F')
|
||||||
|
, pure '\x007F'
|
||||||
|
]
|
||||||
|
|
||||||
|
forAll genNotAllowedSymbol $ \x -> do
|
||||||
|
let
|
||||||
|
rawValue = "Short \n" <> cons x "text"
|
||||||
|
encoded = value pretty (String $ toStrict rawValue)
|
||||||
|
shouldStartWith (unpack encoded) "\""
|
||||||
|
shouldEndWith (unpack encoded) "\""
|
||||||
|
shouldNotContain (unpack encoded) "\"\"\""
|
||||||
|
|
||||||
|
it "Hello world" $ value pretty (String "Hello,\n World!\n\nYours,\n GraphQL.")
|
||||||
|
`shouldBe` [r|"""
|
||||||
|
Hello,
|
||||||
|
World!
|
||||||
|
|
||||||
|
Yours,
|
||||||
|
GraphQL.
|
||||||
|
"""|]
|
||||||
|
|
||||||
|
it "has only newlines" $ value pretty (String "\n") `shouldBe` [r|"""
|
||||||
|
|
||||||
|
|
||||||
|
"""|]
|
||||||
|
it "has newlines and one symbol at the begining" $
|
||||||
|
value pretty (String "a\n\n") `shouldBe` [r|"""
|
||||||
|
a
|
||||||
|
|
||||||
|
|
||||||
|
"""|]
|
||||||
|
it "has newlines and one symbol at the end" $
|
||||||
|
value pretty (String "\n\na") `shouldBe` [r|"""
|
||||||
|
|
||||||
|
|
||||||
|
a
|
||||||
|
"""|]
|
||||||
|
it "has newlines and one symbol in the middle" $
|
||||||
|
value pretty (String "\na\n") `shouldBe` [r|"""
|
||||||
|
|
||||||
|
a
|
||||||
|
|
||||||
|
"""|]
|
||||||
|
it "skip trailing whitespaces" $ value pretty (String " Short\ntext ")
|
||||||
|
`shouldBe` [r|"""
|
||||||
|
Short
|
||||||
|
text
|
||||||
|
"""|]
|
||||||
|
|
||||||
|
describe "definition" $
|
||||||
|
it "indents block strings in arguments" $
|
||||||
|
let arguments = [Argument "message" (String "line1\nline2")]
|
||||||
|
field = Field Nothing "field" arguments [] []
|
||||||
|
operation = DefinitionOperation $ SelectionSet $ pure field
|
||||||
|
in definition pretty operation `shouldBe` [r|{
|
||||||
|
field(message: """
|
||||||
|
line1
|
||||||
|
line2
|
||||||
|
""")
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
@ -8,7 +8,7 @@ import Data.Text (Text)
|
|||||||
import Data.Void (Void)
|
import Data.Void (Void)
|
||||||
import Language.GraphQL.AST.Lexer
|
import Language.GraphQL.AST.Lexer
|
||||||
import Test.Hspec (Spec, context, describe, it)
|
import Test.Hspec (Spec, context, describe, it)
|
||||||
import Test.Hspec.Megaparsec (shouldParse, shouldSucceedOn)
|
import Test.Hspec.Megaparsec (shouldParse, shouldFailOn, shouldSucceedOn)
|
||||||
import Text.Megaparsec (ParseErrorBundle, parse)
|
import Text.Megaparsec (ParseErrorBundle, parse)
|
||||||
import Text.RawString.QQ (r)
|
import Text.RawString.QQ (r)
|
||||||
|
|
||||||
@ -77,7 +77,7 @@ spec = describe "Lexer" $ do
|
|||||||
parse spread "" "..." `shouldParse` "..."
|
parse spread "" "..." `shouldParse` "..."
|
||||||
parse colon "" ":" `shouldParse` ":"
|
parse colon "" ":" `shouldParse` ":"
|
||||||
parse equals "" "=" `shouldParse` "="
|
parse equals "" "=" `shouldParse` "="
|
||||||
parse at "" "@" `shouldParse` '@'
|
parse at "" "@" `shouldParse` "@"
|
||||||
runBetween brackets `shouldSucceedOn` "[]"
|
runBetween brackets `shouldSucceedOn` "[]"
|
||||||
runBetween braces `shouldSucceedOn` "{}"
|
runBetween braces `shouldSucceedOn` "{}"
|
||||||
parse pipe "" "|" `shouldParse` "|"
|
parse pipe "" "|" `shouldParse` "|"
|
||||||
@ -87,6 +87,13 @@ spec = describe "Lexer" $ do
|
|||||||
parse blockString "" [r|""""""|] `shouldParse` ""
|
parse blockString "" [r|""""""|] `shouldParse` ""
|
||||||
it "lexes ampersand" $
|
it "lexes ampersand" $
|
||||||
parse amp "" "&" `shouldParse` "&"
|
parse amp "" "&" `shouldParse` "&"
|
||||||
|
it "lexes schema extensions" $
|
||||||
|
parseExtend "schema" `shouldSucceedOn` "extend schema"
|
||||||
|
it "fails if the given token doesn't match" $
|
||||||
|
parseExtend "schema" `shouldFailOn` "extend shema"
|
||||||
|
|
||||||
|
parseExtend :: Text -> (Text -> Either (ParseErrorBundle Text Void) ())
|
||||||
|
parseExtend extension = parse (extend extension "" $ pure $ pure ()) ""
|
||||||
|
|
||||||
runBetween :: (Parser () -> Parser ()) -> Text -> Either (ParseErrorBundle Text Void) ()
|
runBetween :: (Parser () -> Parser ()) -> Text -> Either (ParseErrorBundle Text Void) ()
|
||||||
runBetween parser = parse (parser $ pure ()) ""
|
runBetween parser = parse (parser $ pure ()) ""
|
||||||
|
@ -4,9 +4,11 @@ module Language.GraphQL.AST.ParserSpec
|
|||||||
( spec
|
( spec
|
||||||
) where
|
) where
|
||||||
|
|
||||||
|
import Data.List.NonEmpty (NonEmpty(..))
|
||||||
|
import Language.GraphQL.AST.Document
|
||||||
import Language.GraphQL.AST.Parser
|
import Language.GraphQL.AST.Parser
|
||||||
import Test.Hspec (Spec, describe, it)
|
import Test.Hspec (Spec, describe, it)
|
||||||
import Test.Hspec.Megaparsec (shouldSucceedOn)
|
import Test.Hspec.Megaparsec (shouldParse, shouldFailOn, shouldSucceedOn)
|
||||||
import Text.Megaparsec (parse)
|
import Text.Megaparsec (parse)
|
||||||
import Text.RawString.QQ (r)
|
import Text.RawString.QQ (r)
|
||||||
|
|
||||||
@ -28,5 +30,122 @@ spec = describe "Parser" $ do
|
|||||||
it "accepts two required arguments" $
|
it "accepts two required arguments" $
|
||||||
parse document "" `shouldSucceedOn` [r|
|
parse document "" `shouldSucceedOn` [r|
|
||||||
mutation auth($username: String!, $password: String!){
|
mutation auth($username: String!, $password: String!){
|
||||||
test
|
test
|
||||||
}|]
|
}|]
|
||||||
|
|
||||||
|
it "accepts two string arguments" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
mutation auth{
|
||||||
|
test(username: "username", password: "password")
|
||||||
|
}|]
|
||||||
|
|
||||||
|
it "accepts two block string arguments" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
mutation auth{
|
||||||
|
test(username: """username""", password: """password""")
|
||||||
|
}|]
|
||||||
|
|
||||||
|
it "parses minimal schema definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|schema { query: Query }|]
|
||||||
|
|
||||||
|
it "parses minimal scalar definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|scalar Time|]
|
||||||
|
|
||||||
|
it "parses ImplementsInterfaces" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
type Person implements NamedEntity & ValuedEntity {
|
||||||
|
name: String
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses a type without ImplementsInterfaces" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
type Person {
|
||||||
|
name: String
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses ArgumentsDefinition in an ObjectDefinition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
type Person {
|
||||||
|
name(first: String, last: String): String
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal union type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
union SearchResult = Photo | Person
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal interface type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
interface NamedEntity {
|
||||||
|
name: String
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal enum type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
enum Direction {
|
||||||
|
NORTH
|
||||||
|
EAST
|
||||||
|
SOUTH
|
||||||
|
WEST
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal enum type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
enum Direction {
|
||||||
|
NORTH
|
||||||
|
EAST
|
||||||
|
SOUTH
|
||||||
|
WEST
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal input object type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
input Point2D {
|
||||||
|
x: Float
|
||||||
|
y: Float
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses minimal input enum definition with an optional pipe" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
directive @example on
|
||||||
|
| FIELD
|
||||||
|
| FRAGMENT_SPREAD
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses schema extension with a new directive" $
|
||||||
|
parse document "" `shouldSucceedOn`[r|
|
||||||
|
extend schema @newDirective
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "parses schema extension with an operation type definition" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|extend schema { query: Query }|]
|
||||||
|
|
||||||
|
it "parses schema extension with an operation type and directive" $
|
||||||
|
let newDirective = Directive "newDirective" []
|
||||||
|
testSchemaExtension = TypeSystemExtension
|
||||||
|
$ SchemaExtension
|
||||||
|
$ SchemaOperationExtension [newDirective]
|
||||||
|
$ OperationTypeDefinition Query "Query" :| []
|
||||||
|
query = [r|extend schema @newDirective { query: Query }|]
|
||||||
|
in parse document "" query `shouldParse` (testSchemaExtension :| [])
|
||||||
|
|
||||||
|
it "parses an object extension" $
|
||||||
|
parse document "" `shouldSucceedOn` [r|
|
||||||
|
extend type Story {
|
||||||
|
isHiddenLocally: Boolean
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
it "rejects variables in DefaultValue" $
|
||||||
|
parse document "" `shouldFailOn` [r|
|
||||||
|
query ($book: String = "Zarathustra", $author: String = $book) {
|
||||||
|
title
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
122
tests/Language/GraphQL/Execute/CoerceSpec.hs
Normal file
122
tests/Language/GraphQL/Execute/CoerceSpec.hs
Normal file
@ -0,0 +1,122 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
module Language.GraphQL.Execute.CoerceSpec
|
||||||
|
( spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Aeson as Aeson ((.=))
|
||||||
|
import qualified Data.Aeson as Aeson
|
||||||
|
import qualified Data.Aeson.Types as Aeson
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Data.Maybe (isNothing)
|
||||||
|
import Data.Scientific (scientific)
|
||||||
|
import qualified Language.GraphQL.Execute.Coerce as Coerce
|
||||||
|
import Language.GraphQL.Type
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import Prelude hiding (id)
|
||||||
|
import Test.Hspec (Spec, describe, it, shouldBe, shouldSatisfy)
|
||||||
|
|
||||||
|
direction :: EnumType
|
||||||
|
direction = EnumType "Direction" Nothing $ HashMap.fromList
|
||||||
|
[ ("NORTH", EnumValue Nothing)
|
||||||
|
, ("EAST", EnumValue Nothing)
|
||||||
|
, ("SOUTH", EnumValue Nothing)
|
||||||
|
, ("WEST", EnumValue Nothing)
|
||||||
|
]
|
||||||
|
|
||||||
|
singletonInputObject :: In.Type
|
||||||
|
singletonInputObject = In.NamedInputObjectType type'
|
||||||
|
where
|
||||||
|
type' = In.InputObjectType "ObjectName" Nothing inputFields
|
||||||
|
inputFields = HashMap.singleton "field" field
|
||||||
|
field = In.InputField Nothing (In.NamedScalarType string) Nothing
|
||||||
|
|
||||||
|
namedIdType :: In.Type
|
||||||
|
namedIdType = In.NamedScalarType id
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec = do
|
||||||
|
describe "VariableValue Aeson" $ do
|
||||||
|
it "coerces strings" $
|
||||||
|
let expected = Just (String "asdf")
|
||||||
|
actual = Coerce.coerceVariableValue
|
||||||
|
(In.NamedScalarType string) (Aeson.String "asdf")
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces non-null strings" $
|
||||||
|
let expected = Just (String "asdf")
|
||||||
|
actual = Coerce.coerceVariableValue
|
||||||
|
(In.NonNullScalarType string) (Aeson.String "asdf")
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces booleans" $
|
||||||
|
let expected = Just (Boolean True)
|
||||||
|
actual = Coerce.coerceVariableValue
|
||||||
|
(In.NamedScalarType boolean) (Aeson.Bool True)
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces zero to an integer" $
|
||||||
|
let expected = Just (Int 0)
|
||||||
|
actual = Coerce.coerceVariableValue
|
||||||
|
(In.NamedScalarType int) (Aeson.Number 0)
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "rejects fractional if an integer is expected" $
|
||||||
|
let actual = Coerce.coerceVariableValue
|
||||||
|
(In.NamedScalarType int) (Aeson.Number $ scientific 14 (-1))
|
||||||
|
in actual `shouldSatisfy` isNothing
|
||||||
|
it "coerces float numbers" $
|
||||||
|
let expected = Just (Float 1.4)
|
||||||
|
actual = Coerce.coerceVariableValue
|
||||||
|
(In.NamedScalarType float) (Aeson.Number $ scientific 14 (-1))
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces IDs" $
|
||||||
|
let expected = Just (String "1234")
|
||||||
|
json = Aeson.String "1234"
|
||||||
|
actual = Coerce.coerceVariableValue namedIdType json
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces input objects" $
|
||||||
|
let actual = Coerce.coerceVariableValue singletonInputObject
|
||||||
|
$ Aeson.object ["field" .= ("asdf" :: Aeson.Value)]
|
||||||
|
expected = Just $ Object $ HashMap.singleton "field" "asdf"
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "skips the field if it is missing in the variables" $
|
||||||
|
let actual = Coerce.coerceVariableValue
|
||||||
|
singletonInputObject Aeson.emptyObject
|
||||||
|
expected = Just $ Object HashMap.empty
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "fails if input object value contains extra fields" $
|
||||||
|
let actual = Coerce.coerceVariableValue singletonInputObject
|
||||||
|
$ Aeson.object variableFields
|
||||||
|
variableFields =
|
||||||
|
[ "field" .= ("asdf" :: Aeson.Value)
|
||||||
|
, "extra" .= ("qwer" :: Aeson.Value)
|
||||||
|
]
|
||||||
|
in actual `shouldSatisfy` isNothing
|
||||||
|
it "preserves null" $
|
||||||
|
let actual = Coerce.coerceVariableValue namedIdType Aeson.Null
|
||||||
|
in actual `shouldBe` Just Null
|
||||||
|
it "preserves list order" $
|
||||||
|
let list = Aeson.toJSONList ["asdf" :: Aeson.Value, "qwer"]
|
||||||
|
listType = (In.ListType $ In.NamedScalarType string)
|
||||||
|
actual = Coerce.coerceVariableValue listType list
|
||||||
|
expected = Just $ List [String "asdf", String "qwer"]
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
|
||||||
|
describe "coerceInputLiteral" $ do
|
||||||
|
it "coerces enums" $
|
||||||
|
let expected = Just (Enum "NORTH")
|
||||||
|
actual = Coerce.coerceInputLiteral
|
||||||
|
(In.NamedEnumType direction) (Enum "NORTH")
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "fails with non-existing enum value" $
|
||||||
|
let actual = Coerce.coerceInputLiteral
|
||||||
|
(In.NamedEnumType direction) (Enum "NORTH_EAST")
|
||||||
|
in actual `shouldSatisfy` isNothing
|
||||||
|
it "coerces integers to IDs" $
|
||||||
|
let expected = Just (String "1234")
|
||||||
|
actual = Coerce.coerceInputLiteral namedIdType (Int 1234)
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "coerces nulls" $ do
|
||||||
|
let actual = Coerce.coerceInputLiteral namedIdType Null
|
||||||
|
in actual `shouldBe` Just Null
|
||||||
|
it "wraps singleton lists" $ do
|
||||||
|
let expected = Just $ List [List [String "1"]]
|
||||||
|
embeddedType = In.ListType $ In.ListType namedIdType
|
||||||
|
actual = Coerce.coerceInputLiteral embeddedType (String "1")
|
||||||
|
in actual `shouldBe` expected
|
75
tests/Language/GraphQL/ExecuteSpec.hs
Normal file
75
tests/Language/GraphQL/ExecuteSpec.hs
Normal file
@ -0,0 +1,75 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
module Language.GraphQL.ExecuteSpec
|
||||||
|
( spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Aeson ((.=))
|
||||||
|
import qualified Data.Aeson as Aeson
|
||||||
|
import Data.Functor.Identity (Identity(..))
|
||||||
|
import Data.HashMap.Strict (HashMap)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Language.GraphQL.AST (Name)
|
||||||
|
import Language.GraphQL.AST.Parser (document)
|
||||||
|
import Language.GraphQL.Error
|
||||||
|
import Language.GraphQL.Execute
|
||||||
|
import Language.GraphQL.Type as Type
|
||||||
|
import Language.GraphQL.Type.Out as Out
|
||||||
|
import Test.Hspec (Spec, describe, it, shouldBe)
|
||||||
|
import Text.Megaparsec (parse)
|
||||||
|
|
||||||
|
schema :: Schema Identity
|
||||||
|
schema = Schema {query = queryType, mutation = Nothing}
|
||||||
|
|
||||||
|
queryType :: Out.ObjectType Identity
|
||||||
|
queryType = Out.ObjectType "Query" Nothing []
|
||||||
|
$ HashMap.singleton "philosopher"
|
||||||
|
$ Out.Resolver philosopherField
|
||||||
|
$ pure
|
||||||
|
$ Type.Object mempty
|
||||||
|
where
|
||||||
|
philosopherField =
|
||||||
|
Out.Field Nothing (Out.NonNullObjectType philosopherType) HashMap.empty
|
||||||
|
|
||||||
|
philosopherType :: Out.ObjectType Identity
|
||||||
|
philosopherType = Out.ObjectType "Philosopher" Nothing []
|
||||||
|
$ HashMap.fromList resolvers
|
||||||
|
where
|
||||||
|
resolvers =
|
||||||
|
[ ("firstName", firstNameResolver)
|
||||||
|
, ("lastName", lastNameResolver)
|
||||||
|
]
|
||||||
|
firstNameResolver = Out.Resolver firstNameField $ pure $ Type.String "Friedrich"
|
||||||
|
lastNameResolver = Out.Resolver lastNameField $ pure $ Type.String "Nietzsche"
|
||||||
|
firstNameField = Out.Field Nothing (Out.NonNullScalarType string) HashMap.empty
|
||||||
|
lastNameField = Out.Field Nothing (Out.NonNullScalarType string) HashMap.empty
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec =
|
||||||
|
describe "execute" $ do
|
||||||
|
it "skips unknown fields" $
|
||||||
|
let expected = Aeson.object
|
||||||
|
[ "data" .= Aeson.object
|
||||||
|
[ "philosopher" .= Aeson.object
|
||||||
|
[ "firstName" .= ("Friedrich" :: String)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
execute' = execute schema (mempty :: HashMap Name Aeson.Value)
|
||||||
|
actual = runIdentity
|
||||||
|
$ either parseError execute'
|
||||||
|
$ parse document "" "{ philosopher { firstName surname } }"
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
it "merges selections" $
|
||||||
|
let expected = Aeson.object
|
||||||
|
[ "data" .= Aeson.object
|
||||||
|
[ "philosopher" .= Aeson.object
|
||||||
|
[ "firstName" .= ("Friedrich" :: String)
|
||||||
|
, "lastName" .= ("Nietzsche" :: String)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
execute' = execute schema (mempty :: HashMap Name Aeson.Value)
|
||||||
|
actual = runIdentity
|
||||||
|
$ either parseError execute'
|
||||||
|
$ parse document "" "{ philosopher { firstName } philosopher { lastName } }"
|
||||||
|
in actual `shouldBe` expected
|
14
tests/Language/GraphQL/Type/OutSpec.hs
Normal file
14
tests/Language/GraphQL/Type/OutSpec.hs
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
module Language.GraphQL.Type.OutSpec
|
||||||
|
( spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Language.GraphQL.Type
|
||||||
|
import Test.Hspec (Spec, describe, it, shouldBe)
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec =
|
||||||
|
describe "Value" $
|
||||||
|
it "supports overloaded strings" $
|
||||||
|
let nietzsche = "Goldstaub abblasen." :: Value
|
||||||
|
in nietzsche `shouldBe` String "Goldstaub abblasen."
|
91
tests/Test/DirectiveSpec.hs
Normal file
91
tests/Test/DirectiveSpec.hs
Normal file
@ -0,0 +1,91 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE QuasiQuotes #-}
|
||||||
|
module Test.DirectiveSpec
|
||||||
|
( spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Aeson (object, (.=))
|
||||||
|
import qualified Data.Aeson as Aeson
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Language.GraphQL
|
||||||
|
import Language.GraphQL.Type
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
import Test.Hspec (Spec, describe, it, shouldBe)
|
||||||
|
import Text.RawString.QQ (r)
|
||||||
|
|
||||||
|
experimentalResolver :: Schema IO
|
||||||
|
experimentalResolver = Schema { query = queryType, mutation = Nothing }
|
||||||
|
where
|
||||||
|
resolver = pure $ Int 5
|
||||||
|
queryType = Out.ObjectType "Query" Nothing []
|
||||||
|
$ HashMap.singleton "experimentalField"
|
||||||
|
$ Out.Resolver (Out.Field Nothing (Out.NamedScalarType int) mempty) resolver
|
||||||
|
|
||||||
|
emptyObject :: Aeson.Value
|
||||||
|
emptyObject = object
|
||||||
|
[ "data" .= object []
|
||||||
|
]
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec =
|
||||||
|
describe "Directive executor" $ do
|
||||||
|
it "should be able to @skip fields" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
experimentalField @skip(if: true)
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql experimentalResolver sourceQuery
|
||||||
|
actual `shouldBe` emptyObject
|
||||||
|
|
||||||
|
it "should not skip fields if @skip is false" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
experimentalField @skip(if: false)
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "experimentalField" .= (5 :: Int)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
|
||||||
|
actual <- graphql experimentalResolver sourceQuery
|
||||||
|
actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "should skip fields if @include is false" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
experimentalField @include(if: false)
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql experimentalResolver sourceQuery
|
||||||
|
actual `shouldBe` emptyObject
|
||||||
|
|
||||||
|
it "should be able to @skip a fragment spread" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
...experimentalFragment @skip(if: true)
|
||||||
|
}
|
||||||
|
|
||||||
|
fragment experimentalFragment on ExperimentalType {
|
||||||
|
experimentalField
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql experimentalResolver sourceQuery
|
||||||
|
actual `shouldBe` emptyObject
|
||||||
|
|
||||||
|
it "should be able to @skip an inline fragment" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
... on ExperimentalType @skip(if: true) {
|
||||||
|
experimentalField
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql experimentalResolver sourceQuery
|
||||||
|
actual `shouldBe` emptyObject
|
@ -4,32 +4,35 @@ module Test.FragmentSpec
|
|||||||
( spec
|
( spec
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Data.Aeson (Value(..), object, (.=))
|
import Data.Aeson (object, (.=))
|
||||||
|
import qualified Data.Aeson as Aeson
|
||||||
import qualified Data.HashMap.Strict as HashMap
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
import Data.List.NonEmpty (NonEmpty(..))
|
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import Language.GraphQL
|
import Language.GraphQL
|
||||||
import qualified Language.GraphQL.Schema as Schema
|
import Language.GraphQL.Type
|
||||||
import Test.Hspec ( Spec
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
, describe
|
import Test.Hspec
|
||||||
, it
|
( Spec
|
||||||
, shouldBe
|
, describe
|
||||||
, shouldSatisfy
|
, it
|
||||||
, shouldNotSatisfy
|
, shouldBe
|
||||||
)
|
, shouldNotSatisfy
|
||||||
|
)
|
||||||
import Text.RawString.QQ (r)
|
import Text.RawString.QQ (r)
|
||||||
|
|
||||||
size :: Schema.Resolver IO
|
size :: (Text, Value)
|
||||||
size = Schema.scalar "size" $ return ("L" :: Text)
|
size = ("size", String "L")
|
||||||
|
|
||||||
circumference :: Schema.Resolver IO
|
circumference :: (Text, Value)
|
||||||
circumference = Schema.scalar "circumference" $ return (60 :: Int)
|
circumference = ("circumference", Int 60)
|
||||||
|
|
||||||
garment :: Text -> Schema.Resolver IO
|
garment :: Text -> (Text, Value)
|
||||||
garment typeName = Schema.object "garment" $ return
|
garment typeName =
|
||||||
[ if typeName == "Hat" then circumference else size
|
("garment", Object $ HashMap.fromList
|
||||||
, Schema.scalar "__typename" $ return typeName
|
[ if typeName == "Hat" then circumference else size
|
||||||
]
|
, ("__typename", String typeName)
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
inlineQuery :: Text
|
inlineQuery :: Text
|
||||||
inlineQuery = [r|{
|
inlineQuery = [r|{
|
||||||
@ -43,122 +46,189 @@ inlineQuery = [r|{
|
|||||||
}
|
}
|
||||||
}|]
|
}|]
|
||||||
|
|
||||||
hasErrors :: Value -> Bool
|
hasErrors :: Aeson.Value -> Bool
|
||||||
hasErrors (Object object') = HashMap.member "errors" object'
|
hasErrors (Aeson.Object object') = HashMap.member "errors" object'
|
||||||
hasErrors _ = True
|
hasErrors _ = True
|
||||||
|
|
||||||
|
shirtType :: Out.ObjectType IO
|
||||||
|
shirtType = Out.ObjectType "Shirt" Nothing []
|
||||||
|
$ HashMap.fromList
|
||||||
|
[ ("size", Out.Resolver sizeFieldType $ pure $ snd size)
|
||||||
|
, ("circumference", Out.Resolver circumferenceFieldType $ pure $ snd circumference)
|
||||||
|
]
|
||||||
|
|
||||||
|
hatType :: Out.ObjectType IO
|
||||||
|
hatType = Out.ObjectType "Hat" Nothing []
|
||||||
|
$ HashMap.fromList
|
||||||
|
[ ("size", Out.Resolver sizeFieldType $ pure $ snd size)
|
||||||
|
, ("circumference", Out.Resolver circumferenceFieldType $ pure $ snd circumference)
|
||||||
|
]
|
||||||
|
|
||||||
|
circumferenceFieldType :: Out.Field IO
|
||||||
|
circumferenceFieldType = Out.Field Nothing (Out.NamedScalarType int) mempty
|
||||||
|
|
||||||
|
sizeFieldType :: Out.Field IO
|
||||||
|
sizeFieldType = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
|
|
||||||
|
toSchema :: Text -> (Text, Value) -> Schema IO
|
||||||
|
toSchema t (_, resolve) = Schema
|
||||||
|
{ query = queryType, mutation = Nothing }
|
||||||
|
where
|
||||||
|
unionMember = if t == "Hat" then hatType else shirtType
|
||||||
|
typeNameField = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
|
garmentField = Out.Field Nothing (Out.NamedObjectType unionMember) mempty
|
||||||
|
queryType =
|
||||||
|
case t of
|
||||||
|
"circumference" -> hatType
|
||||||
|
"size" -> shirtType
|
||||||
|
_ -> Out.ObjectType "Query" Nothing []
|
||||||
|
$ HashMap.fromList
|
||||||
|
[ ("garment", Out.Resolver garmentField $ pure resolve)
|
||||||
|
, ("__typename", Out.Resolver typeNameField $ pure $ String "Shirt")
|
||||||
|
]
|
||||||
|
|
||||||
spec :: Spec
|
spec :: Spec
|
||||||
spec = describe "Inline fragment executor" $ do
|
spec = do
|
||||||
it "chooses the first selection if the type matches" $ do
|
describe "Inline fragment executor" $ do
|
||||||
actual <- graphql (garment "Hat" :| []) inlineQuery
|
it "chooses the first selection if the type matches" $ do
|
||||||
let expected = object
|
actual <- graphql (toSchema "Hat" $ garment "Hat") inlineQuery
|
||||||
[ "data" .= object
|
let expected = object
|
||||||
[ "garment" .= object
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "circumference" .= (60 :: Int)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "chooses the last selection if the type matches" $ do
|
||||||
|
actual <- graphql (toSchema "Shirt" $ garment "Shirt") inlineQuery
|
||||||
|
let expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "size" .= ("L" :: Text)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "embeds inline fragments without type" $ do
|
||||||
|
let sourceQuery = [r|{
|
||||||
|
garment {
|
||||||
|
circumference
|
||||||
|
... {
|
||||||
|
size
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}|]
|
||||||
|
resolvers = ("garment", Object $ HashMap.fromList [circumference, size])
|
||||||
|
|
||||||
|
actual <- graphql (toSchema "garment" resolvers) sourceQuery
|
||||||
|
let expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "circumference" .= (60 :: Int)
|
||||||
|
, "size" .= ("L" :: Text)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
in actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "evaluates fragments on Query" $ do
|
||||||
|
let sourceQuery = [r|{
|
||||||
|
... {
|
||||||
|
size
|
||||||
|
}
|
||||||
|
}|]
|
||||||
|
|
||||||
|
actual <- graphql (toSchema "size" size) sourceQuery
|
||||||
|
actual `shouldNotSatisfy` hasErrors
|
||||||
|
|
||||||
|
describe "Fragment spread executor" $ do
|
||||||
|
it "evaluates fragment spreads" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
...circumferenceFragment
|
||||||
|
}
|
||||||
|
|
||||||
|
fragment circumferenceFragment on Hat {
|
||||||
|
circumference
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql (toSchema "circumference" circumference) sourceQuery
|
||||||
|
let expected = object
|
||||||
|
[ "data" .= object
|
||||||
[ "circumference" .= (60 :: Int)
|
[ "circumference" .= (60 :: Int)
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]
|
in actual `shouldBe` expected
|
||||||
in actual `shouldBe` expected
|
|
||||||
|
|
||||||
it "chooses the last selection if the type matches" $ do
|
it "evaluates nested fragments" $ do
|
||||||
actual <- graphql (garment "Shirt" :| []) inlineQuery
|
let sourceQuery = [r|
|
||||||
let expected = object
|
{
|
||||||
[ "data" .= object
|
garment {
|
||||||
[ "garment" .= object
|
...circumferenceFragment
|
||||||
[ "size" .= ("L" :: Text)
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fragment circumferenceFragment on Hat {
|
||||||
|
...hatFragment
|
||||||
|
}
|
||||||
|
|
||||||
|
fragment hatFragment on Hat {
|
||||||
|
circumference
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
|
||||||
|
actual <- graphql (toSchema "Hat" $ garment "Hat") sourceQuery
|
||||||
|
let expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "circumference" .= (60 :: Int)
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]
|
in actual `shouldBe` expected
|
||||||
in actual `shouldBe` expected
|
|
||||||
|
|
||||||
it "embeds inline fragments without type" $ do
|
it "rejects recursive fragments" $ do
|
||||||
let query = [r|{
|
let expected = object
|
||||||
garment {
|
[ "data" .= object []
|
||||||
circumference
|
]
|
||||||
... {
|
sourceQuery = [r|
|
||||||
size
|
{
|
||||||
}
|
...circumferenceFragment
|
||||||
}
|
}
|
||||||
}|]
|
|
||||||
resolvers = Schema.object "garment" $ return [circumference, size]
|
|
||||||
|
|
||||||
actual <- graphql (resolvers :| []) query
|
fragment circumferenceFragment on Hat {
|
||||||
let expected = object
|
...circumferenceFragment
|
||||||
[ "data" .= object
|
}
|
||||||
[ "garment" .= object
|
|]
|
||||||
[ "circumference" .= (60 :: Int)
|
|
||||||
, "size" .= ("L" :: Text)
|
actual <- graphql (toSchema "circumference" circumference) sourceQuery
|
||||||
|
actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "considers type condition" $ do
|
||||||
|
let sourceQuery = [r|
|
||||||
|
{
|
||||||
|
garment {
|
||||||
|
...circumferenceFragment
|
||||||
|
...sizeFragment
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fragment circumferenceFragment on Hat {
|
||||||
|
circumference
|
||||||
|
}
|
||||||
|
fragment sizeFragment on Shirt {
|
||||||
|
size
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "circumference" .= (60 :: Int)
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]
|
actual <- graphql (toSchema "Hat" $ garment "Hat") sourceQuery
|
||||||
in actual `shouldBe` expected
|
actual `shouldBe` expected
|
||||||
|
|
||||||
it "evaluates fragments on Query" $ do
|
|
||||||
let query = [r|{
|
|
||||||
... {
|
|
||||||
size
|
|
||||||
}
|
|
||||||
}|]
|
|
||||||
|
|
||||||
actual <- graphql (size :| []) query
|
|
||||||
actual `shouldNotSatisfy` hasErrors
|
|
||||||
|
|
||||||
it "evaluates nested fragments" $ do
|
|
||||||
let query = [r|
|
|
||||||
{
|
|
||||||
...circumferenceFragment
|
|
||||||
}
|
|
||||||
|
|
||||||
fragment circumferenceFragment on Hat {
|
|
||||||
circumference
|
|
||||||
}
|
|
||||||
|
|
||||||
fragment hatFragment on Hat {
|
|
||||||
...circumferenceFragment
|
|
||||||
}
|
|
||||||
|]
|
|
||||||
|
|
||||||
actual <- graphql (circumference :| []) query
|
|
||||||
let expected = object
|
|
||||||
[ "data" .= object
|
|
||||||
[ "circumference" .= (60 :: Int)
|
|
||||||
]
|
|
||||||
]
|
|
||||||
in actual `shouldBe` expected
|
|
||||||
|
|
||||||
it "evaluates fragments defined in any order" $ do
|
|
||||||
let query = [r|
|
|
||||||
{
|
|
||||||
...circumferenceFragment
|
|
||||||
}
|
|
||||||
|
|
||||||
fragment circumferenceFragment on Hat {
|
|
||||||
...hatFragment
|
|
||||||
}
|
|
||||||
|
|
||||||
fragment hatFragment on Hat {
|
|
||||||
circumference
|
|
||||||
}
|
|
||||||
|]
|
|
||||||
|
|
||||||
actual <- graphql (circumference :| []) query
|
|
||||||
let expected = object
|
|
||||||
[ "data" .= object
|
|
||||||
[ "circumference" .= (60 :: Int)
|
|
||||||
]
|
|
||||||
]
|
|
||||||
in actual `shouldBe` expected
|
|
||||||
|
|
||||||
it "rejects recursive" $ do
|
|
||||||
let query = [r|
|
|
||||||
{
|
|
||||||
...circumferenceFragment
|
|
||||||
}
|
|
||||||
|
|
||||||
fragment circumferenceFragment on Hat {
|
|
||||||
...circumferenceFragment
|
|
||||||
}
|
|
||||||
|]
|
|
||||||
|
|
||||||
actual <- graphql (circumference :| []) query
|
|
||||||
actual `shouldSatisfy` hasErrors
|
|
||||||
|
68
tests/Test/RootOperationSpec.hs
Normal file
68
tests/Test/RootOperationSpec.hs
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE QuasiQuotes #-}
|
||||||
|
module Test.RootOperationSpec
|
||||||
|
( spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Data.Aeson ((.=), object)
|
||||||
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
|
import Language.GraphQL
|
||||||
|
import Test.Hspec (Spec, describe, it, shouldBe)
|
||||||
|
import Text.RawString.QQ (r)
|
||||||
|
import Language.GraphQL.Type
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
|
|
||||||
|
hatType :: Out.ObjectType IO
|
||||||
|
hatType = Out.ObjectType "Hat" Nothing []
|
||||||
|
$ HashMap.singleton "circumference"
|
||||||
|
$ Out.Resolver (Out.Field Nothing (Out.NamedScalarType int) mempty)
|
||||||
|
$ pure $ Int 60
|
||||||
|
|
||||||
|
schema :: Schema IO
|
||||||
|
schema = Schema
|
||||||
|
(Out.ObjectType "Query" Nothing [] hatField)
|
||||||
|
(Just $ Out.ObjectType "Mutation" Nothing [] incrementField)
|
||||||
|
where
|
||||||
|
garment = pure $ Object $ HashMap.fromList
|
||||||
|
[ ("circumference", Int 60)
|
||||||
|
]
|
||||||
|
incrementField = HashMap.singleton "incrementCircumference"
|
||||||
|
$ Out.Resolver (Out.Field Nothing (Out.NamedScalarType int) mempty)
|
||||||
|
$ pure $ Int 61
|
||||||
|
hatField = HashMap.singleton "garment"
|
||||||
|
$ Out.Resolver (Out.Field Nothing (Out.NamedObjectType hatType) mempty) garment
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec =
|
||||||
|
describe "Root operation type" $ do
|
||||||
|
it "returns objects from the root resolvers" $ do
|
||||||
|
let querySource = [r|
|
||||||
|
{
|
||||||
|
garment {
|
||||||
|
circumference
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "garment" .= object
|
||||||
|
[ "circumference" .= (60 :: Int)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
]
|
||||||
|
actual <- graphql schema querySource
|
||||||
|
actual `shouldBe` expected
|
||||||
|
|
||||||
|
it "chooses Mutation" $ do
|
||||||
|
let querySource = [r|
|
||||||
|
mutation {
|
||||||
|
incrementCircumference
|
||||||
|
}
|
||||||
|
|]
|
||||||
|
expected = object
|
||||||
|
[ "data" .= object
|
||||||
|
[ "incrementCircumference" .= (61 :: Int)
|
||||||
|
]
|
||||||
|
]
|
||||||
|
actual <- graphql schema querySource
|
||||||
|
actual `shouldBe` expected
|
@ -8,25 +8,20 @@ module Test.StarWars.Data
|
|||||||
, getEpisode
|
, getEpisode
|
||||||
, getFriends
|
, getFriends
|
||||||
, getHero
|
, getHero
|
||||||
, getHeroIO
|
|
||||||
, getHuman
|
, getHuman
|
||||||
, id_
|
, id_
|
||||||
, homePlanet
|
, homePlanet
|
||||||
, name
|
, name_
|
||||||
, secretBackstory
|
, secretBackstory
|
||||||
, typeName
|
, typeName
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Data.Monoid (mempty)
|
import Data.Functor.Identity (Identity)
|
||||||
import Control.Applicative ( Alternative(..)
|
import Control.Applicative (Alternative(..), liftA2)
|
||||||
, liftA2
|
|
||||||
)
|
|
||||||
import Control.Monad.IO.Class (MonadIO(..))
|
|
||||||
import Control.Monad.Trans.Except (throwE)
|
import Control.Monad.Trans.Except (throwE)
|
||||||
import Data.Maybe (catMaybes)
|
import Data.Maybe (catMaybes)
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import Language.GraphQL.Trans
|
import Language.GraphQL.Trans
|
||||||
import qualified Language.GraphQL.Type as Type
|
|
||||||
|
|
||||||
-- * Data
|
-- * Data
|
||||||
-- See https://github.com/graphql/graphql-js/blob/master/src/__tests__/starWarsData.js
|
-- See https://github.com/graphql/graphql-js/blob/master/src/__tests__/starWarsData.js
|
||||||
@ -59,9 +54,9 @@ id_ :: Character -> ID
|
|||||||
id_ (Left x) = _id_ . _droidChar $ x
|
id_ (Left x) = _id_ . _droidChar $ x
|
||||||
id_ (Right x) = _id_ . _humanChar $ x
|
id_ (Right x) = _id_ . _humanChar $ x
|
||||||
|
|
||||||
name :: Character -> Text
|
name_ :: Character -> Text
|
||||||
name (Left x) = _name . _droidChar $ x
|
name_ (Left x) = _name . _droidChar $ x
|
||||||
name (Right x) = _name . _humanChar $ x
|
name_ (Right x) = _name . _humanChar $ x
|
||||||
|
|
||||||
friends :: Character -> [ID]
|
friends :: Character -> [ID]
|
||||||
friends (Left x) = _friends . _droidChar $ x
|
friends (Left x) = _friends . _droidChar $ x
|
||||||
@ -71,8 +66,8 @@ appearsIn :: Character -> [Int]
|
|||||||
appearsIn (Left x) = _appearsIn . _droidChar $ x
|
appearsIn (Left x) = _appearsIn . _droidChar $ x
|
||||||
appearsIn (Right x) = _appearsIn . _humanChar $ x
|
appearsIn (Right x) = _appearsIn . _humanChar $ x
|
||||||
|
|
||||||
secretBackstory :: MonadIO m => Character -> ActionT m Text
|
secretBackstory :: ActionT Identity Text
|
||||||
secretBackstory = const $ ActionT $ throwE "secretBackstory is secret."
|
secretBackstory = ActionT $ throwE "secretBackstory is secret."
|
||||||
|
|
||||||
typeName :: Character -> Text
|
typeName :: Character -> Text
|
||||||
typeName = either (const "Droid") (const "Human")
|
typeName = either (const "Droid") (const "Human")
|
||||||
@ -166,9 +161,6 @@ getHero :: Int -> Character
|
|||||||
getHero 5 = luke
|
getHero 5 = luke
|
||||||
getHero _ = artoo
|
getHero _ = artoo
|
||||||
|
|
||||||
getHeroIO :: Int -> IO Character
|
|
||||||
getHeroIO = pure . getHero
|
|
||||||
|
|
||||||
getHuman :: Alternative f => ID -> f Character
|
getHuman :: Alternative f => ID -> f Character
|
||||||
getHuman = fmap Right . getHuman'
|
getHuman = fmap Right . getHuman'
|
||||||
|
|
||||||
@ -191,8 +183,8 @@ getDroid' _ = empty
|
|||||||
getFriends :: Character -> [Character]
|
getFriends :: Character -> [Character]
|
||||||
getFriends char = catMaybes $ liftA2 (<|>) getDroid getHuman <$> friends char
|
getFriends char = catMaybes $ liftA2 (<|>) getDroid getHuman <$> friends char
|
||||||
|
|
||||||
getEpisode :: Int -> Maybe (Type.Wrapping Text)
|
getEpisode :: Int -> Maybe Text
|
||||||
getEpisode 4 = pure $ Type.Named "NEWHOPE"
|
getEpisode 4 = pure "NEW_HOPE"
|
||||||
getEpisode 5 = pure $ Type.Named "EMPIRE"
|
getEpisode 5 = pure "EMPIRE"
|
||||||
getEpisode 6 = pure $ Type.Named "JEDI"
|
getEpisode 6 = pure "JEDI"
|
||||||
getEpisode _ = empty
|
getEpisode _ = empty
|
||||||
|
@ -5,20 +5,14 @@ module Test.StarWars.QuerySpec
|
|||||||
) where
|
) where
|
||||||
|
|
||||||
import qualified Data.Aeson as Aeson
|
import qualified Data.Aeson as Aeson
|
||||||
import Data.Aeson ( object
|
import Data.Aeson ((.=))
|
||||||
, (.=)
|
import Data.Functor.Identity (Identity(..))
|
||||||
)
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
import Data.Text (Text)
|
import Data.Text (Text)
|
||||||
import Language.GraphQL
|
import Language.GraphQL
|
||||||
import Language.GraphQL.Schema (Subs)
|
|
||||||
import Text.RawString.QQ (r)
|
import Text.RawString.QQ (r)
|
||||||
import Test.Hspec.Expectations ( Expectation
|
import Test.Hspec.Expectations (Expectation, shouldBe)
|
||||||
, shouldBe
|
import Test.Hspec (Spec, describe, it)
|
||||||
)
|
|
||||||
import Test.Hspec ( Spec
|
|
||||||
, describe
|
|
||||||
, it
|
|
||||||
)
|
|
||||||
import Test.StarWars.Schema
|
import Test.StarWars.Schema
|
||||||
|
|
||||||
-- * Test
|
-- * Test
|
||||||
@ -34,26 +28,30 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object ["hero" .= object ["id" .= ("2001" :: Text)]]]
|
$ Aeson.object
|
||||||
|
[ "data" .= Aeson.object
|
||||||
|
[ "hero" .= Aeson.object ["id" .= ("2001" :: Text)]
|
||||||
|
]
|
||||||
|
]
|
||||||
it "R2-D2 ID and friends" $ testQuery
|
it "R2-D2 ID and friends" $ testQuery
|
||||||
[r| query HeroNameAndFriendsQuery {
|
[r| query HeroNameAndFriendsQuery {
|
||||||
hero {
|
hero {
|
||||||
id
|
id
|
||||||
name
|
name
|
||||||
friends {
|
friends {
|
||||||
name
|
name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"hero" .= object
|
"hero" .= Aeson.object
|
||||||
[ "id" .= ("2001" :: Text)
|
[ "id" .= ("2001" :: Text)
|
||||||
, r2d2Name
|
, r2d2Name
|
||||||
, "friends" .=
|
, "friends" .=
|
||||||
[ object [lukeName]
|
[ Aeson.object [lukeName]
|
||||||
, object [hanName]
|
, Aeson.object [hanName]
|
||||||
, object [leiaName]
|
, Aeson.object [leiaName]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]]
|
]]
|
||||||
@ -66,44 +64,44 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
friends {
|
friends {
|
||||||
name
|
name
|
||||||
appearsIn
|
appearsIn
|
||||||
friends {
|
friends {
|
||||||
name
|
name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"hero" .= object [
|
"hero" .= Aeson.object [
|
||||||
"name" .= ("R2-D2" :: Text)
|
"name" .= ("R2-D2" :: Text)
|
||||||
, "friends" .= [
|
, "friends" .= [
|
||||||
object [
|
Aeson.object [
|
||||||
"name" .= ("Luke Skywalker" :: Text)
|
"name" .= ("Luke Skywalker" :: Text)
|
||||||
, "appearsIn" .= ["NEWHOPE","EMPIRE","JEDI" :: Text]
|
, "appearsIn" .= ["NEW_HOPE", "EMPIRE", "JEDI" :: Text]
|
||||||
, "friends" .= [
|
, "friends" .= [
|
||||||
object [hanName]
|
Aeson.object [hanName]
|
||||||
, object [leiaName]
|
, Aeson.object [leiaName]
|
||||||
, object [c3poName]
|
, Aeson.object [c3poName]
|
||||||
, object [r2d2Name]
|
, Aeson.object [r2d2Name]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
, object [
|
, Aeson.object [
|
||||||
hanName
|
hanName
|
||||||
, "appearsIn" .= [ "NEWHOPE","EMPIRE","JEDI" :: Text]
|
, "appearsIn" .= ["NEW_HOPE", "EMPIRE", "JEDI" :: Text]
|
||||||
, "friends" .= [
|
, "friends" .=
|
||||||
object [lukeName]
|
[ Aeson.object [lukeName]
|
||||||
, object [leiaName]
|
, Aeson.object [leiaName]
|
||||||
, object [r2d2Name]
|
, Aeson.object [r2d2Name]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
, object [
|
, Aeson.object [
|
||||||
leiaName
|
leiaName
|
||||||
, "appearsIn" .= [ "NEWHOPE","EMPIRE","JEDI" :: Text]
|
, "appearsIn" .= ["NEW_HOPE", "EMPIRE", "JEDI" :: Text]
|
||||||
, "friends" .= [
|
, "friends" .=
|
||||||
object [lukeName]
|
[ Aeson.object [lukeName]
|
||||||
, object [hanName]
|
, Aeson.object [hanName]
|
||||||
, object [c3poName]
|
, Aeson.object [c3poName]
|
||||||
, object [r2d2Name]
|
, Aeson.object [r2d2Name]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
@ -116,40 +114,40 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object
|
||||||
"human" .= object [lukeName]
|
[ "human" .= Aeson.object [lukeName]
|
||||||
]]
|
]]
|
||||||
|
|
||||||
it "Luke ID with variable" $ testQueryParams
|
it "Luke ID with variable" $ testQueryParams
|
||||||
(\v -> if v == "someId" then Just "1000" else Nothing)
|
(HashMap.singleton "someId" "1000")
|
||||||
[r| query FetchSomeIDQuery($someId: String!) {
|
[r| query FetchSomeIDQuery($someId: String!) {
|
||||||
human(id: $someId) {
|
human(id: $someId) {
|
||||||
name
|
name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"human" .= object [lukeName]
|
"human" .= Aeson.object [lukeName]
|
||||||
]]
|
]]
|
||||||
it "Han ID with variable" $ testQueryParams
|
it "Han ID with variable" $ testQueryParams
|
||||||
(\v -> if v == "someId" then Just "1002" else Nothing)
|
(HashMap.singleton "someId" "1002")
|
||||||
[r| query FetchSomeIDQuery($someId: String!) {
|
[r| query FetchSomeIDQuery($someId: String!) {
|
||||||
human(id: $someId) {
|
human(id: $someId) {
|
||||||
name
|
name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"human" .= object [hanName]
|
"human" .= Aeson.object [hanName]
|
||||||
]]
|
]]
|
||||||
it "Invalid ID" $ testQueryParams
|
it "Invalid ID" $ testQueryParams
|
||||||
(\v -> if v == "id" then Just "Not a valid ID" else Nothing)
|
(HashMap.singleton "id" "Not a valid ID")
|
||||||
[r| query humanQuery($id: String!) {
|
[r| query humanQuery($id: String!) {
|
||||||
human(id: $id) {
|
human(id: $id) {
|
||||||
name
|
name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|] $ object ["data" .= object ["human" .= Aeson.Null]]
|
|] $ Aeson.object ["data" .= Aeson.object ["human" .= Aeson.Null]]
|
||||||
it "Luke aliased" $ testQuery
|
it "Luke aliased" $ testQuery
|
||||||
[r| query FetchLukeAliased {
|
[r| query FetchLukeAliased {
|
||||||
luke: human(id: "1000") {
|
luke: human(id: "1000") {
|
||||||
@ -157,8 +155,8 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"luke" .= object [lukeName]
|
"luke" .= Aeson.object [lukeName]
|
||||||
]]
|
]]
|
||||||
it "R2-D2 ID and friends aliased" $ testQuery
|
it "R2-D2 ID and friends aliased" $ testQuery
|
||||||
[r| query HeroNameAndFriendsQuery {
|
[r| query HeroNameAndFriendsQuery {
|
||||||
@ -171,14 +169,14 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"hero" .= object [
|
"hero" .= Aeson.object [
|
||||||
"id" .= ("2001" :: Text)
|
"id" .= ("2001" :: Text)
|
||||||
, r2d2Name
|
, r2d2Name
|
||||||
, "friends" .= [
|
, "friends" .=
|
||||||
object ["friendName" .= ("Luke Skywalker" :: Text)]
|
[ Aeson.object ["friendName" .= ("Luke Skywalker" :: Text)]
|
||||||
, object ["friendName" .= ("Han Solo" :: Text)]
|
, Aeson.object ["friendName" .= ("Han Solo" :: Text)]
|
||||||
, object ["friendName" .= ("Leia Organa" :: Text)]
|
, Aeson.object ["friendName" .= ("Leia Organa" :: Text)]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
]]
|
]]
|
||||||
@ -192,9 +190,9 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object
|
||||||
"luke" .= object [lukeName]
|
[ "luke" .= Aeson.object [lukeName]
|
||||||
, "leia" .= object [leiaName]
|
, "leia" .= Aeson.object [leiaName]
|
||||||
]]
|
]]
|
||||||
|
|
||||||
describe "Fragments for complex queries" $ do
|
describe "Fragments for complex queries" $ do
|
||||||
@ -210,9 +208,9 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"luke" .= object [lukeName, tatooine]
|
"luke" .= Aeson.object [lukeName, tatooine]
|
||||||
, "leia" .= object [leiaName, alderaan]
|
, "leia" .= Aeson.object [leiaName, alderaan]
|
||||||
]]
|
]]
|
||||||
it "Fragment for duplicate content" $ testQuery
|
it "Fragment for duplicate content" $ testQuery
|
||||||
[r| query UseFragment {
|
[r| query UseFragment {
|
||||||
@ -228,9 +226,9 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
homePlanet
|
homePlanet
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object [ "data" .= object [
|
$ Aeson.object [ "data" .= Aeson.object [
|
||||||
"luke" .= object [lukeName, tatooine]
|
"luke" .= Aeson.object [lukeName, tatooine]
|
||||||
, "leia" .= object [leiaName, alderaan]
|
, "leia" .= Aeson.object [leiaName, alderaan]
|
||||||
]]
|
]]
|
||||||
|
|
||||||
describe "__typename" $ do
|
describe "__typename" $ do
|
||||||
@ -242,8 +240,11 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object ["data" .= object [
|
$ Aeson.object ["data" .= Aeson.object [
|
||||||
"hero" .= object ["__typename" .= ("Droid" :: Text), r2d2Name]
|
"hero" .= Aeson.object
|
||||||
|
[ "__typename" .= ("Droid" :: Text)
|
||||||
|
, r2d2Name
|
||||||
|
]
|
||||||
]]
|
]]
|
||||||
it "Luke is a human" $ testQuery
|
it "Luke is a human" $ testQuery
|
||||||
[r| query CheckTypeOfLuke {
|
[r| query CheckTypeOfLuke {
|
||||||
@ -253,8 +254,11 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object ["data" .= object [
|
$ Aeson.object ["data" .= Aeson.object [
|
||||||
"hero" .= object ["__typename" .= ("Human" :: Text), lukeName]
|
"hero" .= Aeson.object
|
||||||
|
[ "__typename" .= ("Human" :: Text)
|
||||||
|
, lukeName
|
||||||
|
]
|
||||||
]]
|
]]
|
||||||
|
|
||||||
describe "Errors in resolvers" $ do
|
describe "Errors in resolvers" $ do
|
||||||
@ -267,15 +271,15 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object
|
$ Aeson.object
|
||||||
[ "data" .= object
|
[ "data" .= Aeson.object
|
||||||
[ "hero" .= object
|
[ "hero" .= Aeson.object
|
||||||
[ "name" .= ("R2-D2" :: Text)
|
[ "name" .= ("R2-D2" :: Text)
|
||||||
, "secretBackstory" .= Aeson.Null
|
, "secretBackstory" .= Aeson.Null
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
, "errors" .=
|
, "errors" .=
|
||||||
[ object
|
[ Aeson.object
|
||||||
["message" .= ("secretBackstory is secret." :: Text)]
|
["message" .= ("secretBackstory is secret." :: Text)]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
@ -290,19 +294,19 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object ["data" .= object
|
$ Aeson.object ["data" .= Aeson.object
|
||||||
[ "hero" .= object
|
[ "hero" .= Aeson.object
|
||||||
[ "name" .= ("R2-D2" :: Text)
|
[ "name" .= ("R2-D2" :: Text)
|
||||||
, "friends" .=
|
, "friends" .=
|
||||||
[ object
|
[ Aeson.object
|
||||||
[ "name" .= ("Luke Skywalker" :: Text)
|
[ "name" .= ("Luke Skywalker" :: Text)
|
||||||
, "secretBackstory" .= Aeson.Null
|
, "secretBackstory" .= Aeson.Null
|
||||||
]
|
]
|
||||||
, object
|
, Aeson.object
|
||||||
[ "name" .= ("Han Solo" :: Text)
|
[ "name" .= ("Han Solo" :: Text)
|
||||||
, "secretBackstory" .= Aeson.Null
|
, "secretBackstory" .= Aeson.Null
|
||||||
]
|
]
|
||||||
, object
|
, Aeson.object
|
||||||
[ "name" .= ("Leia Organa" :: Text)
|
[ "name" .= ("Leia Organa" :: Text)
|
||||||
, "secretBackstory" .= Aeson.Null
|
, "secretBackstory" .= Aeson.Null
|
||||||
]
|
]
|
||||||
@ -310,9 +314,15 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
]
|
]
|
||||||
]
|
]
|
||||||
, "errors" .=
|
, "errors" .=
|
||||||
[ object ["message" .= ("secretBackstory is secret." :: Text)]
|
[ Aeson.object
|
||||||
, object ["message" .= ("secretBackstory is secret." :: Text)]
|
[ "message" .= ("secretBackstory is secret." :: Text)
|
||||||
, object ["message" .= ("secretBackstory is secret." :: Text)]
|
]
|
||||||
|
, Aeson.object
|
||||||
|
[ "message" .= ("secretBackstory is secret." :: Text)
|
||||||
|
]
|
||||||
|
, Aeson.object
|
||||||
|
[ "message" .= ("secretBackstory is secret." :: Text)
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
it "error on secretBackstory with alias" $ testQuery
|
it "error on secretBackstory with alias" $ testQuery
|
||||||
@ -323,15 +333,17 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|]
|
|]
|
||||||
$ object
|
$ Aeson.object
|
||||||
[ "data" .= object
|
[ "data" .= Aeson.object
|
||||||
[ "mainHero" .= object
|
[ "mainHero" .= Aeson.object
|
||||||
[ "name" .= ("R2-D2" :: Text)
|
[ "name" .= ("R2-D2" :: Text)
|
||||||
, "story" .= Aeson.Null
|
, "story" .= Aeson.Null
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
, "errors" .=
|
, "errors" .=
|
||||||
[ object ["message" .= ("secretBackstory is secret." :: Text)]
|
[ Aeson.object
|
||||||
|
[ "message" .= ("secretBackstory is secret." :: Text)
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -345,7 +357,8 @@ spec = describe "Star Wars Query Tests" $ do
|
|||||||
alderaan = "homePlanet" .= ("Alderaan" :: Text)
|
alderaan = "homePlanet" .= ("Alderaan" :: Text)
|
||||||
|
|
||||||
testQuery :: Text -> Aeson.Value -> Expectation
|
testQuery :: Text -> Aeson.Value -> Expectation
|
||||||
testQuery q expected = graphql schema q >>= flip shouldBe expected
|
testQuery q expected = runIdentity (graphql schema q) `shouldBe` expected
|
||||||
|
|
||||||
testQueryParams :: Subs -> Text -> Aeson.Value -> Expectation
|
testQueryParams :: Aeson.Object -> Text -> Aeson.Value -> Expectation
|
||||||
testQueryParams f q expected = graphqlSubs schema f q >>= flip shouldBe expected
|
testQueryParams f q expected =
|
||||||
|
runIdentity (graphqlSubs schema f q) `shouldBe` expected
|
||||||
|
@ -1,59 +1,133 @@
|
|||||||
{-# LANGUAGE LambdaCase #-}
|
|
||||||
{-# LANGUAGE OverloadedStrings #-}
|
{-# LANGUAGE OverloadedStrings #-}
|
||||||
|
{-# LANGUAGE ScopedTypeVariables #-}
|
||||||
module Test.StarWars.Schema
|
module Test.StarWars.Schema
|
||||||
( character
|
( schema
|
||||||
, droid
|
|
||||||
, hero
|
|
||||||
, human
|
|
||||||
, schema
|
|
||||||
) where
|
) where
|
||||||
|
|
||||||
|
import Control.Monad.Trans.Reader (asks)
|
||||||
import Control.Monad.Trans.Except (throwE)
|
import Control.Monad.Trans.Except (throwE)
|
||||||
import Control.Monad.Trans.Class (lift)
|
import Control.Monad.Trans.Class (lift)
|
||||||
import Control.Monad.IO.Class (MonadIO(..))
|
import Data.Functor.Identity (Identity)
|
||||||
import Data.List.NonEmpty (NonEmpty(..))
|
import qualified Data.HashMap.Strict as HashMap
|
||||||
import Data.Maybe (catMaybes)
|
import Data.Maybe (catMaybes)
|
||||||
import qualified Language.GraphQL.Schema as Schema
|
import Data.Text (Text)
|
||||||
import Language.GraphQL.Trans
|
import Language.GraphQL.Trans
|
||||||
import qualified Language.GraphQL.Type as Type
|
import Language.GraphQL.Type
|
||||||
|
import qualified Language.GraphQL.Type.In as In
|
||||||
|
import qualified Language.GraphQL.Type.Out as Out
|
||||||
import Test.StarWars.Data
|
import Test.StarWars.Data
|
||||||
|
import Prelude hiding (id)
|
||||||
|
|
||||||
-- See https://github.com/graphql/graphql-js/blob/master/src/__tests__/starWarsSchema.js
|
-- See https://github.com/graphql/graphql-js/blob/master/src/__tests__/starWarsSchema.js
|
||||||
|
|
||||||
schema :: MonadIO m => NonEmpty (Schema.Resolver m)
|
schema :: Schema Identity
|
||||||
schema = hero :| [human, droid]
|
schema = Schema { query = queryType, mutation = Nothing }
|
||||||
|
where
|
||||||
|
queryType = Out.ObjectType "Query" Nothing [] $ HashMap.fromList
|
||||||
|
[ ("hero", Out.Resolver heroField hero)
|
||||||
|
, ("human", Out.Resolver humanField human)
|
||||||
|
, ("droid", Out.Resolver droidField droid)
|
||||||
|
]
|
||||||
|
heroField = Out.Field Nothing (Out.NamedObjectType heroObject)
|
||||||
|
$ HashMap.singleton "episode"
|
||||||
|
$ In.Argument Nothing (In.NamedEnumType episodeEnum) Nothing
|
||||||
|
humanField = Out.Field Nothing (Out.NamedObjectType heroObject)
|
||||||
|
$ HashMap.singleton "id"
|
||||||
|
$ In.Argument Nothing (In.NonNullScalarType string) Nothing
|
||||||
|
droidField = Out.Field Nothing (Out.NamedObjectType droidObject) mempty
|
||||||
|
|
||||||
hero :: MonadIO m => Schema.Resolver m
|
heroObject :: Out.ObjectType Identity
|
||||||
hero = Schema.objectA "hero" $ \case
|
heroObject = Out.ObjectType "Human" Nothing [] $ HashMap.fromList
|
||||||
[] -> character artoo
|
[ ("id", Out.Resolver idFieldType (idField "id"))
|
||||||
[Schema.Argument "episode" (Schema.Enum "NEWHOPE")] -> character $ getHero 4
|
, ("name", Out.Resolver nameFieldType (idField "name"))
|
||||||
[Schema.Argument "episode" (Schema.Enum "EMPIRE" )] -> character $ getHero 5
|
, ("friends", Out.Resolver friendsFieldType (idField "friends"))
|
||||||
[Schema.Argument "episode" (Schema.Enum "JEDI" )] -> character $ getHero 6
|
, ("appearsIn", Out.Resolver appearsInField (idField "appearsIn"))
|
||||||
_ -> ActionT $ throwE "Invalid arguments."
|
, ("homePlanet", Out.Resolver homePlanetFieldType (idField "homePlanet"))
|
||||||
|
, ("secretBackstory", Out.Resolver secretBackstoryFieldType (String <$> secretBackstory))
|
||||||
human :: MonadIO m => Schema.Resolver m
|
, ("__typename", Out.Resolver (Out.Field Nothing (Out.NamedScalarType string) mempty) (idField "__typename"))
|
||||||
human = Schema.wrappedObjectA "human" $ \case
|
]
|
||||||
[Schema.Argument "id" (Schema.String i)] -> do
|
where
|
||||||
humanCharacter <- lift $ return $ getHuman i >>= Just
|
homePlanetFieldType = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
case humanCharacter of
|
|
||||||
Nothing -> return Type.Null
|
droidObject :: Out.ObjectType Identity
|
||||||
Just e -> Type.Named <$> character e
|
droidObject = Out.ObjectType "Droid" Nothing [] $ HashMap.fromList
|
||||||
_ -> ActionT $ throwE "Invalid arguments."
|
[ ("id", Out.Resolver idFieldType (idField "id"))
|
||||||
|
, ("name", Out.Resolver nameFieldType (idField "name"))
|
||||||
droid :: MonadIO m => Schema.Resolver m
|
, ("friends", Out.Resolver friendsFieldType (idField "friends"))
|
||||||
droid = Schema.objectA "droid" $ \case
|
, ("appearsIn", Out.Resolver appearsInField (idField "appearsIn"))
|
||||||
[Schema.Argument "id" (Schema.String i)] -> character =<< liftIO (getDroid i)
|
, ("primaryFunction", Out.Resolver primaryFunctionFieldType (idField "primaryFunction"))
|
||||||
_ -> ActionT $ throwE "Invalid arguments."
|
, ("secretBackstory", Out.Resolver secretBackstoryFieldType (String <$> secretBackstory))
|
||||||
|
, ("__typename", Out.Resolver (Out.Field Nothing (Out.NamedScalarType string) mempty) (idField "__typename"))
|
||||||
character :: MonadIO m => Character -> ActionT m [Schema.Resolver m]
|
]
|
||||||
character char = return
|
where
|
||||||
[ Schema.scalar "id" $ return $ id_ char
|
primaryFunctionFieldType = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
, Schema.scalar "name" $ return $ name char
|
|
||||||
, Schema.wrappedObject "friends"
|
idFieldType :: Out.Field Identity
|
||||||
$ traverse character $ Type.List $ Type.Named <$> getFriends char
|
idFieldType = Out.Field Nothing (Out.NamedScalarType id) mempty
|
||||||
, Schema.wrappedScalar "appearsIn" $ return . Type.List
|
|
||||||
$ catMaybes (getEpisode <$> appearsIn char)
|
nameFieldType :: Out.Field Identity
|
||||||
, Schema.scalar "secretBackstory" $ secretBackstory char
|
nameFieldType = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
, Schema.scalar "homePlanet" $ return $ either mempty homePlanet char
|
|
||||||
, Schema.scalar "__typename" $ return $ typeName char
|
friendsFieldType :: Out.Field Identity
|
||||||
|
friendsFieldType = Out.Field Nothing (Out.ListType $ Out.NamedObjectType droidObject) mempty
|
||||||
|
|
||||||
|
appearsInField :: Out.Field Identity
|
||||||
|
appearsInField = Out.Field (Just description) fieldType mempty
|
||||||
|
where
|
||||||
|
fieldType = Out.ListType $ Out.NamedEnumType episodeEnum
|
||||||
|
description = "Which movies they appear in."
|
||||||
|
|
||||||
|
secretBackstoryFieldType :: Out.Field Identity
|
||||||
|
secretBackstoryFieldType = Out.Field Nothing (Out.NamedScalarType string) mempty
|
||||||
|
|
||||||
|
idField :: Text -> ActionT Identity Value
|
||||||
|
idField f = do
|
||||||
|
v <- ActionT $ lift $ asks values
|
||||||
|
let (Object v') = v
|
||||||
|
pure $ v' HashMap.! f
|
||||||
|
|
||||||
|
episodeEnum :: EnumType
|
||||||
|
episodeEnum = EnumType "Episode" (Just description)
|
||||||
|
$ HashMap.fromList [newHope, empire, jedi]
|
||||||
|
where
|
||||||
|
description = "One of the films in the Star Wars Trilogy"
|
||||||
|
newHope = ("NEW_HOPE", EnumValue $ Just "Released in 1977.")
|
||||||
|
empire = ("EMPIRE", EnumValue $ Just "Released in 1980.")
|
||||||
|
jedi = ("JEDI", EnumValue $ Just "Released in 1983.")
|
||||||
|
|
||||||
|
hero :: ActionT Identity Value
|
||||||
|
hero = do
|
||||||
|
episode <- argument "episode"
|
||||||
|
pure $ character $ case episode of
|
||||||
|
Enum "NEW_HOPE" -> getHero 4
|
||||||
|
Enum "EMPIRE" -> getHero 5
|
||||||
|
Enum "JEDI" -> getHero 6
|
||||||
|
_ -> artoo
|
||||||
|
|
||||||
|
human :: ActionT Identity Value
|
||||||
|
human = do
|
||||||
|
id' <- argument "id"
|
||||||
|
case id' of
|
||||||
|
String i -> do
|
||||||
|
humanCharacter <- lift $ return $ getHuman i >>= Just
|
||||||
|
case humanCharacter of
|
||||||
|
Nothing -> pure Null
|
||||||
|
Just e -> pure $ character e
|
||||||
|
_ -> ActionT $ throwE "Invalid arguments."
|
||||||
|
|
||||||
|
droid :: ActionT Identity Value
|
||||||
|
droid = do
|
||||||
|
id' <- argument "id"
|
||||||
|
case id' of
|
||||||
|
String i -> character <$> getDroid i
|
||||||
|
_ -> ActionT $ throwE "Invalid arguments."
|
||||||
|
|
||||||
|
character :: Character -> Value
|
||||||
|
character char = Object $ HashMap.fromList
|
||||||
|
[ ("id", String $ id_ char)
|
||||||
|
, ("name", String $ name_ char)
|
||||||
|
, ("friends", List $ character <$> getFriends char)
|
||||||
|
, ("appearsIn", List $ Enum <$> catMaybes (getEpisode <$> appearsIn char))
|
||||||
|
, ("homePlanet", String $ either mempty homePlanet char)
|
||||||
|
, ("__typename", String $ typeName char)
|
||||||
]
|
]
|
||||||
|
Reference in New Issue
Block a user