diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog +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/). + +## [1.0.0.0] - 2022-03-29 +### Added +- JSON serialization. +- Test helpers. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/graphql-spice.cabal b/graphql-spice.cabal new file mode 100644 --- /dev/null +++ b/graphql-spice.cabal @@ -0,0 +1,67 @@ +cabal-version: 2.4 + +name: graphql-spice +version: 1.0.0.0 +synopsis: GraphQL with batteries +description: Various extensions and convenience functions for the core + graphql package. +category: Language +homepage: https://www.caraus.tech/projects/pub-graphql-spice +bug-reports: https://www.caraus.tech/projects/pub-graphql-spice/issues +author: Eugen Wissner +maintainer: belka@caraus.de +copyright: (c) 2021-2022 Eugen Wissner +license: MPL-2.0 +license-files: LICENSE +build-type: Simple +extra-source-files: CHANGELOG.md +tested-with: + GHC == 8.10.7 + +source-repository head + type: git + location: git://caraus.tech/pub/graphql-spice.git + +library + exposed-modules: + Language.GraphQL.JSON, + Test.Hspec.GraphQL + other-modules: + hs-source-dirs: src + ghc-options: -Wall + build-depends: + aeson ^>= 2.0.3, + base >= 4.7 && < 5, + conduit ^>= 1.3.4, + containers ^>= 0.6.2, + exceptions ^>= 0.10.4, + hspec-expectations >= 0.8.2 && < 0.9, + graphql ^>= 1.0.3.0, + megaparsec >= 9.0 && < 10, + scientific ^>= 0.3.7, + text >= 1.2 && < 3, + vector ^>= 0.12.3, + unordered-containers ^>= 0.2.16 + default-language: Haskell2010 + +test-suite graphql-test + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + Language.GraphQL.CoerceSpec + Language.GraphQL.DirectiveSpec + Language.GraphQL.FragmentSpec + Language.GraphQL.RootOperationSpec + hs-source-dirs: + tests + ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall + build-depends: + aeson, + base, + graphql, + graphql-spice, + hspec >= 2.9.1 && < 3, + scientific, + text, + unordered-containers + default-language: Haskell2010 diff --git a/src/Language/GraphQL/JSON.hs b/src/Language/GraphQL/JSON.hs new file mode 100644 --- /dev/null +++ b/src/Language/GraphQL/JSON.hs @@ -0,0 +1,159 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE RecordWildCards #-} + +-- | JSON serialization. +module Language.GraphQL.JSON + ( JSON(..) + , graphql + ) where + +import Control.Monad.Catch (MonadCatch) +import qualified Data.Aeson.Types as Aeson +import Data.Maybe (catMaybes) +import qualified Data.Sequence as Seq +import Data.Vector (Vector) +import qualified Data.Vector as Vector +import qualified Language.GraphQL as GraphQL +import Language.GraphQL.AST (Location(..), Name) +import Language.GraphQL.Error +import Language.GraphQL.Type.Schema (Schema) +import Data.Bifunctor (Bifunctor(..)) +import qualified Conduit +import qualified Data.Aeson.Key as Aeson.Key +import qualified Data.Aeson.KeyMap as KeyMap +import Data.HashMap.Strict (HashMap) +import qualified Data.HashMap.Strict as HashMap +import Data.Scientific (toBoundedInteger, toRealFloat) +import Data.Text (Text) +import Language.GraphQL.Execute.Coerce +import qualified Language.GraphQL.Execute.OrderedMap as OrderedMap +import qualified Language.GraphQL.Type.In as In +import qualified Language.GraphQL.Type.Out as Out +import qualified Language.GraphQL.Type as Type + +-- | Wraps an aeson value. +newtype JSON = JSON Aeson.Value + +instance Aeson.ToJSON JSON where + toJSON (JSON value) = value + +instance Aeson.FromJSON JSON where + parseJSON = pure . JSON + +instance Serialize JSON where + serialize (Out.ScalarBaseType scalarType) value + | Type.ScalarType "Int" _ <- scalarType + , Int int <- value = Just $ JSON $ Aeson.Number $ fromIntegral int + | Type.ScalarType "Float" _ <- scalarType + , Float float <- value = Just $ JSON $ Aeson.toJSON float + | Type.ScalarType "String" _ <- scalarType + , String string <- value = Just $ JSON $ Aeson.String string + | Type.ScalarType "ID" _ <- scalarType + , String string <- value = Just $ JSON $ Aeson.String string + | Type.ScalarType "Boolean" _ <- scalarType + , Boolean boolean <- value = Just $ JSON $ Aeson.Bool boolean + serialize _ (Enum enum) = Just $ JSON $ Aeson.String enum + serialize _ (List list) = Just $ JSON $ Aeson.toJSON list + serialize _ (Object object) = Just + $ JSON + $ Aeson.object + $ toJSONKeyValue <$> OrderedMap.toList object + where + toJSONKeyValue (key, value) = (Aeson.Key.fromText key, Aeson.toJSON value) + serialize _ _ = Nothing + null = JSON Aeson.Null + +instance VariableValue JSON where + coerceVariableValue _ (JSON Aeson.Null) = Just Type.Null + coerceVariableValue (In.ScalarBaseType scalarType) (JSON 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 _) (JSON (Aeson.String stringValue)) = + Just $ Type.Enum stringValue + coerceVariableValue (In.InputObjectBaseType objectType) (JSON value) + | (Aeson.Object objectValue) <- value = do + let (In.InputObjectType _ _ inputFields) = objectType + (newObjectValue, resultMap) <- foldWithKey objectValue inputFields + if KeyMap.null newObjectValue + then Just $ Type.Object resultMap + else Nothing + where + foldWithKey :: Aeson.Object + -> HashMap Name In.InputField + -> Maybe (Aeson.Object, HashMap Name Type.Value) + foldWithKey objectValue = HashMap.foldrWithKey matchFieldValues' + $ Just (objectValue, HashMap.empty) + matchFieldValues' :: Text + -> In.InputField + -> Maybe (Aeson.Object, HashMap Name Type.Value) + -> Maybe (Aeson.Object, HashMap Name Type.Value) + matchFieldValues' _ _ Nothing = Nothing + matchFieldValues' fieldName inputField (Just (objectValue, resultMap)) = + let fieldKey = Aeson.Key.fromText fieldName + In.InputField _ fieldType _ = inputField + insert = flip (HashMap.insert fieldName) resultMap + newObjectValue = KeyMap.delete fieldKey objectValue + in case KeyMap.lookup fieldKey objectValue of + Just variableValue -> do + coerced <- coerceVariableValue fieldType + $ JSON variableValue + pure (newObjectValue, insert coerced) + Nothing -> Just (objectValue, resultMap) + coerceVariableValue (In.ListBaseType listType) (JSON value) + | (Aeson.Array arrayValue) <- value = + Type.List <$> foldr foldVector (Just []) arrayValue + | otherwise = coerceVariableValue listType $ JSON value + where + foldVector _ Nothing = Nothing + foldVector variableValue (Just list) = do + coerced <- coerceVariableValue listType $ JSON variableValue + pure $ coerced : list + coerceVariableValue _ _ = Nothing + +-- | If the text parses correctly as a @GraphQL@ query the query is +-- executed using the given 'Schema'. +graphql :: MonadCatch m + => Schema m -- ^ Resolvers. + -> Maybe Text -- ^ Operation name. + -> Aeson.Object -- ^ Variables. + -> Text -- ^ Text representing a @GraphQL@ request document. + -> m (Either (ResponseEventStream m Aeson.Value) Aeson.Object) -- ^ Response. +graphql schema operationName variableValues = fmap (bimap stream formatResponse) + . GraphQL.graphql schema operationName jsonVariables + where + jsonVariables = JSON <$> KeyMap.toHashMapText variableValues + -- stream :: ResponseEventStream m JSON -> ResponseEventStream m Aeson.Value + stream = Conduit.mapOutput mapResponse + mapResponse response@Response{ data' = JSON json } = + response{ data' = json } + formatResponse :: Response JSON -> Aeson.Object + formatResponse Response{ errors, data' = JSON json } = + let dataResponse = KeyMap.singleton "data" json + in case errors of + Seq.Empty -> dataResponse + _ -> flip (KeyMap.insert "errors") dataResponse + $ Aeson.Array $ foldr fromError mempty errors + fromError :: Error -> Vector Aeson.Value -> Vector Aeson.Value + fromError Error{..} = Vector.cons $ Aeson.object $ catMaybes + [ Just ("message", Aeson.String message) + , toMaybe fromLocation "locations" locations + , toMaybe fromPath "path" path + ] + fromPath (Segment segment) = Aeson.String segment + fromPath (Index index) = Aeson.toJSON index + fromLocation Location{..} = Aeson.object + [ ("line", Aeson.toJSON line) + , ("column", Aeson.toJSON column) + ] + toMaybe _ _ [] = Nothing + toMaybe f key xs = Just (key, Aeson.listValue f xs) diff --git a/src/Test/Hspec/GraphQL.hs b/src/Test/Hspec/GraphQL.hs new file mode 100644 --- /dev/null +++ b/src/Test/Hspec/GraphQL.hs @@ -0,0 +1,48 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE ExplicitForAll #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE DuplicateRecordFields #-} + +-- | Test helpers. +module Test.Hspec.GraphQL + ( shouldResolve + , shouldResolveTo + ) where + +import Control.Monad.Catch (MonadCatch) +import qualified Data.Sequence as Seq +import Data.Text (Text) +import Language.GraphQL.Error +import Language.GraphQL.Execute +import Test.Hspec.Expectations + ( Expectation + , expectationFailure + , shouldBe + , shouldSatisfy + ) + +-- | Asserts that a query resolves to some value. +shouldResolveTo :: (MonadCatch m, Serialize b, Eq b, Show b) + => Either (ResponseEventStream m b) (Response b) + -> b + -> Expectation +shouldResolveTo (Right Response{ errors = Seq.Empty, data' }) expected = + data' `shouldBe` expected +shouldResolveTo _ _ = expectationFailure + "the query is expected to resolve to a value, but it resolved to an event stream" + +-- | Asserts that the response doesn't contain any errors. +shouldResolve :: (MonadCatch m, Serialize b) + => (Text -> IO (Either (ResponseEventStream m b) (Response b))) + -> Text + -> Expectation +shouldResolve executor query = do + actual <- executor query + case actual of + Right Response{ errors } -> errors `shouldSatisfy` Seq.null + _ -> expectationFailure + "the query is expected to resolve to a value, but it resolved to an event stream" diff --git a/tests/Language/GraphQL/CoerceSpec.hs b/tests/Language/GraphQL/CoerceSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Language/GraphQL/CoerceSpec.hs @@ -0,0 +1,98 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE OverloadedStrings #-} +module Language.GraphQL.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.JSON (JSON(..)) +import qualified Language.GraphQL.Type.In as In +import Language.GraphQL.Type +import Prelude hiding (id) +import Test.Hspec (Spec, describe, it, shouldBe, shouldSatisfy) + +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 = + describe "VariableValue Aeson" $ do + it "coerces strings" $ + let expected = Just (String "asdf") + actual = Coerce.coerceVariableValue (In.NamedScalarType string) + $ JSON $ Aeson.String "asdf" + in actual `shouldBe` expected + it "coerces non-null strings" $ + let expected = Just (String "asdf") + actual = Coerce.coerceVariableValue (In.NonNullScalarType string) + $ JSON $ Aeson.String "asdf" + in actual `shouldBe` expected + it "coerces booleans" $ + let expected = Just (Boolean True) + actual = Coerce.coerceVariableValue (In.NamedScalarType boolean) + $ JSON $ Aeson.Bool True + in actual `shouldBe` expected + it "coerces zero to an integer" $ + let expected = Just (Int 0) + actual = Coerce.coerceVariableValue (In.NamedScalarType int) + $ JSON $ Aeson.Number 0 + in actual `shouldBe` expected + it "rejects fractional if an integer is expected" $ + let actual = Coerce.coerceVariableValue (In.NamedScalarType int) + $ JSON $ 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) + $ JSON $ Aeson.Number $ scientific 14 (-1) + in actual `shouldBe` expected + it "coerces IDs" $ + let expected = Just (String "1234") + json = JSON $ Aeson.String "1234" + actual = Coerce.coerceVariableValue namedIdType json + in actual `shouldBe` expected + it "coerces input objects" $ + let actual = Coerce.coerceVariableValue singletonInputObject + $ JSON + $ 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 + $ JSON 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 + $ JSON $ Aeson.object variableFields + variableFields = + [ "field" .= ("asdf" :: Aeson.Value) + , "extra" .= ("qwer" :: Aeson.Value) + ] + in actual `shouldSatisfy` isNothing + it "preserves null" $ + let actual = Coerce.coerceVariableValue namedIdType + $ JSON Aeson.Null + in actual `shouldBe` Just Null + it "preserves list order" $ + let list = JSON $ 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 diff --git a/tests/Language/GraphQL/DirectiveSpec.hs b/tests/Language/GraphQL/DirectiveSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Language/GraphQL/DirectiveSpec.hs @@ -0,0 +1,88 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE PackageImports #-} + +module Language.GraphQL.DirectiveSpec + ( spec + ) where + +import Language.GraphQL.AST.Document (Name) +import Data.HashMap.Strict (HashMap) +import qualified Data.HashMap.Strict as HashMap +import qualified Language.GraphQL as GraphQL +import Language.GraphQL.TH +import Language.GraphQL.Type +import qualified Language.GraphQL.Type.Out as Out +import Test.Hspec (Spec, describe, it) +import "graphql-spice" Test.Hspec.GraphQL + +experimentalResolver :: Schema IO +experimentalResolver = schema queryType Nothing Nothing mempty + where + queryType = Out.ObjectType "Query" Nothing [] + $ HashMap.singleton "experimentalField" + $ Out.ValueResolver (Out.Field Nothing (Out.NamedScalarType int) mempty) + $ pure $ Int 5 + +spec :: Spec +spec = + describe "Directive executor" $ do + it "should be able to @skip fields" $ do + let sourceQuery = [gql| + { + experimentalField @skip(if: true) + } + |] + + actual <- GraphQL.graphql experimentalResolver Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` Object mempty + + it "should not skip fields if @skip is false" $ do + let sourceQuery = [gql| + { + experimentalField @skip(if: false) + } + |] + expected = Object $ HashMap.singleton "experimentalField" (Int 5) + actual <- GraphQL.graphql experimentalResolver Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` expected + + it "should skip fields if @include is false" $ do + let sourceQuery = [gql| + { + experimentalField @include(if: false) + } + |] + + actual <- GraphQL.graphql experimentalResolver Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` Object mempty + + it "should be able to @skip a fragment spread" $ do + let sourceQuery = [gql| + { + ...experimentalFragment @skip(if: true) + } + + fragment experimentalFragment on Query { + experimentalField + } + |] + + actual <- GraphQL.graphql experimentalResolver Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` Object mempty + + it "should be able to @skip an inline fragment" $ do + let sourceQuery = [gql| + { + ... on Query @skip(if: true) { + experimentalField + } + } + |] + + actual <- GraphQL.graphql experimentalResolver Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` Object mempty diff --git a/tests/Language/GraphQL/FragmentSpec.hs b/tests/Language/GraphQL/FragmentSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Language/GraphQL/FragmentSpec.hs @@ -0,0 +1,208 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE PackageImports #-} + +module Language.GraphQL.FragmentSpec + ( spec + ) where + +import qualified Data.HashMap.Strict as HashMap +import Data.Text (Text) +import Language.GraphQL.AST (Name) +import Data.HashMap.Strict (HashMap) +import Language.GraphQL.Type +import Language.GraphQL.Error +import qualified Language.GraphQL.Type.Out as Out +import Language.GraphQL.TH +import qualified Language.GraphQL as GraphQL +import Test.Hspec (Spec, describe, it) +import "graphql-spice" Test.Hspec.GraphQL + +size :: (Text, Value) +size = ("size", String "L") + +circumference :: (Text, Value) +circumference = ("circumference", Int 60) + +garment :: Text -> (Text, Value) +garment typeName = + ("garment", Object $ HashMap.fromList + [ if typeName == "Hat" then circumference else size + , ("__typename", String typeName) + ] + ) + +inlineQuery :: Text +inlineQuery = [gql| + { + garment { + ... on Hat { + circumference + } + ... on Shirt { + size + } + } + } +|] + +shirtType :: Out.ObjectType IO +shirtType = Out.ObjectType "Shirt" Nothing [] $ HashMap.fromList + [ ("size", sizeFieldType) + ] + +hatType :: Out.ObjectType IO +hatType = Out.ObjectType "Hat" Nothing [] $ HashMap.fromList + [ ("size", sizeFieldType) + , ("circumference", circumferenceFieldType) + ] + +circumferenceFieldType :: Out.Resolver IO +circumferenceFieldType + = Out.ValueResolver (Out.Field Nothing (Out.NamedScalarType int) mempty) + $ pure $ snd circumference + +sizeFieldType :: Out.Resolver IO +sizeFieldType + = Out.ValueResolver (Out.Field Nothing (Out.NamedScalarType string) mempty) + $ pure $ snd size + +toSchema :: Text -> (Text, Value) -> Schema IO +toSchema t (_, resolve) = schema queryType Nothing Nothing mempty + where + garmentType = Out.UnionType "Garment" Nothing [hatType, shirtType] + typeNameField = Out.Field Nothing (Out.NamedScalarType string) mempty + garmentField = Out.Field Nothing (Out.NamedUnionType garmentType) mempty + queryType = + case t of + "circumference" -> hatType + "size" -> shirtType + _ -> Out.ObjectType "Query" Nothing [] + $ HashMap.fromList + [ ("garment", ValueResolver garmentField (pure resolve)) + , ("__typename", ValueResolver typeNameField (pure $ String "Shirt")) + ] + +spec :: Spec +spec = do + describe "Inline fragment executor" $ do + it "chooses the first selection if the type matches" $ do + let localSchema = toSchema "Hat" $ garment "Hat" + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) inlineQuery + let expected = Object + $ HashMap.singleton "garment" + $ Object + $ HashMap.singleton "circumference" + $ Int 60 + in actual `shouldResolveTo` expected + + it "chooses the last selection if the type matches" $ do + let localSchema = toSchema "Shirt" $ garment "Shirt" + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) inlineQuery + let expected = Object + $ HashMap.singleton "garment" + $ Object + $ HashMap.singleton "size" + $ String "L" + in actual `shouldResolveTo` expected + + it "embeds inline fragments without type" $ do + let sourceQuery = [gql| + { + circumference + ... { + size + } + } + |] + let localSchema = toSchema "circumference" circumference + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) sourceQuery + let expected = Object $ HashMap.fromList + [ ("circumference", Int 60) + , ("size", String "L") + ] + in actual `shouldResolveTo` expected + + it "evaluates fragments on Query" $ do + let sourceQuery = [gql| + { + ... { + size + } + } + |] + localSchema = toSchema "size" size + actual :: Text -> IO (Either (ResponseEventStream IO Value) (Response Value)) + actual = GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) + in actual `shouldResolve` sourceQuery + + describe "Fragment spread executor" $ do + it "evaluates fragment spreads" $ do + let sourceQuery = [gql| + { + ...circumferenceFragment + } + + fragment circumferenceFragment on Hat { + circumference + } + |] + let localSchema = toSchema "circumference" circumference + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) sourceQuery + let expected = Object + $ HashMap.singleton "circumference" + $ Int 60 + in actual `shouldResolveTo` expected + + it "evaluates nested fragments" $ do + let sourceQuery = [gql| + { + garment { + ...circumferenceFragment + } + } + + fragment circumferenceFragment on Hat { + ...hatFragment + } + + fragment hatFragment on Hat { + circumference + } + |] + let localSchema = toSchema "Hat" $ garment "Hat" + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) sourceQuery + let expected = Object + $ HashMap.singleton "garment" + $ Object + $ HashMap.singleton "circumference" + $ Int 60 + in actual `shouldResolveTo` expected + + it "considers type condition" $ do + let sourceQuery = [gql| + { + garment { + ...circumferenceFragment + ...sizeFragment + } + } + fragment circumferenceFragment on Hat { + circumference + } + fragment sizeFragment on Shirt { + size + } + |] + expected = Object + $ HashMap.singleton "garment" + $ Object + $ HashMap.singleton "circumference" + $ Int 60 + let localSchema = toSchema "Hat" $ garment "Hat" + actual <- GraphQL.graphql localSchema Nothing (mempty :: HashMap Name Value) sourceQuery + actual `shouldResolveTo` expected diff --git a/tests/Language/GraphQL/RootOperationSpec.hs b/tests/Language/GraphQL/RootOperationSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Language/GraphQL/RootOperationSpec.hs @@ -0,0 +1,73 @@ +{- This Source Code Form is subject to the terms of the Mozilla Public License, + v. 2.0. If a copy of the MPL was not distributed with this file, You can + obtain one at https://mozilla.org/MPL/2.0/. -} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE PackageImports #-} + +module Language.GraphQL.RootOperationSpec + ( spec + ) where + +import Data.HashMap.Strict (HashMap) +import qualified Data.HashMap.Strict as HashMap +import Language.GraphQL +import Language.GraphQL.AST (Name) +import Test.Hspec (Spec, describe, it) +import Language.GraphQL.TH +import Language.GraphQL.Type +import qualified Language.GraphQL.Type.Out as Out +import "graphql-spice" Test.Hspec.GraphQL + +hatType :: Out.ObjectType IO +hatType = Out.ObjectType "Hat" Nothing [] + $ HashMap.singleton "circumference" + $ ValueResolver (Out.Field Nothing (Out.NamedScalarType int) mempty) + $ pure $ Int 60 + +garmentSchema :: Schema IO +garmentSchema = schema queryType (Just mutationType) Nothing mempty + where + queryType = Out.ObjectType "Query" Nothing [] hatFieldResolver + mutationType = Out.ObjectType "Mutation" Nothing [] incrementFieldResolver + garment = pure $ Object $ HashMap.fromList + [ ("circumference", Int 60) + ] + incrementFieldResolver = HashMap.singleton "incrementCircumference" + $ ValueResolver (Out.Field Nothing (Out.NamedScalarType int) mempty) + $ pure $ Int 61 + hatField = Out.Field Nothing (Out.NamedObjectType hatType) mempty + hatFieldResolver = + HashMap.singleton "garment" $ ValueResolver hatField garment + +spec :: Spec +spec = + describe "Root operation type" $ do + it "returns objects from the root resolvers" $ do + let querySource = [gql| + { + garment { + circumference + } + } + |] + expected = Object + $ HashMap.singleton "garment" + $ Object + $ HashMap.singleton "circumference" + $ Int 60 + actual <- graphql garmentSchema Nothing (mempty :: HashMap Name Value) querySource + actual `shouldResolveTo` expected + + it "chooses Mutation" $ do + let querySource = [gql| + mutation { + incrementCircumference + } + |] + expected = Object + $ HashMap.singleton "incrementCircumference" + $ Int 61 + actual <- graphql garmentSchema Nothing (mempty :: HashMap Name Value) querySource + actual `shouldResolveTo` expected diff --git a/tests/Spec.hs b/tests/Spec.hs new file mode 100644 --- /dev/null +++ b/tests/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}