@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216170945-963badb

package/dist/commands/local.js

@@ -7,77 +7,30 @@ const child_process_1 = require("child_process");
 const http_1 = __importDefault(require("http"));
 const net_1 = __importDefault(require("net"));
 const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
 const docker_compose_1 = __importDefault(require("docker-compose"));
+const gluegun_1 = require("gluegun");
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
 const tmp_promise_1 = __importDefault(require("tmp-promise"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const spinner_1 = require("../command-helpers/spinner");
 // Clean up temporary files even when an uncaught exception occurs
 tmp_promise_1.default.setGracefulCleanup();
-const HELP = `
-${chalk_1.default.bold('graph local')} [options] ${chalk_1.default.bold('<local-command>')}
-
-Options:
-
-  -h, --help                    Show usage information
-      --node-logs               Print the Graph Node logs (optional)
-      --ethereum-logs           Print the Ethereum logs (optional)
-      --compose-file <file>     Custom Docker Compose file for additional services (optional)
-      --node-image <image>      Custom Graph Node image to test against (default: graphprotocol/graph-node:latest)
-      --standalone-node <cmd>   Use a standalone Graph Node outside Docker Compose (optional)
-      --standalone-node-args    Custom arguments to be passed to the standalone Graph Node (optional)
-      --skip-wait-for-ipfs      Don't wait for IPFS to be up at localhost:15001 (optional)
-      --skip-wait-for-ethereum  Don't wait for Ethereum to be up at localhost:18545 (optional)
-      --skip-wait-for-postgres  Don't wait for Postgres to be up at localhost:15432 (optional)
-      --timeout                 Time to wait for service containers. (optional, defaults to 120000 milliseconds)
-`;
-exports.default = {
-    description: 'Runs local tests against a Graph Node environment (using Ganache by default)',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { filesystem, print } = toolbox;
-        // Parse CLI parameters
-        let { composeFile, ethereumLogs, h, help, nodeImage, nodeLogs, skipWaitForEthereum, skipWaitForIpfs, skipWaitForPostgres, standaloneNode, standaloneNodeArgs, timeout, } = toolbox.parameters.options;
-        // Support both short and long option variants
-        help || (help = h);
-        // Extract test command
-        const params = (0, gluegun_1.fixParameters)(toolbox.parameters, {
-            ethereumLogs,
-            h,
-            help,
-            nodeLogs,
-            skipWaitForEthereum,
-            skipWaitForIpfs,
-            skipWaitForPostgres,
-        });
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
-        if (params.length == 0) {
-            print.error(`Test command not provided as the last argument`);
-            process.exitCode = 1;
-            return;
-        }
-        const testCommand = params[0];
+class LocalCommand extends core_1.Command {
+    async run() {
+        const { args: { 'local-command': testCommand }, flags: { 'compose-file': composeFileFlag, 'ethereum-logs': ethereumLogsFlag, 'node-image': nodeImage, 'node-logs': nodeLogsFlag, 'skip-wait-for-etherium': skipWaitForEthereum, 'skip-wait-for-ipfs': skipWaitForIpfs, 'skip-wait-for-postgres': skipWaitForPostgres, 'standalone-node': standaloneNode, 'standalone-node-args': standaloneNodeArgs, timeout, }, } = await this.parse(LocalCommand);
         // Obtain the Docker Compose file for services that the tests run against
-        composeFile || (composeFile = path_1.default.join(__dirname, '..', '..', 'resources', 'test', standaloneNode ? 'docker-compose-standalone-node.yml' : 'docker-compose.yml'));
-        // parse timeout. Defaults to 120 seconds
-        timeout = Math.abs(parseInt(timeout)) || 120000;
-        if (!filesystem.exists(composeFile)) {
-            print.error(`Docker Compose file \`${composeFile}\` not found`);
-            process.exitCode = 1;
-            return;
+        const composeFile = composeFileFlag ||
+            path_1.default.join(__dirname, '..', '..', 'resources', 'test', standaloneNode ? 'docker-compose-standalone-node.yml' : 'docker-compose.yml');
+        if (!gluegun_1.filesystem.exists(composeFile)) {
+            this.error(`Docker Compose file "${composeFile}" not found`, { exit: 1 });
         }
         // Create temporary directory to operate in
         const { path: tempdir } = await tmp_promise_1.default.dir({ prefix: 'graph-test', unsafeCleanup: true });
         try {
-            await configureTestEnvironment(toolbox, tempdir, composeFile, nodeImage);
+            await configureTestEnvironment(tempdir, composeFile, nodeImage);
         }
         catch (e) {
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Bring up test environment
@@ -85,9 +38,7 @@ exports.default = {
             await startTestEnvironment(tempdir);
         }
         catch (e) {
-            print.error(e);
-            process.exitCode = 1;
-            return;
+            this.error(e, { exit: 1 });
         }
         // Wait for test environment to come up
         try {
@@ -100,7 +51,7 @@ exports.default = {
         }
         catch (e) {
             await stopTestEnvironment(tempdir);
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Bring up Graph Node separately, if a standalone node is used
@@ -111,14 +62,13 @@ exports.default = {
                 nodeProcess = await startGraphNode(standaloneNode, standaloneNodeArgs, nodeOutputChunks);
             }
             catch (e) {
-                toolbox.print.error('');
-                toolbox.print.error('  Graph Node');
-                toolbox.print.error('  ----------');
-                toolbox.print.error(indent('  ', Buffer.concat(nodeOutputChunks).toString('utf-8')));
-                toolbox.print.error('');
                 await stopTestEnvironment(tempdir);
-                process.exitCode = 1;
-                return;
+                let errorMessage = '\n';
+                errorMessage += '  Graph Node';
+                errorMessage += '  ----------';
+                errorMessage += indent('  ', Buffer.concat(nodeOutputChunks).toString('utf-8'));
+                errorMessage += '\n';
+                this.error(errorMessage, { exit: 1 });
             }
         }
         // Wait for Graph Node to come up
@@ -126,14 +76,13 @@ exports.default = {
             await waitForGraphNode(timeout);
         }
         catch (e) {
-            toolbox.print.error('');
-            toolbox.print.error('  Graph Node');
-            toolbox.print.error('  ----------');
-            toolbox.print.error(indent('  ', await collectGraphNodeLogs(tempdir, standaloneNode, nodeOutputChunks)));
-            toolbox.print.error('');
             await stopTestEnvironment(tempdir);
-            process.exitCode = 1;
-            return;
+            let errorMessage = '\n';
+            errorMessage += '  Graph Node';
+            errorMessage += '  ----------';
+            errorMessage += indent('  ', await collectGraphNodeLogs(tempdir, standaloneNode, nodeOutputChunks));
+            errorMessage += '\n';
+            this.error(errorMessage, { exit: 1 });
         }
         // Run tests
         const result = await runTests(testCommand);
@@ -147,17 +96,16 @@ exports.default = {
             }
         }
         if (result.exitCode == 0) {
-            toolbox.print.success('✔ Tests passed');
+            this.log('✔ Tests passed');
         }
         else {
-            toolbox.print.error('✖ Tests failed');
+            this.log('✖ Tests failed');
         }
         // Capture logs
-        nodeLogs =
-            nodeLogs || result.exitCode !== 0
-                ? await collectGraphNodeLogs(tempdir, standaloneNode, nodeOutputChunks)
-                : undefined;
-        ethereumLogs = ethereumLogs ? await collectEthereumLogs(tempdir) : undefined;
+        const nodeLogs = nodeLogsFlag || result.exitCode !== 0
+            ? await collectGraphNodeLogs(tempdir, standaloneNode, nodeOutputChunks)
+            : undefined;
+        const ethereumLogs = ethereumLogsFlag ? await collectEthereumLogs(tempdir) : undefined;
         // Bring down the test environment
         try {
             await stopTestEnvironment(tempdir);
@@ -166,28 +114,70 @@ exports.default = {
             // do nothing (the spinner already logs the problem)
         }
         if (nodeLogs) {
-            toolbox.print.info('');
-            toolbox.print.info('  Graph node');
-            toolbox.print.info('  ----------');
-            toolbox.print.info('');
-            toolbox.print.info(indent('  ', nodeLogs));
+            this.log('');
+            this.log('  Graph node');
+            this.log('  ----------');
+            this.log('');
+            this.log(indent('  ', nodeLogs));
         }
         if (ethereumLogs) {
-            toolbox.print.info('');
-            toolbox.print.info('  Ethereum');
-            toolbox.print.info('  --------');
-            toolbox.print.info('');
-            toolbox.print.info(indent('  ', ethereumLogs));
+            this.log('');
+            this.log('  Ethereum');
+            this.log('  --------');
+            this.log('');
+            this.log(indent('  ', ethereumLogs));
         }
         // Always print the test output
-        toolbox.print.info('');
-        toolbox.print.info('  Output');
-        toolbox.print.info('  ------');
-        toolbox.print.info('');
-        toolbox.print.info(indent('  ', result.output));
+        this.log('');
+        this.log('  Output');
+        this.log('  ------');
+        this.log('');
+        this.log(indent('  ', result.output));
         // Propagate the exit code from the test run
-        process.exitCode = result.exitCode;
-    },
+        this.exit(result.exitCode);
+    }
+}
+exports.default = LocalCommand;
+LocalCommand.description = 'Runs local tests against a Graph Node environment (using Ganache by default).';
+LocalCommand.args = {
+    'local-command': core_1.Args.string({
+        required: true,
+    }),
+};
+LocalCommand.flags = {
+    'node-logs': core_1.Flags.boolean({
+        summary: 'Print the Graph Node logs.',
+    }),
+    'ethereum-logs': core_1.Flags.boolean({
+        summary: 'Print the Ethereum logs.',
+    }),
+    'compose-file': core_1.Flags.file({
+        summary: 'Custom Docker Compose file for additional services.',
+    }),
+    'node-image': core_1.Flags.string({
+        summary: 'Custom Graph Node image to test against.',
+        default: 'graphprotocol/graph-node:latest',
+    }),
+    'standalone-node': core_1.Flags.string({
+        summary: 'Use a standalone Graph Node outside Docker Compose.',
+    }),
+    'standalone-node-args': core_1.Flags.string({
+        summary: 'Custom arguments to be passed to the standalone Graph Node.',
+        dependsOn: ['standalone-node'],
+    }),
+    'skip-wait-for-ipfs': core_1.Flags.boolean({
+        summary: "Don't wait for IPFS to be up at localhost:15001",
+    }),
+    'skip-wait-for-etherium': core_1.Flags.boolean({
+        summary: "Don't wait for Ethereum to be up at localhost:18545",
+    }),
+    'skip-wait-for-postgres': core_1.Flags.boolean({
+        summary: "Don't wait for Postgres to be up at localhost:15432",
+    }),
+    timeout: core_1.Flags.integer({
+        summary: 'Time to wait for service containers in milliseconds.',
+        default: 120000,
+    }),
 };
 /**
  * Indents all lines of a string
@@ -198,14 +188,14 @@ const indent = (indentation, str) => str
     // Remove whitespace from empty lines
     .map(s => s.replace(/^\s+$/g, ''))
     .join('\n');
-const configureTestEnvironment = async (toolbox, tempdir, composeFile, nodeImage) => await (0, spinner_1.withSpinner)(`Configure test environment`, `Failed to configure test environment`, `Warnings configuring test environment`, async () => {
+const configureTestEnvironment = async (tempdir, composeFile, nodeImage) => await (0, spinner_1.withSpinner)(`Configure test environment`, `Failed to configure test environment`, `Warnings configuring test environment`, async () => {
     // Temporary compose file
     const tempComposeFile = path_1.default.join(tempdir, 'compose', 'docker-compose.yml');
     // Copy the compose file to the temporary directory
-    toolbox.filesystem.copy(composeFile, tempComposeFile);
+    gluegun_1.filesystem.copy(composeFile, tempComposeFile);
     // Substitute the graph-node image with the custom one, if appropriate
     if (nodeImage) {
-        await toolbox.patching.replace(tempComposeFile, 'graphprotocol/graph-node:latest', nodeImage);
+        await gluegun_1.patching.replace(tempComposeFile, 'graphprotocol/graph-node:latest', nodeImage);
     }
 });
 const waitFor = async (timeout, testFn) => {

package/dist/commands/remove.js

@@ -1,74 +1,33 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const url_1 = require("url");
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
 const auth_1 = require("../command-helpers/auth");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const node_1 = require("../command-helpers/node");
-const HELP = `
-${chalk_1.default.bold('graph remove')} ${chalk_1.default.dim('[options]')} ${chalk_1.default.bold('<subgraph-name>')}
-
-${chalk_1.default.dim('Options:')}
-
-      --access-token <token>    Graph access token
-  -h, --help                    Show usage information
-  -g, --node <url>              Graph node to create the subgraph in
-`;
-exports.default = {
-    description: 'Unregisters a subgraph name',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { print } = toolbox;
-        // Read CLI parameters
-        let { accessToken, g, h, help, node } = toolbox.parameters.options;
-        const subgraphName = toolbox.parameters.first;
-        // Support both long and short option variants
-        help || (help = h);
-        node || (node = g);
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
-        // Validate the subgraph name
-        if (!subgraphName) {
-            print.error('No subgraph name provided');
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
-        // Validate node
-        if (!node) {
-            print.error(`No Graph node provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
+class RemoveCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-name': subgraphName }, flags: { 'access-token': accessTokenFlag, node }, } = await this.parse(RemoveCommand);
         try {
             (0, node_1.validateNodeUrl)(node);
         }
         catch (e) {
-            print.error(`Graph node "${node}" is invalid: ${e.message}`);
-            process.exitCode = 1;
-            return;
+            this.error(`Graph node "${node}" is invalid: ${e.message}`, { exit: 1 });
         }
         const requestUrl = new url_1.URL(node);
         const client = (0, jsonrpc_1.createJsonRpcClient)(requestUrl);
         // Exit with an error code if the client couldn't be created
         if (!client) {
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Use the access token, if one is set
-        accessToken = await (0, auth_1.identifyDeployKey)(node, accessToken);
+        const accessToken = await (0, auth_1.identifyDeployKey)(node, accessTokenFlag);
         if (accessToken !== undefined && accessToken !== null) {
             // @ts-expect-error options property seems to exist
             client.options.headers = { Authorization: `Bearer ${accessToken}` };
         }
-        const spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
+        core_1.ux.action.start(`Removing subgraph in Graph node: ${requestUrl}`);
         client.request('subgraph_remove', { name: subgraphName }, (
         // @ts-expect-error TODO: why are the arguments not typed?
         requestError, 
@@ -79,17 +38,34 @@ exports.default = {
         // @ts-expect-error TODO: why are the arguments not typed?
         _res) => {
             if (jsonRpcError) {
-                spinner.fail(`Error removing the subgraph: ${jsonRpcError.message}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ Error removed the subgraph: ${jsonRpcError.message}`);
+                this.exit(1);
             }
             else if (requestError) {
-                spinner.fail(`HTTP error removing the subgraph: ${requestError.code}`);
-                process.exitCode = 1;
+                core_1.ux.action.stop(`✖ HTTP error removed the subgraph: ${requestError.code}`);
+                this.exit(1);
             }
             else {
-                spinner.stop();
-                print.success(`Removed subgraph: ${subgraphName}`);
+                core_1.ux.action.stop('Subgraph removed');
+                this.exit(1);
             }
         });
-    },
+    }
+}
+exports.default = RemoveCommand;
+RemoveCommand.description = 'Unregisters a subgraph name';
+RemoveCommand.args = {
+    'subgraph-name': core_1.Args.string({
+        required: true,
+    }),
+};
+RemoveCommand.flags = {
+    node: core_1.Flags.string({
+        summary: 'Graph node to delete the subgraph from.',
+        char: 'g',
+        required: true,
+    }),
+    'access-token': core_1.Flags.string({
+        summary: 'Graph access token.',
+    }),
 };