Release 1.2.0.3

inside an input object for the role checking for unused and undefined
variables.

CHANGELOG.md

@@ -6,11 +6,16 @@ The format is based on
 and this project adheres to
 [Haskell Package Versioning Policy](https://pvp.haskell.org/).
 
-## [Unreleased]
+## [1.2.0.3] - 2024-01-09
+### Fixed
+- Fix corrupted source distribution.
+
+## [1.2.0.2] - 2024-01-09
 ### Fixed
 - `gql` removes not only leading `\n` but also `\r`.
 - Fix non nullable type string representation in executor error messages.
 - Fix input objects not being coerced to lists.
+- Fix used variables are not found in the properties of input objects.
 
 ## [1.2.0.1] - 2023-04-25
 ### Fixed
@@ -514,7 +519,8 @@ and this project adheres to
 ### Added
 - Data types for the GraphQL language.
 
-[Unreleased]: https://git.caraus.tech/OSS/graphql/compare/v1.2.0.1...master
+[1.2.0.3]: https://git.caraus.tech/OSS/graphql/compare/v1.2.0.2...v1.2.0.3
+[1.2.0.2]: https://git.caraus.tech/OSS/graphql/compare/v1.2.0.1...v1.2.0.2
 [1.2.0.1]: https://git.caraus.tech/OSS/graphql/compare/v1.2.0.0...v1.2.0.1
 [1.2.0.0]: https://git.caraus.tech/OSS/graphql/compare/v1.1.0.0...v1.2.0.0
 [1.1.0.0]: https://git.caraus.tech/OSS/graphql/compare/v1.0.3.0...v1.1.0.0

graphql.cabal

@@ -1,7 +1,7 @@
 cabal-version: 2.4
 
 name:           graphql
-version:        1.2.0.1
+version:        1.2.0.3
 synopsis:       Haskell GraphQL implementation
 description:    Haskell <https://spec.graphql.org/June2018/ GraphQL> implementation.
 category:       Language
@@ -11,7 +11,7 @@ author:         Danny Navarro <j@dannynavarro.net>,
                 Matthías Páll Gissurarson <mpg@mpg.is>,
                 Sólrún Halla Einarsdóttir <she@mpg.is>
 maintainer:     belka@caraus.de
-copyright:      (c) 2019-2023 Eugen Wissner,
+copyright:      (c) 2019-2024 Eugen Wissner,
                 (c) 2015-2017 J. Daniel Navarro
 license:        MPL-2.0 AND BSD-3-Clause
 license-files:  LICENSE,

src/Language/GraphQL/Validate/Rules.hs

@@ -2,11 +2,13 @@
    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 DataKinds #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE ViewPatterns #-}
 
 -- | This module contains default rules defined in the GraphQL specification.
@@ -61,6 +63,7 @@ import Data.Sequence (Seq(..), (|>))
 import qualified Data.Sequence as Seq
 import Data.Text (Text)
 import qualified Data.Text as Text
+import GHC.Records (HasField(..))
 import qualified Language.GraphQL.AST.Document as Full
 import qualified Language.GraphQL.Type.Definition as Definition
 import qualified Language.GraphQL.Type.Internal as Type
@@ -618,6 +621,10 @@ noUndefinedVariablesRule =
         , "\"."
         ]
 
+-- Used to find the difference between defined and used variables. The first
+-- argument are variables defined in the operation, the second argument are
+-- variables used in the query. It should return the difference between these
+-- 2 sets.
 type UsageDifference
     = HashMap Full.Name [Full.Location]
     -> HashMap Full.Name [Full.Location]
@@ -664,11 +671,17 @@ variableUsageDifference difference errorMessage = OperationDefinitionRule $ \cas
         = filterSelections' selections
         >>= lift . mapReaderT (<> mapDirectives directives') . pure
     findDirectiveVariables (Full.Directive _ arguments _) = mapArguments arguments
-    mapArguments = Seq.fromList . mapMaybe findArgumentVariables
+    mapArguments = Seq.fromList . (>>= findArgumentVariables)
     mapDirectives = foldMap findDirectiveVariables
-    findArgumentVariables (Full.Argument _ Full.Node{ node = Full.Variable value', ..} _) =
+
-        Just (value', [location])
+    findArgumentVariables (Full.Argument _ value _) = findNodeVariables value
-    findArgumentVariables _ = Nothing
+    findNodeVariables Full.Node{ node = value, ..} = findValueVariables location value
+
+    findValueVariables location (Full.Variable value') = [(value', [location])]
+    findValueVariables _ (Full.List values) = values >>= findNodeVariables
+    findValueVariables _ (Full.Object fields) = fields
+        >>= findNodeVariables . getField @"value"
+    findValueVariables _ _ = []
     makeError operationName (variableName, locations') = Error
         { message = errorMessage operationName variableName
         , locations = locations'

tests/Language/GraphQL/Validate/RulesSpec.hs

@@ -29,6 +29,7 @@ queryType = ObjectType "Query" Nothing [] $ HashMap.fromList
     [ ("dog", dogResolver)
     , ("cat", catResolver)
     , ("findDog", findDogResolver)
+    , ("findCats", findCatsResolver)
     ]
   where
     dogField = Field Nothing (Out.NamedObjectType dogType) mempty
@@ -39,6 +40,11 @@ queryType = ObjectType "Query" Nothing [] $ HashMap.fromList
     findDogResolver = ValueResolver findDogField $ pure Null
     catField = Field Nothing (Out.NamedObjectType catType) mempty
     catResolver = ValueResolver catField $ pure Null
+    findCatsArguments = HashMap.singleton "commands"
+        $ In.Argument Nothing (In.NonNullListType $ In.NonNullEnumType catCommandType)
+        $ Just $ List []
+    findCatsField = Field Nothing (Out.NonNullListType $ Out.NonNullObjectType catType) findCatsArguments
+    findCatsResolver = ValueResolver findCatsField $ pure $ List []
 
 catCommandType :: EnumType
 catCommandType = EnumType "CatCommand" Nothing $ HashMap.fromList
@@ -538,7 +544,7 @@ spec =
                         }
                  in validate queryString `shouldContain` [expected]
 
-        context "noUndefinedVariablesRule" $
+        context "noUndefinedVariablesRule" $ do
             it "rejects undefined variables" $
                 let queryString = [gql|
                   query variableIsNotDefinedUsedInSingleFragment {
@@ -560,7 +566,35 @@ spec =
                         }
                  in validate queryString `shouldBe` [expected]
 
-        context "noUnusedVariablesRule" $
+            it "gets variable location inside an input object" $
+                let queryString = [gql|
+                  query {
+                    findDog (complex: { name: $name }) {
+                      name
+                    }
+                  }
+                |]
+                    expected = Error
+                        { message = "Variable \"$name\" is not defined."
+                        , locations = [AST.Location 2 29]
+                        }
+                 in validate queryString `shouldBe` [expected]
+
+            it "gets variable location inside an array" $
+                let queryString = [gql|
+                  query {
+                    findCats (commands: [JUMP, $command]) {
+                      name
+                    }
+                  }
+                |]
+                    expected = Error
+                        { message = "Variable \"$command\" is not defined."
+                        , locations = [AST.Location 2 30]
+                        }
+                 in validate queryString `shouldBe` [expected]
+
+        context "noUnusedVariablesRule" $ do
             it "rejects unused variables" $
                 let queryString = [gql|
                   query variableUnused($atOtherHomes: Boolean) {
@@ -577,6 +611,16 @@ spec =
                         }
                  in validate queryString `shouldBe` [expected]
 
+            it "detects variables in properties of input objects" $
+                let queryString = [gql|
+                  query withVar ($name: String!) {
+                    findDog (complex: { name: $name }) {
+                      name
+                    }
+                  }
+                |]
+                 in validate queryString `shouldBe` []
+
         context "uniqueInputFieldNamesRule" $
             it "rejects duplicate fields in input objects" $
                 let queryString = [gql|