@graphprotocol/graph-cli 0.78.0 → 0.78.1-alpha-20240716210753-d878dfa

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @graphprotocol/graph-cli
 
+## 0.78.1-alpha-20240716210753-d878dfa
+
+### Patch Changes
+
+- [#1549](https://github.com/graphprotocol/graph-tooling/pull/1549)
+  [`c7fb38a`](https://github.com/graphprotocol/graph-tooling/commit/c7fb38a55b7a0a355aa94c243f2dc99882023077)
+  Thanks [@YassinEldeeb](https://github.com/YassinEldeeb)! - testing napi bindings
+
 ## 0.78.0
 
 ### Minor Changes

package/README.md

@@ -18,8 +18,7 @@ As of today, the command line interface supports the following commands:
   the system's keychain.
 - `graph local` — Runs tests against a [Graph Node](https://github.com/graphprotocol/graph-node)
   test environment (using Ganache by default).
-- `graph test` — Downloads and runs the [Matchstick](https://github.com/LimeChain/matchstick) rust
-  binary in order to test a subgraph.
+- `graph test` — Runs tests against the subgraph.
 - `graph add` - Adds a new datasource to the yaml file and writes the necessary changes to other
   files - schema.graphql, abi and mapping.
 - `graph publish` - Publishes the subgraph to the Graph Network.

package/dist/commands/test.d.ts

@@ -7,7 +7,6 @@ export default class TestCommand extends Command {
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         coverage: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        docker: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         logs: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         recompile: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/dist/commands/test.js

@@ -3,19 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = require("child_process");
-const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-const binary_install_raw_1 = require("binary-install-raw");
 const gluegun_1 = require("gluegun");
 const js_yaml_1 = __importDefault(require("js-yaml"));
-const semver_1 = __importDefault(require("semver"));
+// This'd import the N-API bindings based on the OS and architecture
+const testing_1 = require("@graphprotocol/graph-tooling-napi-utils/mod/testing");
 const core_1 = require("@oclif/core");
-const constants_1 = require("../constants");
-const fetch_1 = __importDefault(require("../fetch"));
 class TestCommand extends core_1.Command {
     async run() {
-        const { args: { datasource }, flags: { coverage, docker, force, logs, recompile, version }, } = await this.parse(TestCommand);
+        const { args: { datasource }, flags: { coverage, force, logs, recompile, version }, } = await this.parse(TestCommand);
         let testsDir = './tests';
         // Check if matchstick.yaml config exists
         if (gluegun_1.filesystem.exists('matchstick.yaml')) {
@@ -39,36 +35,13 @@ class TestCommand extends core_1.Command {
             testsDir,
             cachePath,
             coverage,
-            docker,
             force,
             logs,
             recompile,
             version,
             latestVersion: getLatestVersionFromCache(cachePath),
         };
-        // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
-        if (opts.force || (!opts.version && !opts.latestVersion)) {
-            this.log('Fetching latest version tag...');
-            const result = await (0, fetch_1.default)('https://api.github.com/repos/LimeChain/matchstick/releases/latest', {
-                headers: {
-                    ...constants_1.GRAPH_CLI_SHARED_HEADERS,
-                },
-            });
-            const json = await result.json();
-            opts.latestVersion = json.tag_name;
-            gluegun_1.filesystem.file(opts.cachePath, {
-                content: {
-                    version: json.tag_name,
-                    timestamp: Date.now(),
-                },
-            });
-        }
-        if (opts.docker) {
-            runDocker.bind(this)(datasource, opts);
-        }
-        else {
-            runBinary.bind(this)(datasource, opts);
-        }
+        runNapi.bind(this)(datasource, opts);
     }
 }
 TestCommand.description = 'Runs rust binary for subgraph testing.';
@@ -83,12 +56,8 @@ TestCommand.flags = {
         summary: 'Run the tests in coverage mode.',
         char: 'c',
     }),
-    docker: core_1.Flags.boolean({
-        summary: 'Run the tests in a docker container (Note: Please execute from the root folder of the subgraph).',
-        char: 'd',
-    }),
     force: core_1.Flags.boolean({
-        summary: 'Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image.',
+        summary: 'Binary - overwrites folder + file when downloading.',
         char: 'f',
     }),
     logs: core_1.Flags.boolean({
@@ -117,186 +86,21 @@ function getLatestVersionFromCache(cachePath) {
     }
     return null;
 }
-async function runBinary(datasource, opts) {
-    const coverageOpt = opts.coverage;
-    const forceOpt = opts.force;
-    const logsOpt = opts.logs;
-    const versionOpt = opts.version;
-    const latestVersion = opts.latestVersion;
-    const recompileOpt = opts.recompile;
-    const platform = await getPlatform.bind(this)(versionOpt || latestVersion, logsOpt);
-    const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt || latestVersion}/${platform}`;
-    if (logsOpt) {
-        this.log(`Download link: ${url}`);
-    }
-    const binary = new binary_install_raw_1.Binary(platform, url, versionOpt || latestVersion);
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-    forceOpt ? await binary.install(true) : await binary.install(false);
+async function runNapi(datasource, opts) {
     const args = [];
-    if (coverageOpt)
-        args.push('-c');
-    if (recompileOpt)
-        args.push('-r');
+    if (opts.coverage)
+        args.push('--coverage');
+    if (opts.recompile)
+        args.push('--recompile');
     if (datasource)
         args.push(datasource);
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-    args.length > 0 ? binary.run(...args) : binary.run();
-}
-async function getPlatform(matchstickVersion, logsOpt) {
-    const type = os_1.default.type();
-    const arch = os_1.default.arch();
-    const cpuCore = os_1.default.cpus()[0];
-    const isAppleSilicon = arch === 'arm64' && /Apple (M1|M2|M3|processor)/.test(cpuCore.model);
-    const linuxInfo = type === 'Linux' ? await getLinuxInfo.bind(this)() : {};
-    const linuxDistro = linuxInfo.name;
-    const release = linuxInfo.version || os_1.default.release();
-    const majorVersion = parseInt(linuxInfo.version || '', 10) || semver_1.default.major(release);
-    if (logsOpt) {
-        this.log(`OS type: ${linuxDistro || type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`);
-    }
-    if (arch === 'x64' || isAppleSilicon) {
-        if (semver_1.default.gt(matchstickVersion, '0.5.4')) {
-            if (type === 'Darwin') {
-                if (isAppleSilicon) {
-                    return 'binary-macos-12-m1';
-                }
-                return 'binary-macos-12';
-            }
-            if (type === 'Linux' && majorVersion === 22) {
-                return 'binary-linux-22';
-            }
-        }
-        else {
-            if (type === 'Darwin') {
-                if (majorVersion === 18 || majorVersion === 19) {
-                    return 'binary-macos-10.15';
-                }
-                if (isAppleSilicon) {
-                    return 'binary-macos-11-m1';
-                }
-                return 'binary-macos-11';
-            }
-            if (type === 'Linux') {
-                return majorVersion === 18
-                    ? 'binary-linux-18'
-                    : majorVersion === 22
-                        ? 'binary-linux-22'
-                        : 'binary-linux-20';
-            }
-        }
-    }
-    throw new Error(`Unsupported platform: ${type} ${arch} ${majorVersion}`);
-}
-async function getLinuxInfo() {
     try {
-        const result = await gluegun_1.system.run("cat /etc/*-release | grep -E '(^VERSION|^NAME)='", {
-            trim: true,
-        });
-        const infoArray = result
-            .replace(/['"]+/g, '')
-            .split('\n')
-            .map(p => p.split('='));
-        const linuxInfo = {};
-        for (const val of infoArray) {
-            linuxInfo[val[0].toLowerCase()] = val[1];
-        }
-        return linuxInfo;
-    }
-    catch (error) {
-        this.error(`Error fetching the Linux version:\n${error}`, { exit: 1 });
-    }
-}
-async function runDocker(datasource, opts) {
-    const coverageOpt = opts.coverage;
-    const forceOpt = opts.force;
-    const versionOpt = opts.version;
-    const latestVersion = opts.latestVersion;
-    const recompileOpt = opts.recompile;
-    // Remove binary-install-raw binaries, because docker has permission issues
-    // when building the docker images
-    gluegun_1.filesystem.remove('./node_modules/binary-install-raw/bin');
-    // Get current working directory
-    const current_folder = gluegun_1.filesystem.cwd();
-    // Declate dockerfilePath with default location
-    const dockerfilePath = path_1.default.join(opts.testsDir, '.docker/Dockerfile');
-    // Check if the Dockerfil already exists
-    const dockerfileExists = gluegun_1.filesystem.exists(dockerfilePath);
-    // Generate the Dockerfile only if it doesn't exists,
-    // version flag and/or force flag is passed.
-    if (!dockerfileExists || versionOpt || forceOpt) {
-        await dockerfile.bind(this)(dockerfilePath, versionOpt, latestVersion);
-    }
-    // Run a command to check if matchstick image already exists
-    (0, child_process_1.exec)('docker images -q matchstick', (_error, stdout, _stderr) => {
-        // Collect all(if any) flags and options that have to be passed to the matchstick binary
-        let testArgs = '';
-        if (coverageOpt)
-            testArgs = testArgs + ' -c';
-        if (recompileOpt)
-            testArgs = testArgs + ' -r';
-        if (datasource)
-            testArgs = testArgs + ' ' + datasource;
-        // Build the `docker run` command options and flags
-        const dockerRunOpts = [
-            'run',
-            '-it',
-            '--rm',
-            '--mount',
-            `type=bind,source=${current_folder},target=/matchstick`,
-        ];
-        if (testArgs !== '') {
-            dockerRunOpts.push('-e');
-            dockerRunOpts.push(`ARGS=${testArgs.trim()}`);
-        }
-        dockerRunOpts.push('matchstick');
-        // If a matchstick image does not exists, the command returns an empty string,
-        // else it'll return the image ID. Skip `docker build` if an image already exists
-        // Delete current image(if any) and rebuild.
-        // Use spawn() and {stdio: 'inherit'} so we can see the logs in real time.
-        if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
-            if (stdout !== '') {
-                (0, child_process_1.exec)('docker image rm matchstick', (_error, stdout, _stderr) => {
-                    this.log(`Remove matchstick image result:\n${stdout}`);
-                });
-            }
-            // Build a docker image. If the process has executed successfully
-            // run a container from that image.
-            (0, child_process_1.spawn)('docker', ['build', '-f', dockerfilePath, '-t', 'matchstick', '.'], {
-                stdio: 'inherit',
-            }).on('close', code => {
-                if (code === 0) {
-                    (0, child_process_1.spawn)('docker', dockerRunOpts, { stdio: 'inherit' });
-                }
-            });
-        }
-        else {
-            this.log('Docker image already exists. Skipping `docker build` command...');
-            // Run the container from the existing matchstick docker image
-            (0, child_process_1.spawn)('docker', dockerRunOpts, { stdio: 'inherit' });
-        }
-    });
-}
-// Downloads Dockerfile template from the demo-subgraph repo
-// Replaces the placeholders with their respective values
-async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
-    const spinner = gluegun_1.print.spin('Generating Dockerfile...');
-    try {
-        // Fetch the Dockerfile template content from the demo-subgraph repo
-        const content = await (0, fetch_1.default)('https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile').then(response => {
-            if (response.ok) {
-                return response.text();
-            }
-            throw new Error(`Status Code: ${response.status}, with error: ${response.statusText}`);
-        });
-        // Write the Dockerfile
-        gluegun_1.filesystem.write(dockerfilePath, content);
-        // Replaces the version placeholders
-        await gluegun_1.patching.replace(dockerfilePath, '<MATCHSTICK_VERSION>', versionOpt || latestVersion || 'unknown');
+        // Call the N-API function
+        (0, testing_1.runTests)(args);
     }
     catch (error) {
-        this.error(`A problem occurred while generating the Dockerfile:\n${error.message}`, {
+        this.error(`Error running tests:\n${error.message}`, {
             exit: 1,
         });
     }
-    spinner.succeed('Successfully generated Dockerfile.');
 }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.78.0",
+  "version": "0.78.1-alpha-20240716210753-d878dfa",
   "commands": {
     "add": {
       "id": "add",
@@ -880,18 +880,11 @@
           "summary": "Run the tests in coverage mode.",
           "allowNo": false
         },
-        "docker": {
-          "name": "docker",
-          "type": "boolean",
-          "char": "d",
-          "summary": "Run the tests in a docker container (Note: Please execute from the root folder of the subgraph).",
-          "allowNo": false
-        },
         "force": {
           "name": "force",
           "type": "boolean",
           "char": "f",
-          "summary": "Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image.",
+          "summary": "Binary - overwrites folder + file when downloading.",
           "allowNo": false
         },
         "logs": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.78.0",
+  "version": "0.78.1-alpha-20240716210753-d878dfa",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -46,7 +46,8 @@
     "tmp-promise": "3.0.3",
     "web3-eth-abi": "1.7.0",
     "which": "2.0.2",
-    "yaml": "1.10.2"
+    "yaml": "1.10.2",
+    "@graphprotocol/graph-tooling-napi-utils": "0.0.1"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",