@webiny/cli 0.0.0-unstable.fcdad0bc61 → 0.0.0-unstable.fdd9228b5d

package/bin.js

@@ -1,38 +1,103 @@
 #!/usr/bin/env node
-"use strict";
 
-const chalk = require("chalk");
-const execa = require("execa");
-const semver = require("semver");
-const currentNodeVersion = process.versions.node;
+// Suppress punycode warnings. This is a known issue which we can't fix.
+require("./utils/suppressPunycodeWarnings");
 
-(async () => {
-    if (!semver.satisfies(currentNodeVersion, ">=14")) {
-        console.error(
-            chalk.red(
-                [
-                    `You are running Node.js ${currentNodeVersion}, but Webiny requires version 14 or higher.`,
-                    `Please switch to one of the required versions and try again.`,
-                    `For more information, please visit https://docs.webiny.com/docs/tutorials/install-webiny#prerequisites.`
-                ].join(" ")
-            )
-        );
-        process.exit(1);
-    }
+// Ensure system requirements are met.
+require("@webiny/system-requirements").ensureSystemRequirements();
+
+// Detect different Webiny package versions.
+require("./utils/ensureSameWebinyPackageVersions").ensureSameWebinyPackageVersions();
+
+const yargs = require("yargs");
+
+// Disable help processing until after plugins are imported.
+yargs.help(false);
+
+// Loads environment variables from multiple sources.
+require("./utils/loadEnvVariables");
+
+const { blue, red, bold, bgYellow } = require("chalk");
+const context = require("./context");
+const { createCommands } = require("./commands");
+
+yargs
+    .usage("Usage: $0 <command> [options]")
+    .demandCommand(1)
+    .recommendCommands()
+    .scriptName("webiny")
+    .epilogue(
+        `To find more information, docs and tutorials, see ${blue("https://www.webiny.com/docs")}.`
+    )
+    .epilogue(`Want to contribute? ${blue("https://github.com/webiny/webiny-js")}.`)
+    .fail(function (msg, error, yargs) {
+        if (msg) {
+            if (msg.includes("Not enough non-option arguments")) {
+                console.log();
+                context.error(red("Command was not invoked as expected!"));
+                context.info(
+                    `Some non-optional arguments are missing. See the usage examples printed below.`
+                );
+                console.log();
+                yargs.showHelp();
+                return;
+            }
+
+            if (msg.includes("Missing required argument")) {
+                const args = msg
+                    .split(":")[1]
+                    .split(",")
+                    .map(v => v.trim());
+
+                console.log();
+                context.error(red("Command was not invoked as expected!"));
+                context.info(
+                    `Missing required argument(s): ${args
+                        .map(arg => red(arg))
+                        .join(", ")}. See the usage examples printed below.`
+                );
+                console.log();
+                yargs.showHelp();
+                return;
+            }
+            console.log();
+            context.error(red("Command execution was aborted!"));
+            context.error(msg);
+            console.log();
 
-    try {
-        const { stdout } = await execa("yarn", ["--version"]);
-        if (!semver.satisfies(stdout, ">=2")) {
-            console.error(chalk.red(`"@webiny/cli" requires yarn >=2!`));
             process.exit(1);
         }
-    } catch (err) {
-        console.error(chalk.red(`"@webiny/cli" requires yarn >=2!`));
-        console.log(
-            `Run ${chalk.blue("yarn set version berry")} to install a compatible version of yarn.`
-        );
+
+        console.log();
+        // Unfortunately, yargs doesn't provide passed args here, so we had to do it via process.argv.
+        const debugEnabled = process.argv.includes("--debug");
+        if (debugEnabled) {
+            context.debug(error);
+        } else {
+            context.error(error.message);
+        }
+
+        const gracefulError = error.cause?.gracefulError;
+        if (gracefulError instanceof Error) {
+            console.log();
+            console.log(bgYellow(bold("💡 How can I resolve this?")));
+            console.log(gracefulError.message);
+        }
+
+        const plugins = context.plugins.byType("cli-command-error");
+        for (let i = 0; i < plugins.length; i++) {
+            const plugin = plugins[i];
+            plugin.handle({
+                error,
+                context
+            });
+        }
+
         process.exit(1);
-    }
+    });
 
-    require("./cli");
+(async () => {
+    await createCommands(yargs, context);
+    // Enable help and run the CLI.
+    yargs.help().argv;
 })();

package/commands/about/getDatabaseSetup.js

@@ -0,0 +1,45 @@
+const { getProject } = require("@webiny/cli/utils");
+const path = require("path");
+const fs = require("fs");
+
+const DATABASE_SETUPS = {
+    DDB: "ddb",
+    DDB_ES: "ddb-es",
+    DDB_OS: "ddb-os"
+};
+
+const DATABASE_SETUPS_LABELS = {
+    [DATABASE_SETUPS.DDB]: "Amazon DynamoDB",
+    [DATABASE_SETUPS.DDB_ES]: "Amazon DynamoDB + Amazon Elasticsearch Service",
+    [DATABASE_SETUPS.DDB_OS]: "Amazon DynamoDB + Amazon OpenSearch Service"
+};
+
+// In order to get the database setup, we check for existence of `elasticSearch`
+//  or `openSearch` strings within the `apps/core/webiny.application.ts` file.
+const getDatabaseSetup = () => {
+    const project = getProject();
+    const webinyAppTsPath = path.join(project.root, "apps", "core", "webiny.application.ts");
+
+    const webinyAppTs = fs.readFileSync(webinyAppTsPath, "utf8");
+    if (webinyAppTs.includes("elasticSearch")) {
+        return "ddb-es";
+    }
+
+    if (webinyAppTs.includes("openSearch")) {
+        return "ddb-os";
+    }
+
+    return "ddb";
+};
+
+const getDatabaseSetupLabel = () => {
+    const setup = getDatabaseSetup();
+    return DATABASE_SETUPS_LABELS[setup];
+};
+
+module.exports = {
+    getDatabaseSetup,
+    getDatabaseSetupLabel,
+    DATABASE_SETUPS,
+    DATABASE_SETUPS_LABELS
+};

package/commands/about/getNpmVersion.js

@@ -0,0 +1,5 @@
+const { SystemRequirements } = require("@webiny/system-requirements");
+
+module.exports.getNpmVersion = async () => {
+    return SystemRequirements.getNpmVersion();
+};

package/commands/about/getNpxVersion.js

@@ -0,0 +1,5 @@
+const { SystemRequirements } = require("@webiny/system-requirements");
+
+module.exports.getNpxVersion = async () => {
+    return SystemRequirements.getNpxVersion();
+};

package/commands/about/getPulumiVersions.js

@@ -0,0 +1,43 @@
+const execa = require("execa");
+
+module.exports.getPulumiVersions = async () => {
+    let pulumi, pulumiAws;
+
+    try {
+        {
+            const { stdout } = await execa("yarn", [
+                "info",
+                "@pulumi/pulumi",
+                "-A",
+                "-R",
+                "--name-only",
+                "--json"
+            ]);
+
+            const match = stdout.match(/npm:(.*?)"/);
+            if (match) {
+                pulumi = match[1];
+            }
+        }
+
+        {
+            const { stdout } = await execa("yarn", [
+                "info",
+                "@pulumi/aws",
+                "-A",
+                "-R",
+                "--name-only",
+                "--json"
+            ]);
+
+            const match = stdout.match(/npm:(.*?)"/);
+            if (match) {
+                pulumiAws = match[1];
+            }
+        }
+    } catch (err) {
+        return "";
+    }
+
+    return [pulumi, pulumiAws];
+};

package/commands/about/getYarnVersion.js

@@ -0,0 +1,5 @@
+const { SystemRequirements } = require("@webiny/system-requirements");
+
+module.exports.getYarnVersion = async () => {
+    return SystemRequirements.getYarnVersion();
+};

package/commands/about/index.js

@@ -0,0 +1,97 @@
+const NO_VALUE = "-";
+const { isCI } = require("ci-info");
+
+const getData = async context => {
+    const { getUser } = require("../wcp/utils");
+    const { getNpxVersion } = require("./getNpxVersion");
+    const { getNpmVersion } = require("./getNpmVersion");
+    const { getPulumiVersions } = require("./getPulumiVersions");
+    const { getYarnVersion } = require("./getYarnVersion");
+    const { getDatabaseSetupLabel } = require("./getDatabaseSetup");
+
+    const [pulumiVersion, pulumiAwsVersion] = await getPulumiVersions();
+
+    const wcpProjectId = process.env.WCP_PROJECT_ID;
+    const wcpUser = await getUser().catch(() => null);
+    const wcpUsingProjectEnvironmentApiKey = Boolean(process.env.WCP_ENVIRONMENT_API_KEY);
+
+    return [
+        {
+            sectionName: "Webiny Project",
+            data: {
+                Name: context.project.name,
+                Version: context.version,
+                "Database Setup": getDatabaseSetupLabel(),
+                "Debug Enabled": process.env.DEBUG === "true" ? "Yes" : "No",
+                "Feature Flags": process.env.WEBINY_FEATURE_FLAGS || "N/A"
+            }
+        },
+        {
+            sectionName: "Webiny Control Panel (WCP)",
+            data: {
+                "Project ID": wcpProjectId,
+                User: wcpUser?.email || "N/A",
+                "Using Project Environment API Key": wcpUsingProjectEnvironmentApiKey ? "Yes" : "No"
+            }
+        },
+        {
+            sectionName: "Host",
+            data: {
+                OS: `${process.platform} (${process.arch})`,
+                "Node.js": process.version,
+                NPM: await getNpmVersion(),
+                NPX: await getNpxVersion(),
+                Yarn: await getYarnVersion(),
+                "Is CI": isCI ? "Yes" : "No"
+            }
+        },
+        {
+            sectionName: "Pulumi",
+            data: {
+                "@pulumi/pulumi": pulumiVersion,
+                "@pulumi/aws": pulumiAwsVersion,
+                "Secrets Provider": process.env.PULUMI_SECRETS_PROVIDER,
+                "Using Password": process.env.PULUMI_CONFIG_PASSPHRASE ? "Yes" : "No"
+            }
+        }
+    ];
+};
+
+module.exports = {
+    type: "cli-command",
+    name: "cli-command-about",
+    create({ yargs, context }) {
+        yargs.command(
+            "about",
+            `Prints out information helpful for debugging purposes.`,
+            yargs => {
+                yargs.option("json", {
+                    describe: "Emit output as JSON.",
+                    type: "boolean",
+                    default: false
+                });
+            },
+            async yargs => {
+                const data = await getData(context);
+
+                if (yargs.json) {
+                    console.log(JSON.stringify(data, null, 2));
+                    return;
+                }
+
+                data.forEach(({ sectionName, data }, index) => {
+                    if (index > 0) {
+                        console.log();
+                    }
+
+                    const { bold } = require("chalk");
+                    console.log(bold(sectionName));
+
+                    Object.keys(data).forEach(key => {
+                        console.log(key.padEnd(36), data[key] || NO_VALUE);
+                    });
+                });
+            }
+        );
+    }
+};

package/commands/index.js

@@ -1,9 +1,10 @@
+const about = require("./about");
 const run = require("./run");
 const telemetry = require("./telemetry");
 const upgrade = require("./upgrade");
 
 module.exports.createCommands = async (yargs, context) => {
-    context.plugins.register(run, telemetry, upgrade);
+    context.plugins.register(about, run, telemetry, upgrade);
 
     try {
         const wcp = require("./wcp");

package/commands/run/index.js

@@ -1,7 +1,3 @@
-const camelCase = require("camelcase");
-const findUp = require("find-up");
-const path = require("path");
-
 module.exports = {
     type: "cli-command",
     name: "cli-command-run",
@@ -16,6 +12,10 @@ module.exports = {
                 });
             },
             async argv => {
+                const camelCase = require("camelcase");
+                const findUp = require("find-up");
+                const path = require("path");
+
                 const configFile = findUp.sync(["webiny.config.ts", "webiny.config.js"]);
                 let config = context.import(configFile);
 

package/commands/telemetry/index.js

@@ -1,16 +1,15 @@
-const telemetry = require("@webiny/telemetry/cli");
-
 module.exports = {
     type: "cli-command",
     name: "cli-command-telemetry",
     create({ yargs, context }) {
         yargs.command("enable-telemetry", "Enable anonymous telemetry.", async () => {
+            const telemetry = require("@webiny/telemetry/cli");
+
             telemetry.enable();
             await telemetry.sendEvent({ event: "enable-telemetry" });
             context.info(
-                `Webiny telemetry is now ${context.info.hl(
-                    "enabled"
-                )}! Thank you for helping us in making Webiny better!`
+                `Webiny telemetry is now %s! Thank you for helping us in making Webiny better!`,
+                "enabled"
             );
             context.info(
                 `For more information, please visit the following link: https://www.webiny.com/telemetry.`
@@ -18,13 +17,14 @@ module.exports = {
         });
 
         yargs.command("disable-telemetry", "Disable anonymous telemetry.", async () => {
+            const telemetry = require("@webiny/telemetry/cli");
+
             await telemetry.sendEvent({ event: "disable-telemetry" });
             telemetry.disable();
-            context.info(`Webiny telemetry is now ${context.info.hl("disabled")}!`);
+            context.info(`Webiny telemetry is now %s!`, "disabled");
             context.info(
-                `Note that, in order to complete the process, you will also need to re-deploy your project, using the ${context.info.hl(
-                    "yarn webiny deploy"
-                )} command.`
+                `Note that, in order to complete the process, you will also need to re-deploy your project, using the %s command.`,
+                "yarn webiny deploy"
             );
         });
     }

package/commands/upgrade/index.js

@@ -1,7 +1,3 @@
-const { red } = require("chalk");
-const execa = require("execa");
-const semver = require("semver");
-
 module.exports = [
     {
         type: "cli-command",
@@ -29,6 +25,10 @@ module.exports = [
                     });
                 },
                 async argv => {
+                    const { red } = require("chalk");
+                    const execa = require("execa");
+                    const semver = require("semver");
+
                     if (!argv.skipChecks) {
                         // Before doing any upgrading, there must not be any active changes in the current branch.
                         let gitStatus = "";
@@ -70,7 +70,8 @@ module.exports = [
                     const npx = execa("npx", command, {
                         env: {
                             FORCE_COLOR: true
-                        }
+                        },
+                        stdin: process.stdin
                     });
 
                     npx.stdout.on("data", data => {

package/commands/wcp/login.js

@@ -1,6 +1,7 @@
 const open = require("open");
 const { GraphQLClient } = require("graphql-request");
-const { setProjectId, setWcpPat, sleep } = require("./utils");
+const { setProjectId, setWcpPat } = require("./utils");
+const { sleep } = require("../../utils");
 const chalk = require("chalk");
 const { getWcpGqlApiUrl, getWcpAppUrl } = require("@webiny/wcp");
 
@@ -95,9 +96,8 @@ module.exports.command = () => ({
                     } catch (e) {
                         if (debug) {
                             context.debug(
-                                `Could not use the provided ${context.debug.hl(
-                                    patFromParams
-                                )} PAT because of the following error:`
+                                `Could not use the provided %s PAT because of the following error:`,
+                                patFromParams
                             );
                             console.debug(e);
                         }
@@ -118,7 +118,7 @@ module.exports.command = () => ({
                     )}&ref=cli`;
                     const openUrl = `${getWcpAppUrl()}/login/cli?${queryParams}`;
 
-                    debug && context.debug(`Opening ${context.debug.hl(openUrl)}...`);
+                    debug && context.debug(`Opening %s...`, openUrl);
                     await open(openUrl);
 
                     const graphql = {

package/commands/wcp/project.js

@@ -1,7 +1,8 @@
 const open = require("open");
 const inquirer = require("inquirer");
 const chalk = require("chalk");
-const { getUser, WCP_APP_URL, setProjectId, sleep } = require("./utils");
+const { getUser, WCP_APP_URL, setProjectId } = require("./utils");
+const { sleep } = require("../../utils");
 
 module.exports.command = () => [
     {

package/commands/wcp/utils/getWcpOrgProjectId.js

@@ -0,0 +1,9 @@
+const { getWcpProjectId } = require("./getWcpProjectId");
+
+module.exports.getWcpOrgProjectId = context => {
+    const id = getWcpProjectId(context);
+    if (typeof id === "string") {
+        return id.split("/");
+    }
+    return [];
+};

package/commands/wcp/utils/getWcpProjectId.js

@@ -0,0 +1,3 @@
+module.exports.getWcpProjectId = context => {
+    return context?.project?.config?.id || process.env.WCP_PROJECT_ID || "";
+};

package/commands/wcp/utils/index.js

@@ -4,7 +4,8 @@ const { updateUserLastActiveOn } = require("./updateUserLastActiveOn");
 const { setProjectId } = require("./setProjectId");
 const { setWcpPat } = require("./setWcpPat");
 const { getWcpPat } = require("./getWcpPat");
-const { sleep } = require("./sleep");
+const { getWcpProjectId } = require("./getWcpProjectId");
+const { getWcpOrgProjectId } = require("./getWcpOrgProjectId");
 
 module.exports = {
     getUser,
@@ -13,5 +14,6 @@ module.exports = {
     setProjectId,
     setWcpPat,
     getWcpPat,
-    sleep
+    getWcpProjectId,
+    getWcpOrgProjectId
 };

package/context.js

@@ -92,7 +92,7 @@ class Context {
     log = log.log;
     info = log.info;
     success = log.success;
-    debug = process.argv.includes("--debug") ? log.debug : noop;
+    debug = process.argv.some(v => v.match("--debug")) ? log.debug : noop;
     warning = log.warning;
     error = log.error;
 
@@ -116,7 +116,7 @@ class Context {
         }
 
         if (!fs.existsSync(filePath)) {
-            debug && this.debug(`No environment file found on ${this.debug.hl(filePath)}.`);
+            debug && this.debug(`No environment file found on %s.`, filePath);
             return;
         }
 

package/files/README.md

@@ -0,0 +1 @@
+Do not manually create files in this folder. This folder is used to store the files that are generated by the CLI.

package/files/duplicates.json

@@ -0,0 +1 @@
+[]