@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216174117-760a195

package/dist/commands/deploy.js

@@ -28,11 +28,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 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 compiler_1 = require("../command-helpers/compiler");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const ipfs_1 = require("../command-helpers/ipfs");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const network_1 = require("../command-helpers/network");
@@ -40,100 +39,15 @@ const node_1 = require("../command-helpers/node");
 const studio_1 = require("../command-helpers/studio");
 const version_1 = require("../command-helpers/version");
 const protocols_1 = __importDefault(require("../protocols"));
-const HELP = `
-${chalk_1.default.bold('graph deploy')} [options] ${chalk_1.default.bold('<subgraph-name>')} ${chalk_1.default.bold('[<subgraph-manifest>]')}
-
-Options:
-
-        --product <subgraph-studio|hosted-service>
-                                Selects the product to which to deploy
-        --studio                  Shortcut for --product subgraph-studio
-  -g,   --node <node>             Graph node to which to deploy
-        --deploy-key <key>        User deploy key
-  -l    --version-label <label>   Version label used for the deployment
-  -h,   --help                    Show usage information
-  -i,   --ipfs <node>             Upload build results to an IPFS node (default: ${ipfs_1.DEFAULT_IPFS_URL})
-  -hdr, --headers <map>           Add custom headers that will be used by the IPFS HTTP client (default: {})
-        --debug-fork              ID of a remote subgraph whose store will be GraphQL queried
-  -o,   --output-dir <path>       Output directory for build results (default: build/)
-        --skip-migrations         Skip subgraph migrations (default: false)
-  -w,   --watch                   Regenerate types when subgraph files change (default: false)
-        --network <name>          Network configuration to use from the networks config file
-        --network-file <path>     Networks config file path (default: "./networks.json")
-`;
-const processForm = async (toolbox, { product, studio, node, versionLabel }) => {
-    const questions = [
-        {
-            type: 'select',
-            name: 'product',
-            message: 'Product for which to deploy',
-            choices: ['subgraph-studio', 'hosted-service'],
-            skip: product === 'subgraph-studio' ||
-                product === 'hosted-service' ||
-                studio !== undefined ||
-                node !== undefined,
-        },
-        {
-            type: 'input',
-            name: 'versionLabel',
-            message: 'Version Label (e.g. v0.0.1)',
-            skip: versionLabel !== undefined,
-        },
-    ];
-    try {
-        const answers = await toolbox.prompt.ask(questions);
-        return answers;
-    }
-    catch (e) {
-        return undefined;
-    }
-};
-exports.default = {
-    description: 'Deploys the subgraph to a Graph node',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { filesystem, print } = toolbox;
-        // Parse CLI parameters
-        let { product, studio, deployKey, accessToken, versionLabel, l, g, h, i, help, ipfs, headers, hdr, node, o, outputDir, skipMigrations, w, watch, debugFork, network, networkFile, } = toolbox.parameters.options;
-        // Support both long and short option variants
-        help || (help = h);
-        ipfs = ipfs || i || ipfs_1.DEFAULT_IPFS_URL;
-        headers = headers || hdr || '{}';
-        node || (node = g);
-        outputDir || (outputDir = o);
-        watch || (watch = w);
-        versionLabel || (versionLabel = l);
-        try {
-            headers = JSON.parse(headers);
-        }
-        catch (e) {
-            print.error('Please make sure headers is a valid JSON value');
-            process.exitCode = 1;
-            return;
-        }
-        let subgraphName, manifest;
-        try {
-            [subgraphName, manifest] = (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                w,
-                watch,
-                studio,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
-        // Fall back to default values for options / parameters
-        outputDir = outputDir && outputDir !== '' ? outputDir : filesystem.path('build');
-        manifest =
-            manifest !== undefined && manifest !== '' ? manifest : filesystem.resolve('subgraph.yaml');
-        networkFile =
-            networkFile !== undefined && networkFile !== ''
-                ? networkFile
-                : filesystem.resolve('networks.json');
+const headersFlag = core_1.Flags.custom({
+    summary: 'Add custom headers that will be used by the IPFS HTTP client.',
+    aliases: ['hdr'],
+    parse: val => JSON.parse(val),
+    default: {},
+});
+class DeployCommand extends core_1.Command {
+    async run() {
+        const { args: { 'subgraph-name': subgraphName, 'subgraph-manifest': manifest }, flags: { product, studio, 'deploy-key': deployKeyFlag, 'access-token': accessToken, 'version-label': versionLabelFlag, ipfs, headers, node: nodeFlag, 'output-dir': outputDir, 'skip-migrations': skipMigrations, watch, 'debug-fork': debugFork, network, 'network-file': networkFile, }, } = await this.parse(DeployCommand);
         try {
             const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
             for (const { network } of dataSourcesAndTemplates) {
@@ -141,53 +55,19 @@ exports.default = {
             }
         }
         catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
+            this.error(e, { exit: 1 });
         }
-        // Show help text if requested
-        if (help) {
-            print.info(HELP);
-            return;
-        }
-        ({ node } = (0, node_1.chooseNodeUrl)({ product, studio, node }));
-        if (!node) {
-            const inputs = await processForm(toolbox, {
-                product,
-                studio,
-                node,
-                versionLabel: 'skip', // determine label requirement later
-            });
-            if (inputs === undefined) {
-                process.exit(1);
-            }
-            product = inputs.product;
-            ({ node } = (0, node_1.chooseNodeUrl)({
-                product,
-                studio,
-                node,
-            }));
-        }
-        // Validate the subgraph name
-        if (!subgraphName) {
-            print.error(`No subgraph ${product == 'subgraph-studio' || studio ? 'slug' : 'name'} provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
-        // Validate node
+        const { node } = (0, node_1.chooseNodeUrl)({
+            product,
+            studio,
+            node: nodeFlag ||
+                (await core_1.ux.prompt('Which product to deploy for?', {
+                    required: true,
+                })),
+        });
         if (!node) {
-            print.error(`No Graph node provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
-        // Validate IPFS
-        if (!ipfs) {
-            print.error(`No IPFS node provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
+            // shouldn't happen, but we do the check to satisfy TS
+            this.error('No Graph node provided');
         }
         let protocol;
         try {
@@ -203,13 +83,11 @@ exports.default = {
             protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         }
         catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
+            this.error(e, { exit: 1 });
         }
         if (network) {
             const identifierName = protocol.getContract().identifierName();
-            await (0, network_1.updateSubgraphNetwork)(toolbox, manifest, network, networkFile, identifierName);
+            await (0, network_1.updateSubgraphNetwork)(manifest, network, networkFile, identifierName);
         }
         const isStudio = node.match(/studio/);
         const isHostedService = node.match(/thegraph.com/) && !isStudio;
@@ -219,35 +97,30 @@ exports.default = {
             outputDir,
             outputFormat: 'wasm',
             skipMigrations,
-            blockIpfsMethods: isStudio,
+            blockIpfsMethods: isStudio || undefined,
             protocol,
         });
         // Exit with an error code if the compiler couldn't be created
         if (!compiler) {
-            process.exitCode = 1;
+            this.exit(1);
             return;
         }
         // Ask for label if not on hosted service
+        let versionLabel = versionLabelFlag;
         if (!versionLabel && !isHostedService) {
-            const inputs = await processForm(toolbox, {
-                product,
-                studio,
-                node,
-                versionLabel,
+            versionLabel = await core_1.ux.prompt('Which version label to use? (e.g. "v0.0.1")', {
+                required: true,
             });
-            if (inputs === undefined) {
-                process.exit(1);
-            }
-            versionLabel = inputs.versionLabel;
         }
         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 deploy key, if one is set
+        let deployKey = deployKeyFlag;
         if (!deployKey && accessToken) {
             deployKey = accessToken; // backwards compatibility
         }
@@ -256,9 +129,10 @@ exports.default = {
             // @ts-expect-error options property seems to exist
             client.options.headers = { Authorization: 'Bearer ' + deployKey };
         }
+        // eslint-disable-next-line @typescript-eslint/no-this-alias -- request needs it
+        const self = this;
         const deploySubgraph = async (ipfsHash) => {
-            const spinner = print.spin(`Deploying to Graph node ${requestUrl}`);
-            //       `Failed to deploy to Graph node ${requestUrl}`,
+            core_1.ux.action.start(`Deploying to Graph node ${requestUrl}`);
             client.request('subgraph_deploy', {
                 name: subgraphName,
                 ipfs_hash: ipfsHash,
@@ -272,27 +146,25 @@ exports.default = {
             // @ts-expect-error TODO: why are the arguments not typed?
             res) => {
                 if (jsonRpcError) {
-                    spinner.fail(`Failed to deploy to Graph node ${requestUrl}: ${jsonRpcError.message}`);
+                    let errorMessage = `Failed to deploy to Graph node ${requestUrl}: ${jsonRpcError.message}`;
                     // Provide helpful advice when the subgraph has not been created yet
                     if (jsonRpcError.message.match(/subgraph name not found/)) {
                         if (isHostedService) {
-                            print.info(`
-You may need to create it at https://thegraph.com/explorer/dashboard.`);
+                            errorMessage +=
+                                '\nYou may need to create it at https://thegraph.com/explorer/dashboard.';
                         }
                         else {
-                            print.info(`
+                            errorMessage += `
 Make sure to create the subgraph first by running the following command:
-$ graph create --node ${node} ${subgraphName}`);
+$ graph create --node ${node} ${subgraphName}`;
                         }
                     }
-                    process.exitCode = 1;
+                    self.error(errorMessage, { exit: 1 });
                 }
                 else if (requestError) {
-                    spinner.fail(`HTTP error deploying the subgraph ${requestError.code}`);
-                    process.exitCode = 1;
+                    self.error(`HTTP error deploying the subgraph ${requestError.code}`, { exit: 1 });
                 }
                 else {
-                    spinner.stop();
                     const base = requestUrl.protocol + '//' + requestUrl.hostname;
                     let playground = res.playground;
                     let queries = res.queries;
@@ -304,14 +176,13 @@ $ graph create --node ${node} ${subgraphName}`);
                         queries = base + queries;
                     }
                     if (isHostedService) {
-                        print.success(`Deployed to ${chalk_1.default.blue(`https://thegraph.com/explorer/subgraph/${subgraphName}`)}`);
+                        core_1.ux.action.stop(`Deployed to https://thegraph.com/explorer/subgraph/${subgraphName}`);
                     }
                     else {
-                        print.success(`Deployed to ${chalk_1.default.blue(String(playground))}`);
+                        core_1.ux.action.stop(`Deployed to ${String(playground)}`);
                     }
-                    print.info('\nSubgraph endpoints:');
-                    print.info(`Queries (HTTP):     ${queries}`);
-                    print.info(``);
+                    self.log('Subgraph endpoints:');
+                    self.log(`Queries (HTTP):\n${queries}`);
                 }
             });
         };
@@ -331,5 +202,72 @@ $ graph create --node ${node} ${subgraphName}`);
             }
             await deploySubgraph(result);
         }
-    },
+    }
+}
+exports.default = DeployCommand;
+DeployCommand.description = 'Deploys a subgraph to a Graph node.';
+DeployCommand.args = {
+    'subgraph-name': core_1.Args.string({
+        required: true,
+    }),
+    'subgraph-manifest': core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+DeployCommand.flags = {
+    product: core_1.Flags.string({
+        summary: 'Select a product for which to authenticate.',
+        options: ['subgraph-studio', 'hosted-service'],
+    }),
+    studio: core_1.Flags.boolean({
+        summary: 'Shortcut for "--product subgraph-studio".',
+        exclusive: ['product'],
+    }),
+    node: core_1.Flags.string({
+        summary: 'Graph node for which to initialize.',
+        char: 'g',
+    }),
+    'deploy-key': core_1.Flags.string({
+        summary: 'User deploy key.',
+        required: true,
+        exclusive: ['access-token'],
+    }),
+    'access-token': core_1.Flags.string({
+        deprecated: true,
+        summary: 'Graph access key. DEPRECATED: Use "--deploy-key" instead.',
+        exclusive: ['deploy-key'],
+    }),
+    'version-label': core_1.Flags.string({
+        summary: 'Version label used for the deployment.',
+        char: 'l',
+    }),
+    ipfs: core_1.Flags.string({
+        summary: 'Upload build results to an IPFS node.',
+        char: 'i',
+        default: ipfs_1.DEFAULT_IPFS_URL,
+    }),
+    headers: headersFlag(),
+    'debug-fork': core_1.Flags.string({
+        summary: 'ID of a remote subgraph whose store will be GraphQL queried.',
+    }),
+    'output-dir': core_1.Flags.directory({
+        summary: 'Output directory for build results.',
+        char: 'o',
+        default: 'build/',
+    }),
+    'skip-migrations': core_1.Flags.boolean({
+        summary: 'Skip subgraph migrations.',
+    }),
+    watch: core_1.Flags.boolean({
+        summary: 'Regenerate types when subgraph files change.',
+        char: 'w',
+    }),
+    network: core_1.Flags.string({
+        summary: 'Network configuration to use from the networks config file.',
+    }),
+    // TODO: should be networksFile (with an "s"), or?
+    'network-file': core_1.Flags.file({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };