Fix values not being coerced to lists

…in executor error messages.

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on
 and this project adheres to
 [Haskell Package Versioning Policy](https://pvp.haskell.org/).
 
+## [Unreleased]
+### Fixed
+- `gql` removes not only leading `\n` but also `\r`.
+- Fix non nullable type string representation in executor error messages.
+
 ## [1.2.0.1] - 2023-04-25
 ### Fixed
 - Support hspec 2.11.
@@ -508,6 +513,7 @@ 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.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

@@ -21,7 +21,8 @@ extra-source-files:
   CHANGELOG.md
   README.md
 tested-with:
-  GHC == 9.2.5
+  GHC == 9.2.8,
+  GHC == 9.6.3
 
 source-repository head
   type: git
@@ -105,4 +106,6 @@ test-suite graphql-test
     unordered-containers,
     containers,
     vector
+  build-tool-depends:
+    hspec-discover:hspec-discover
   default-language: Haskell2010

src/Language/GraphQL/AST/Document.hs

@@ -371,8 +371,8 @@ data NonNullType
     deriving Eq
 
 instance Show NonNullType where
-    show (NonNullTypeNamed typeName) = '!' : Text.unpack typeName
+    show (NonNullTypeNamed typeName) = Text.unpack $ typeName <> "!"
-    show (NonNullTypeList listType) =  concat ["![", show listType, "]"]
+    show (NonNullTypeList listType) = concat ["[", show listType, "]!"]
 
 -- ** Directives
 

src/Language/GraphQL/Execute.hs

@@ -556,33 +556,24 @@ coerceArgumentValues argumentDefinitions argumentValues =
                     $ Just inputValue
                 | otherwise -> throwM
                     $ InputCoercionException (Text.unpack argumentName) variableType Nothing
+
     matchFieldValues' = matchFieldValues coerceArgumentValue
         $ Full.node <$> argumentValues
-    coerceArgumentValue inputType (Transform.Int integer) =
+
-        coerceInputLiteral inputType (Type.Int integer)
+    coerceArgumentValue inputType transform =
-    coerceArgumentValue inputType (Transform.Boolean boolean) =
+      coerceInputLiteral inputType $ extractArgumentValue transform 
-        coerceInputLiteral inputType (Type.Boolean boolean)
+
-    coerceArgumentValue inputType (Transform.String string) =
+    extractArgumentValue (Transform.Int integer) = Type.Int integer
-        coerceInputLiteral inputType (Type.String string)
+    extractArgumentValue (Transform.Boolean boolean) = Type.Boolean boolean
-    coerceArgumentValue inputType (Transform.Float float) =
+    extractArgumentValue (Transform.String string) = Type.String string
-        coerceInputLiteral inputType (Type.Float float)
+    extractArgumentValue (Transform.Float float) = Type.Float float
-    coerceArgumentValue inputType (Transform.Enum enum) =
+    extractArgumentValue (Transform.Enum enum) = Type.Enum enum
-        coerceInputLiteral inputType (Type.Enum enum)
+    extractArgumentValue Transform.Null = Type.Null
-    coerceArgumentValue inputType Transform.Null
+    extractArgumentValue (Transform.List list) = 
-        | In.isNonNullType inputType = Nothing
+      Type.List $ extractArgumentValue <$> list
-        | otherwise = coerceInputLiteral inputType Type.Null
+    extractArgumentValue (Transform.Object object) =
-    coerceArgumentValue (In.ListBaseType inputType) (Transform.List list) =
+      Type.Object $ extractArgumentValue <$> object
-        let coerceItem = coerceArgumentValue inputType
+    extractArgumentValue (Transform.Variable variable) = variable
-         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
 
 collectFields :: Monad m
     => Out.ObjectType m

src/Language/GraphQL/TH.hs

@@ -21,7 +21,7 @@ stripIndentation code = reverse
     indent count (' ' : xs) = indent (count - 1) xs
     indent _ xs = xs
     withoutLeadingNewlines = dropNewlines code
-    dropNewlines = dropWhile (== '\n')
+    dropNewlines = dropWhile $ flip any ['\n', '\r'] . (==)
     spaces = length $ takeWhile (== ' ') withoutLeadingNewlines
 
 -- | Removes leading and trailing newlines. Indentation of the first line is

src/Language/GraphQL/Type/Definition.hs

@@ -18,6 +18,8 @@ module Language.GraphQL.Type.Definition
     , float
     , id
     , int
+    , showNonNullType
+    , showNonNullListType
     , selection
     , string
     ) where
@@ -207,3 +209,11 @@ include = handle include'
             (Just (Boolean True)) -> Include directive'
             _ -> Skip
     include' directive' = Continue directive'
+
+showNonNullType :: Show a => a -> String
+showNonNullType = (++ "!") . show
+
+showNonNullListType :: Show a => a -> String
+showNonNullListType listType =
+    let representation = show listType
+     in concat ["[", representation, "]!"]

src/Language/GraphQL/Type/In.hs

@@ -66,10 +66,11 @@ instance Show Type where
     show (NamedEnumType enumType) = show enumType
     show (NamedInputObjectType inputObjectType) = show inputObjectType
     show (ListType baseType) = concat ["[", show baseType, "]"]
-    show (NonNullScalarType scalarType) = '!' : show scalarType
+    show (NonNullScalarType scalarType) = Definition.showNonNullType scalarType
-    show (NonNullEnumType enumType) = '!' : show enumType
+    show (NonNullEnumType enumType) = Definition.showNonNullType enumType
-    show (NonNullInputObjectType inputObjectType) = '!' : show inputObjectType
+    show (NonNullInputObjectType inputObjectType) =
-    show (NonNullListType baseType) = concat ["![", show baseType, "]"]
+        Definition.showNonNullType inputObjectType
+    show (NonNullListType baseType) = Definition.showNonNullListType baseType
 
 -- | Field argument definition.
 data Argument = Argument (Maybe Text) Type (Maybe Definition.Value)

src/Language/GraphQL/Type/Out.hs

@@ -115,12 +115,12 @@ instance forall a. Show (Type a) where
     show (NamedInterfaceType interfaceType) = show interfaceType
     show (NamedUnionType unionType) = show unionType
     show (ListType baseType) = concat ["[", show baseType, "]"]
-    show (NonNullScalarType scalarType) = '!' : show scalarType
+    show (NonNullScalarType scalarType) = showNonNullType scalarType
-    show (NonNullEnumType enumType) = '!' : show enumType
+    show (NonNullEnumType enumType) = showNonNullType enumType
-    show (NonNullObjectType inputObjectType) = '!' : show inputObjectType
+    show (NonNullObjectType inputObjectType) = showNonNullType inputObjectType
-    show (NonNullInterfaceType interfaceType) = '!' : show interfaceType
+    show (NonNullInterfaceType interfaceType) = showNonNullType interfaceType
-    show (NonNullUnionType unionType) = '!' : show unionType
+    show (NonNullUnionType unionType) = showNonNullType unionType
-    show (NonNullListType baseType) = concat ["![", show baseType, "]"]
+    show (NonNullListType baseType) = showNonNullListType baseType
 
 -- | Matches either 'NamedScalarType' or 'NonNullScalarType'.
 pattern ScalarBaseType :: forall m. ScalarType -> Type m

tests/Language/GraphQL/ExecuteSpec.hs

@@ -295,7 +295,7 @@ spec =
                 let data'' = Object $ HashMap.singleton "philosopher" Null
                     executionErrors = pure $ Error
                         { message =
-                            "Value completion error. Expected type !School, found: EXISTENTIALISM."
+                            "Value completion error. Expected type School!, found: EXISTENTIALISM."
                         , locations = [Location 1 17]
                         , path = [Segment "philosopher", Segment "school"]
                         }
@@ -307,7 +307,7 @@ spec =
                 let data'' = Object $ HashMap.singleton "philosopher" Null
                     executionErrors = pure $ Error
                         { message =
-                            "Value completion error. Expected type !Interest, found: { instrument: \"piano\" }."
+                            "Value completion error. Expected type Interest!, found: { instrument: \"piano\" }."
                         , locations = [Location 1 17]
                         , path = [Segment "philosopher", Segment "interest"]
                         }
@@ -319,7 +319,7 @@ spec =
                 let data'' = Object $ HashMap.singleton "philosopher" Null
                     executionErrors = pure $ Error
                         { message
-                            = "Value completion error. Expected type !Work, found:\
+                            = "Value completion error. Expected type Work!, found:\
                             \ { title: \"Also sprach Zarathustra: Ein Buch f\252r Alle und Keinen\" }."
                         , locations = [Location 1 17]
                         , path = [Segment "philosopher", Segment "majorWork"]
@@ -343,7 +343,7 @@ spec =
             it "gives location information for failed result coercion" $
                 let data'' = Object $ HashMap.singleton "philosopher" Null
                     executionErrors = pure $ Error
-                        { message = "Unable to coerce result to !Int."
+                        { message = "Unable to coerce result to Int!."
                         , locations = [Location 1 26]
                         , path = [Segment "philosopher", Segment "century"]
                         }
@@ -364,7 +364,7 @@ spec =
 
             it "sets data to null if a root field isn't nullable" $
                 let executionErrors = pure $ Error
-                        { message = "Unable to coerce result to !Int."
+                        { message = "Unable to coerce result to Int!."
                         , locations = [Location 1 3]
                         , path = [Segment "count"]
                         }
@@ -375,7 +375,7 @@ spec =
             it "detects nullability errors" $
                 let data'' = Object $ HashMap.singleton "philosopher" Null
                     executionErrors = pure $ Error
-                        { message = "Value completion error. Expected type !String, found: null."
+                        { message = "Value completion error. Expected type String!, found: null."
                         , locations = [Location 1 26]
                         , path = [Segment "philosopher", Segment "firstLanguage"]
                         }

tests/Language/GraphQL/Validate/RulesSpec.hs

@@ -878,7 +878,7 @@ spec =
                         { message =
                             "Variable \"$dogCommandArg\" of type \
                             \\"DogCommand\" used in position expecting type \
-                            \\"!DogCommand\"."
+                            \\"DogCommand!\"."
                         , locations = [AST.Location 1 26]
                         }
                  in validate queryString `shouldBe` [expected]
@@ -925,7 +925,7 @@ spec =
                 |]
                     expected = Error
                         { message =
-                            "Value 3 cannot be coerced to type \"!CatCommand\"."
+                            "Value 3 cannot be coerced to type \"CatCommand!\"."
                         , locations = [AST.Location 3 36]
                         }
                  in validate queryString `shouldBe` [expected]
@@ -940,7 +940,7 @@ spec =
                 |]
                     expected = Error
                         { message =
-                            "Value 3 cannot be coerced to type \"!String\"."
+                            "Value 3 cannot be coerced to type \"String!\"."
                         , locations = [AST.Location 2 28]
                         }
                  in validate queryString `shouldBe` [expected]