feat: validate graphql schema at build time

graphprotocol · Dec 13, 2023 · 055b47e · 055b47e
1 parent 45f3197
commit 055b47e
Show file tree

Hide file tree

Showing 4 changed files with 436 additions and 47 deletions.
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -31,6 +31,10 @@
     "@babel/core": "^7.20.5",
     "@babel/preset-typescript": "^7.18.6",
     "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
+    "@graphql-tools/graphql-file-loader": "^8.0.0",
+    "@graphql-tools/load": "^8.0.1",
+    "@graphql-tools/schema": "^10.0.2",
+    "@graphql-tools/url-loader": "^8.0.1",
     "@oclif/core": "2.8.6",
     "@oclif/plugin-autocomplete": "^2.3.6",
     "@oclif/plugin-not-found": "^2.4.0",

diff --git a/packages/cli/src/subgraph.ts b/packages/cli/src/subgraph.ts
@@ -76,11 +76,11 @@ export default class Subgraph {
     });
   }
 
-  static validateSchema(manifest: any, { resolveFile }: { resolveFile: ResolveFile }) {
+  static async validateSchema(manifest: any, { resolveFile }: { resolveFile: ResolveFile }) {
     subgraphDebug.extend('validate')('Validating schema in manifest');
     const filename = resolveFile(manifest.getIn(['schema', 'file']));
     subgraphDebug.extend('validate')('Loaded schema from %s', filename);
-    const validationErrors = validation.validateSchema(filename);
+    const validationErrors = await validation.validateSchema(filename);
     let errors: immutable.Collection<any, any>;
 
     if (validationErrors.size > 0) {
@@ -296,7 +296,7 @@ More than one template named '${name}', template names must be unique.`,
 
     // Validate the schema
     subgraphDebug.extend('manifest')('Validating schema');
-    Subgraph.validateSchema(manifest, { resolveFile });
+    await Subgraph.validateSchema(manifest, { resolveFile });
 
     // Perform other validations
     const protocolSubgraph = protocol.getSubgraph({

diff --git a/packages/cli/src/validation/schema.ts b/packages/cli/src/validation/schema.ts
@@ -1,7 +1,12 @@
-import fs from 'fs';
+import * as fs from 'node:fs';
 import * as graphql from 'graphql/language';
 import immutable from 'immutable';
+import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
+import { loadSchema as toolsLoadSchema } from '@graphql-tools/load';
+import { mergeSchemas } from '@graphql-tools/schema';
+import { UrlLoader } from '@graphql-tools/url-loader';
 import debugFactory from '../debug';
+import fetchWrapper from '../fetch';
 
 const validateDebugger = debugFactory('graph-cli:validation');
 
@@ -1041,11 +1046,38 @@ const validateNamingCollisions = (local: any[], imported: any) => {
   return validateNamingCollisionsInTypes(local.concat(imported));
 };
 
-export const validateSchema = (filename: string) => {
+// TODO - temporarily not using `master` see https://github.com/graphprotocol/graph-node/pull/5069
+// const META_SCHEMA_GRAPH_NODE= "https://raw.githubusercontent.com/graphprotocol/graph-node/master/graph/src/schema/meta.graphql"
+const META_SCHEMA_GRAPH_NODE =
+  'https://raw.githubusercontent.com/graphprotocol/graph-node/saihaj/fix-meta-schema/graph/src/schema/meta.graphql';
+
+export const validateSchema = async (filename: string) => {
   validateDebugger('Validating schema: %s', filename);
-  const doc = loadSchema(filename);
-  validateDebugger('Loaded schema: %s', filename);
-  const schema = parseSchema(doc);
+
+  try {
+    const [doc, metaSchema] = await Promise.all([
+      toolsLoadSchema(filename, {
+        loaders: [new GraphQLFileLoader()],
+        assumeValid: true,
+        assumeValidSDL: true,
+      }),
+      toolsLoadSchema(META_SCHEMA_GRAPH_NODE, {
+        loaders: [new UrlLoader()],
+        fetch: fetchWrapper,
+      }),
+    ]);
+    console.log('doc', doc);
+    validateDebugger('Loaded schema: %s', filename);
+
+    const b = mergeSchemas({
+      schemas: [metaSchema],
+    });
+    console.log(b);
+  } catch (e) {
+    console.trace('Error', e);
+  }
+
+  const schema = parseSchema(loadSchema(filename));
   validateDebugger.extend('schema')('Parsed schema: %M', schema);
 
   return List.of(