@graphprotocol/graph-cli 0.63.0-alpha-20231207223433-7216e44 → 0.63.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.63.0-alpha-20231207223433-7216e44
+## 0.63.0
 
 ### Minor Changes
 
@@ -12,6 +12,10 @@
   [`95eb9d0`](https://github.com/graphprotocol/graph-tooling/commit/95eb9d0244a99fdfb7a4750963c1a982d024dd87)
   Thanks [@mangas](https://github.com/mangas)! - substreams based triggers support
 
+- [#1535](https://github.com/graphprotocol/graph-tooling/pull/1535)
+  [`7d5c818`](https://github.com/graphprotocol/graph-tooling/commit/7d5c818fc832cf824421957b02ff3198bcf25a22)
+  Thanks [@saihaj](https://github.com/saihaj)! - add validation for handlers from subgraph manifest
+
 - [#1524](https://github.com/graphprotocol/graph-tooling/pull/1524)
   [`086a2da`](https://github.com/graphprotocol/graph-tooling/commit/086a2da03a4388277b69b6db541a0673dc9505bb)
   Thanks [@pedropregueiro](https://github.com/pedropregueiro)! - Add support for M3 apple silicon
@@ -19,6 +23,18 @@
 
 ### Patch Changes
 
+- [#1535](https://github.com/graphprotocol/graph-tooling/pull/1535)
+  [`7d5c818`](https://github.com/graphprotocol/graph-tooling/commit/7d5c818fc832cf824421957b02ff3198bcf25a22)
+  Thanks [@saihaj](https://github.com/saihaj)! - dependencies updates:
+
+  - Added dependency [`@babel/core@^7.20.5` ↗︎](https://www.npmjs.com/package/@babel/core/v/7.20.5)
+    (to `dependencies`)
+  - Added dependency
+    [`@babel/preset-typescript@^7.18.6` ↗︎](https://www.npmjs.com/package/@babel/preset-typescript/v/7.18.6)
+    (to `dependencies`)
+  - Added dependency [`memoizee@^0.4.15` ↗︎](https://www.npmjs.com/package/memoizee/v/0.4.15) (to
+    `dependencies`)
+
 - [#1521](https://github.com/graphprotocol/graph-tooling/pull/1521)
   [`3571a57`](https://github.com/graphprotocol/graph-tooling/commit/3571a571b2a094f41932e7cbc91b605c7ba0962c)
   Thanks [@saihaj](https://github.com/saihaj)! - remove studio network validation checks

package/dist/compiler/index.d.ts

@@ -59,6 +59,7 @@ export default class Compiler {
     _compileDataSourceMapping(protocol: Protocol, dataSource: immutable.Map<any, any>, mappingPath: string, compiledFiles: Map<any, any>, spinner: Spinner, validate?: boolean): any;
     _compileTemplateMapping(template: immutable.Collection<any, any>, mappingPath: string, compiledFiles: Map<any, any>, spinner: Spinner): any;
     _validateMappingContent(filePath: string): void;
+    _validateHandler(filePath: string, handlerName: string): void;
     writeSubgraphToOutputDirectory(protocol: Protocol, subgraph: immutable.Map<any, any>): Promise<any>;
     uploadSubgraphToIPFS(subgraph: immutable.Map<any, any>): Promise<any>;
     _uploadFileToIPFS(maybeRelativeFile: string, uploadedFiles: Map<any, any>, spinner: Spinner): Promise<immutable.Collection<unknown, unknown>>;

package/dist/compiler/index.js

@@ -33,6 +33,8 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const toolbox = __importStar(require("gluegun"));
 const immutable_1 = __importDefault(require("immutable"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
+const memoizee_1 = __importDefault(require("memoizee"));
+const core_1 = require("@babel/core");
 const spinner_1 = require("../command-helpers/spinner");
 const debug_1 = __importDefault(require("../debug"));
 const migrations_1 = require("../migrations");
@@ -40,6 +42,16 @@ const subgraph_1 = __importDefault(require("../subgraph"));
 const watcher_1 = __importDefault(require("../watcher"));
 const asc = __importStar(require("./asc"));
 const compilerDebug = (0, debug_1.default)('graph-cli:compiler');
+/** memoize the reading of the file so we don't have to read it every time */
+const readFile = (0, memoizee_1.default)((filename) => fs_extra_1.default.readFileSync(filename, 'utf-8'));
+/** Memoized parser for Babel, so we can simply just read from cache  */
+const babelAst = (0, memoizee_1.default)((filename) => {
+    const data = readFile(filename);
+    return (0, core_1.parseSync)(data, {
+        presets: ['@babel/preset-typescript'],
+        filename,
+    });
+});
 class Compiler {
     constructor(options) {
         this.options = options;
@@ -254,6 +266,12 @@ class Compiler {
             const absoluteMappingPath = path_1.default.resolve(baseDir, mappingPath);
             const inputFile = path_1.default.relative(baseDir, absoluteMappingPath);
             this._validateMappingContent(absoluteMappingPath);
+            const eventHandlers = dataSource.getIn(['mapping', 'eventHandlers']);
+            // TODO: improve the types
+            for (const eventHandler of eventHandlers.toJS()) {
+                compilerDebug('Validating Event Handler %s', eventHandler.handler);
+                this._validateHandler(absoluteMappingPath, eventHandler.handler);
+            }
             // If the file has already been compiled elsewhere, just use that output
             // file and return early
             const inputCacheKey = this.cacheKeyForFile(absoluteMappingPath);
@@ -304,6 +322,12 @@ class Compiler {
             const absoluteMappingPath = path_1.default.resolve(baseDir, mappingPath);
             const inputFile = path_1.default.relative(baseDir, absoluteMappingPath);
             this._validateMappingContent(absoluteMappingPath);
+            const eventHandlers = templateName.getIn(['mapping', 'eventHandlers']);
+            // TODO: improve the types
+            for (const eventHandler of eventHandlers.toJS()) {
+                compilerDebug('Validating Template handler %s', eventHandler.handler);
+                this._validateHandler(absoluteMappingPath, eventHandler.handler);
+            }
             // If the file has already been compiled elsewhere, just use that output
             // file and return early
             const inputCacheKey = this.cacheKeyForFile(absoluteMappingPath);
@@ -339,7 +363,7 @@ class Compiler {
         }
     }
     _validateMappingContent(filePath) {
-        const data = fs_extra_1.default.readFileSync(filePath);
+        const data = readFile(filePath);
         if (this.blockIpfsMethods && (data.includes('ipfs.cat') || data.includes('ipfs.map'))) {
             throw Error(`
       Subgraph Studio does not support mappings with ipfs methods.
@@ -348,6 +372,24 @@ class Compiler {
       `);
         }
     }
+    _validateHandler(filePath, handlerName) {
+        const baselAst = babelAst(filePath);
+        const body = baselAst?.program.body;
+        if (!body) {
+            throw Error(`Could not parse ${filePath}`);
+        }
+        const exportedFunctionNames = body
+            .map(statement => {
+            if (statement.type === 'ExportNamedDeclaration' &&
+                statement?.declaration?.type === 'FunctionDeclaration') {
+                return statement.declaration.id?.name;
+            }
+        })
+            .filter(Boolean);
+        if (!exportedFunctionNames.includes(handlerName)) {
+            throw Error(`Could not find handler '${handlerName}' in ${filePath}`);
+        }
+    }
     async writeSubgraphToOutputDirectory(protocol, subgraph) {
         const displayDir = `${this.displayPath(this.options.outputDir)}${toolbox.filesystem.separator}`;
         // ensure that the output directory exists

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.63.0-alpha-20231207223433-7216e44",
+  "version": "0.63.0",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.63.0-alpha-20231207223433-7216e44",
+  "version": "0.63.0",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -19,6 +19,8 @@
     "!dist/*.tar.gz"
   ],
   "dependencies": {
+    "@babel/core": "^7.20.5",
+    "@babel/preset-typescript": "^7.18.6",
     "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
     "@oclif/core": "2.8.6",
     "@oclif/plugin-autocomplete": "^2.3.6",
@@ -39,6 +41,7 @@
     "ipfs-http-client": "55.0.0",
     "jayson": "4.0.0",
     "js-yaml": "3.14.1",
+    "memoizee": "^0.4.15",
     "prettier": "1.19.1",
     "request": "2.88.2",
     "semver": "7.4.0",
@@ -49,10 +52,12 @@
     "yaml": "1.10.2"
   },
   "devDependencies": {
+    "@types/babel__core": "^7.20.5",
     "@types/debug": "^4.1.7",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^29.0.0",
     "@types/js-yaml": "^3.12.7",
+    "@types/memoizee": "^0.4.11",
     "@types/semver": "^7.3.13",
     "@types/which": "^2.0.1",
     "copyfiles": "^2.4.1",
@@ -61,8 +66,7 @@
     "spawn-command": "0.0.2-1",
     "strip-ansi": "6.0.1",
     "tern": "0.24.3",
-    "typescript": "^5.0.0",
-    "vitest": "^1.0.2"
+    "typescript": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -88,7 +92,6 @@
     "test:add": "jest tests/cli/add.test.ts --verbose",
     "test:init": "jest tests/cli/init.test.ts --verbose",
     "test:validation": "jest tests/cli/validation.test.ts --verbose",
-    "type-check": "tsc --noEmit",
-    "vitest:validation": "vitest tests/cli/validation.test.ts"
+    "type-check": "tsc --noEmit"
   }
 }