mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-18 21:12:09 +03:00
8ccf7724ce
The code that builds the GraphQL schema, and `buildGQLContext` in particular, is partial: not every value of `(ServerConfigCtx, GraphQLQueryType, SourceCache, HashMap RemoteSchemaName (RemoteSchemaCtx, MetadataObject), ActionCache, AnnotatedCustomTypes)` results in a valid GraphQL schema. When it fails, we want to be able to return better error messages than we currently do. The key thing that is missing is a way to trace back GraphQL type information to their origin from the Hasura metadata. Currently, we have a number of correctness checks of our GraphQL schema. But these correctness checks only have access to pure GraphQL type information, and hence can only report errors in terms of that. Possibly the worst is the "conflicting definitions" error, which, in practice, can only be debugged by Hasura engineers. This is terrible DX for customers. This PR allows us to print better error messages, by adding a field to the `Definition` type that traces the GraphQL type to its origin in the metadata. So the idea is simple: just add `MetadataObjId`, or `Maybe` that, or some other sum type of that, to `Definition`. However, we want to avoid having to import a `Hasura.RQL` module from `Hasura.GraphQL.Parser`. So we instead define this additional field of `Definition` through a new type parameter, which is threaded through in `Hasura.GraphQL.Parser`. We then define type synonyms in `Hasura.GraphQL.Schema.Parser` that fill in this type parameter, so that it is not visible for the majority of the codebase. The idea of associating metadata information to `Definition`s really comes to fruition when combined with hasura/graphql-engine-mono#4517. Their combination would allow us to use the API of fatal errors (just like the current `MonadError QErr`) to report _inconsistencies_ in the metadata. Such inconsistencies are then _automatically_ ignored. So no ad-hoc decisions need to be made on how to cut out inconsistent metadata from the GraphQL schema. This will allow us to report much better errors, as well as improve the likelihood of a successful HGE startup. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4770 Co-authored-by: Samir Talwar <47582+SamirTalwar@users.noreply.github.com> GitOrigin-RevId: 728402b0cae83ae8e83463a826ceeb609001acae
30 lines
1.0 KiB
Haskell
30 lines
1.0 KiB
Haskell
module Hasura.GraphQL.Parser.DirectivesTest (spec) where
|
|
|
|
import Data.Dependent.Map qualified as DM
|
|
import Data.Text qualified as T
|
|
import Hasura.GraphQL.Parser.Directives hiding (Directive)
|
|
import Hasura.GraphQL.Parser.TestUtils
|
|
import Hasura.GraphQL.Schema.Parser
|
|
import Hasura.Prelude
|
|
import Language.GraphQL.Draft.Syntax qualified as G
|
|
import Test.Hspec
|
|
|
|
spec :: Spec
|
|
spec = do
|
|
testDirective skipDirective skip
|
|
testDirective includeDirective include
|
|
testDirective cachedDirective cached
|
|
testDirective multipleRootFieldsDirective multipleRootFields
|
|
|
|
testDirective :: Directive TestMonad -> DirectiveKey a -> Spec
|
|
testDirective dir key = do
|
|
let name = diName $ dDefinition dir
|
|
location = head $ diLocations $ dDefinition dir
|
|
directive = fakeDirective $ dDefinition dir
|
|
describe (T.unpack $ G.unName name) $ do
|
|
it "has the same type in the key and the directive" $
|
|
flip shouldBe (Right True) $
|
|
runTest $ do
|
|
dmap <- parseDirectives [dir] location [directive]
|
|
pure $ isJust $ runIdentity <$> DM.lookup key dmap
|