@webiny/cli 0.0.0-unstable.aa00eecd97 → 0.0.0-unstable.ac6ebf63c6

package/index.js

@@ -1,3 +1,3 @@
-const context = require("./context");
+import { GracefulError } from "@webiny/cli-core";
 
-module.exports.cli = context;
+export { GracefulError };

package/package.json

@@ -1,68 +1,30 @@
 {
 	"name": "@webiny/cli",
-	"version": "0.0.0-unstable.aa00eecd97",
+	"version": "0.0.0-unstable.ac6ebf63c6",
+	"type": "module",
 	"main": "index.js",
-	"bin": {
-		"webiny": "./bin.js"
-	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/webiny/webiny-js.git",
-		"directory": "packages/cli"
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"bin": {
+		"webiny": "./bin.js"
 	},
-	"author": "Pavel Denisjuk <pavel@webiny.com>",
-	"description": "A tool to bootstrap a Webiny project.",
+	"description": "A command line interface (CLI) for managing Webiny projects.",
+	"license": "MIT",
 	"dependencies": {
-		"@webiny/telemetry": "0.0.0-unstable.aa00eecd97",
-		"@webiny/wcp": "0.0.0-unstable.aa00eecd97",
-		"boolean": "3.2.0",
-		"camelcase": "5.3.1",
-		"chalk": "4.1.2",
-		"dotenv": "8.6.0",
+		"@webiny/cli-core": "0.0.0-unstable.ac6ebf63c6",
+		"@webiny/system-requirements": "0.0.0-unstable.ac6ebf63c6",
 		"execa": "5.1.1",
-		"fast-glob": "3.2.12",
-		"find-up": "5.0.0",
-		"fs-extra": "9.1.0",
-		"graphql-request": "3.7.0",
-		"inquirer": "7.3.3",
-		"ncp": "2.0.0",
-		"open": "8.4.0",
-		"pirates": "4.0.5",
-		"semver": "7.3.8",
-		"ts-morph": "11.0.3",
-		"typescript": "4.7.4",
-		"uniqid": "5.4.0",
-		"yargs": "17.6.2"
+		"tsx": "4.21.0"
+	},
+	"devDependencies": {
+		"@types/lodash": "4.17.23",
+		"@webiny/build-tools": "0.0.0-unstable.ac6ebf63c6"
 	},
-	"license": "MIT",
 	"publishConfig": {
 		"access": "public",
 		"directory": "."
 	},
-	"adio": {
-		"ignoreDirs": [
-			"/create/template/",
-			"/node_modules/",
-			"/dist/"
-		],
-		"ignore": {
-			"src": [
-				"@webiny/project-utils",
-				"@webiny/api-file-manager",
-				"@webiny/cli-plugin-deploy-pulumi",
-				"@webiny/api",
-				"@webiny/handler-client",
-				"@webiny/api-elasticsearch",
-				"@webiny/api-tenancy",
-				"@webiny/api-security",
-				"@webiny/api-i18n",
-				"@webiny/api-i18n-content",
-				"@webiny/api-page-builder",
-				"@webiny/api-prerendering-service",
-				"@webiny/api-form-builder",
-				"@webiny/api-headless-cms"
-			]
-		}
-	},
-	"gitHead": "aa00eecd97d16da9bdb0581f33d491487ce43ce9"
+	"gitHead": "ac6ebf63c6de308703d41f2c1b375e03cd96b813"
 }

package/utils/ensureSameWebinyPackageVersions.js

@@ -0,0 +1,99 @@
+const execa = require("execa");
+const logger = require("./log");
+
+const DEBUG_FLAG = "--debug";
+const usingDebugFlag = process.argv.includes(DEBUG_FLAG);
+
+const SKIP_WEBINY_VERSIONS_CHECK_FLAG = "--no-package-versions-check";
+const skippingWebinyVersionsCheck = process.argv.includes(SKIP_WEBINY_VERSIONS_CHECK_FLAG);
+
+function listWebinyPackageVersions() {
+    const { stdout } = execa.sync("yarn", ["info", "@webiny/*", "--name-only", "--all", "--json"], {
+        encoding: "utf-8"
+    });
+
+    // Each line is a JSON string, so parse them individually
+    const lines = stdout
+        .trim()
+        .split("\n")
+        .map(line => JSON.parse(line));
+
+    const versionMap = new Map();
+
+    for (const entry of lines) {
+        // An example entry: "@webiny/cli@npm:5.42.3"
+        const match = entry.match(/^(@webiny\/[^@]+)@npm:(.+)$/);
+        if (!match) {
+            continue;
+        }
+
+        const [, pkg, version] = match;
+        if (!versionMap.has(pkg)) {
+            versionMap.set(pkg, new Set());
+        }
+
+        versionMap.get(pkg).add(version);
+    }
+
+    return versionMap;
+}
+
+function ensureSameWebinyPackageVersions() {
+    // Just in case, we want to allow users to skip the check.
+    if (skippingWebinyVersionsCheck) {
+        return;
+    }
+
+    let webinyVersions;
+    try {
+        webinyVersions = listWebinyPackageVersions();
+    } catch (e) {
+        const message = ["Failed to inspect Webiny package versions."];
+
+        if (!usingDebugFlag) {
+            message.push(
+                `For more information, try running with ${logger.warning.hl(DEBUG_FLAG)}.`
+            );
+        }
+
+        message.push("Learn more: https://webiny.link/webiny-package-versions-check");
+
+        logger.warning(message.join(" "));
+        if (usingDebugFlag) {
+            logger.debug(e);
+        }
+
+        console.log();
+        return;
+    }
+
+    let hasMismatch = false;
+    const mismatchedPackages = [];
+    for (const [pkg, versions] of webinyVersions.entries()) {
+        if (versions.size > 1) {
+            hasMismatch = true;
+            mismatchedPackages.push([pkg, versions]);
+        }
+    }
+
+    if (hasMismatch) {
+        const message = [
+            "The following Webiny packages have mismatched versions:",
+            "",
+            ...mismatchedPackages.map(([pkg, versions]) => {
+                return `‣ ${pkg}: ${Array.from(versions).join(", ")}`;
+            }),
+            "",
+            `Please ensure all Webiny packages are using the same version. If you think this is a mistake, you can also skip this check by appending the ${logger.error.hl(
+                SKIP_WEBINY_VERSIONS_CHECK_FLAG
+            )} flag. Learn more: https://webiny.link/webiny-package-versions-check`
+        ];
+
+        logger.error(message.join("\n"));
+        process.exit(1);
+    }
+}
+
+module.exports = {
+    ensureSameWebinyPackageVersions
+};

package/utils/suppressPunycodeWarnings.js

@@ -0,0 +1,7 @@
+const originalConsoleError = console.error;
+console.error = (message, ...args) => {
+    if (typeof message === "string" && message.includes("punycode")) {
+        return;
+    }
+    originalConsoleError.call(console, message, ...args);
+};

package/cli.js

@@ -1,86 +0,0 @@
-#!/usr/bin/env node
-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 } = 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();
-
-            process.exit(1);
-        }
-
-        if (error) {
-            context.error(error.message);
-            // Unfortunately, yargs doesn't provide passed args here, so we had to do it via process.argv.
-            if (process.argv.includes("--debug")) {
-                context.debug(error);
-            }
-
-            console.log();
-            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);
-    });
-
-(async () => {
-    await createCommands(yargs, context);
-    // Enable help and run the CLI.
-    yargs.help().argv;
-})();

package/commands/index.js

@@ -1,20 +0,0 @@
-const run = require("./run");
-const telemetry = require("./telemetry");
-const upgrade = require("./upgrade");
-
-module.exports.createCommands = async (yargs, context) => {
-    context.plugins.register(run, telemetry, upgrade);
-
-    try {
-        const wcp = require("./wcp");
-        context.plugins.register(wcp);
-    } catch {
-        // Skip WCP command
-    }
-
-    await context.loadUserPlugins();
-
-    context.plugins.byType("cli-command").forEach(plugin => {
-        plugin.create({ yargs, context });
-    });
-};

package/commands/run/index.js

@@ -1,38 +0,0 @@
-const camelCase = require("camelcase");
-const findUp = require("find-up");
-const path = require("path");
-
-module.exports = {
-    type: "cli-command",
-    name: "cli-command-run",
-    create({ yargs, context }) {
-        yargs.command(
-            "run <command> [options]",
-            `Run command defined in webiny.config.{js,ts}.\nNote: run from folder containing webiny.config.{js,ts} file.`,
-            yargs => {
-                yargs.positional("command", {
-                    describe: `Command to run in webiny.config.{js,ts}`,
-                    type: "string"
-                });
-            },
-            async argv => {
-                const configFile = findUp.sync(["webiny.config.ts", "webiny.config.js"]);
-                let config = context.import(configFile);
-
-                const command = camelCase(argv.command);
-                if (typeof config === "function") {
-                    config = config({
-                        options: { ...argv, cwd: path.dirname(configFile) },
-                        context
-                    });
-                }
-
-                if (config.commands && typeof config.commands[command] === "function") {
-                    return await config.commands[command]({ ...argv }, context);
-                }
-
-                throw Error(`Command "${command}" is not defined in "${configFile}"!`);
-            }
-        );
-    }
-};

package/commands/telemetry/index.js

@@ -1,31 +0,0 @@
-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 () => {
-            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!`
-            );
-            context.info(
-                `For more information, please visit the following link: https://www.webiny.com/telemetry.`
-            );
-        });
-
-        yargs.command("disable-telemetry", "Disable anonymous telemetry.", async () => {
-            await telemetry.sendEvent({ event: "disable-telemetry" });
-            telemetry.disable();
-            context.info(`Webiny telemetry is now ${context.info.hl("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.`
-            );
-        });
-    }
-};

package/commands/upgrade/index.js

@@ -1,107 +0,0 @@
-const { red } = require("chalk");
-const execa = require("execa");
-const semver = require("semver");
-
-module.exports = [
-    {
-        type: "cli-command",
-        name: "cli-command-upgrade",
-        create({ yargs, context }) {
-            yargs.example("$0 upgrade");
-            yargs.command(
-                "upgrade",
-                `Run an upgrade script for currently installed version of Webiny`,
-                yargs => {
-                    yargs.option("skip-checks", {
-                        describe: "Do not perform CLI version and Git tree checks.",
-                        type: "boolean",
-                        default: false
-                    });
-                    yargs.option("debug", {
-                        default: false,
-                        describe: `Turn on debug logs`,
-                        type: "boolean"
-                    });
-                    yargs.option("use-version", {
-                        describe:
-                            "Use upgrade script for a specific version. Should only be used for development/testing purposes.",
-                        type: "string"
-                    });
-                },
-                async argv => {
-                    if (!argv.skipChecks) {
-                        // Before doing any upgrading, there must not be any active changes in the current branch.
-                        let gitStatus = "";
-                        try {
-                            let { stdout } = execa.sync("git", ["status", "--porcelain"]);
-                            gitStatus = stdout.trim();
-                        } catch {}
-
-                        if (gitStatus) {
-                            console.error(
-                                red(
-                                    "This git repository has untracked files or uncommitted changes:"
-                                ) +
-                                    "\n\n" +
-                                    gitStatus
-                                        .split("\n")
-                                        .map(line => line.match(/ .*/g)[0].trim())
-                                        .join("\n") +
-                                    "\n\n" +
-                                    red(
-                                        "Remove untracked files, stash or commit any changes, and try again."
-                                    )
-                            );
-                            process.exit(1);
-                        }
-                    }
-
-                    const defaultUpgradeTargetVersion = semver.coerce(context.version).version;
-
-                    const command = [
-                        "https://github.com/webiny/webiny-upgrades",
-                        argv.useVersion || defaultUpgradeTargetVersion
-                    ];
-
-                    if (yargs.argv.debug) {
-                        context.debug("npx", ...command);
-                    }
-
-                    const npx = execa("npx", command, {
-                        env: {
-                            FORCE_COLOR: true
-                        }
-                    });
-
-                    npx.stdout.on("data", data => {
-                        const lines = data.toString().replace(/\n$/, "").split("\n");
-                        for (let i = 0; i < lines.length; i++) {
-                            const line = lines[i];
-                            try {
-                                const json = JSON.parse(line);
-                                if (json.type === "error") {
-                                    context.error(
-                                        "An error occurred while performing the upgrade."
-                                    );
-                                    console.log(json.message);
-                                    if (yargs.argv.debug) {
-                                        context.debug(json.data.stack);
-                                    }
-                                }
-                            } catch {
-                                // Not JSON, let's just print the line then.
-                                console.log(line);
-                            }
-                        }
-                    });
-
-                    npx.stderr.on("data", data => {
-                        console.log(data.toString());
-                    });
-
-                    await npx;
-                }
-            );
-        }
-    }
-];

package/commands/wcp/hooks.js

@@ -1,133 +0,0 @@
-const { encrypt, decrypt } = require("@webiny/wcp");
-const { getUser, getProjectEnvironment, updateUserLastActiveOn } = require("./utils");
-
-/**
- * The two environment variables we set via these hooks are the following:
- * - WCP_PROJECT_ENVIRONMENT - contains encrypted data about the deployed project environment
- * - WCP_PROJECT_ENVIRONMENT_API_KEY - for easier access, we also set the API key
- */
-
-/**
- * There are multiple ways the hooks below prepare the WCP-enabled project for deployment.
- * 1. If `WCP_PROJECT_ENVIRONMENT` metadata env var is defined, we decrypt it, retrieve the
- *    API key from it, and assign it as the `WCP_PROJECT_ENVIRONMENT_API_KEY` env var.
- * 2. If `WCP_PROJECT_ENVIRONMENT_API_KEY` env var is defined, then we use that as the
- *    project environment API key. We use that to load the project environment data
- *    and to also assign the `WCP_PROJECT_ENVIRONMENT` metadata env var.
- * 3. If none of the above is defined, we retrieve (or create) the project environment,
- *    retrieve its API key and again assign it as `WCP_PROJECT_ENVIRONMENT_API_KEY` env var.
- *    As in 2), we also assign the `WCP_PROJECT_ENVIRONMENT` metadata env var.
- */
-
-let projectEnvironment;
-
-const getEnvironmentHookHandler = async (args, context) => {
-    // If the project isn't linked with WCP, do nothing.
-    const wcpProjectId = context.project.config.id || process.env.WCP_PROJECT_ID;
-    if (!wcpProjectId) {
-        return;
-    }
-
-    // For development purposes, we allow setting the WCP_PROJECT_ENVIRONMENT env var directly.
-    if (process.env.WCP_PROJECT_ENVIRONMENT) {
-        // If we have WCP_PROJECT_ENVIRONMENT env var, we set the WCP_PROJECT_ENVIRONMENT_API_KEY too.
-        const decryptedProjectEnvironment = decrypt(process.env.WCP_PROJECT_ENVIRONMENT);
-        process.env.WCP_PROJECT_ENVIRONMENT_API_KEY = decryptedProjectEnvironment.apiKey;
-        return;
-    }
-
-    // The `id` has the orgId/projectId structure, for example `my-org-x/my-project-y`.
-    const [orgId, projectId] = wcpProjectId.split("/");
-
-    const apiKey = process.env.WCP_PROJECT_ENVIRONMENT_API_KEY;
-
-    let projectEnvironment;
-    if (apiKey) {
-        projectEnvironment = await getProjectEnvironment({ apiKey });
-    } else {
-        const isValidId = orgId && projectId;
-        if (!isValidId) {
-            throw new Error(
-                `It seems the project ID, specified in "webiny.project.ts" file, is invalid.`
-            );
-        }
-
-        // If there is no API key, that means we need to retrieve the currently logged-in user.
-        const user = await getUser();
-        const project = user.projects.find(item => item.id === projectId);
-        if (!project) {
-            throw new Error(
-                `It seems you don't belong to the current project or the current project has been deleted.`
-            );
-        }
-
-        projectEnvironment = await getProjectEnvironment({
-            orgId,
-            projectId,
-            userId: user.id,
-            environmentId: args.env
-        });
-    }
-
-    if (projectEnvironment.org.id !== orgId) {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment doesn't belong to the "${orgId}" organization. Please check your WCP project ID (currently set to "${wcpProjectId}").`
-        );
-    }
-
-    if (projectEnvironment.project.id !== projectId) {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment doesn't belong to the "${wcpProjectId}" project. Please check your WCP project ID (currently set to "${wcpProjectId}").`
-        );
-    }
-
-    if (projectEnvironment && projectEnvironment.status !== "enabled") {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment has been disabled.`
-        );
-    }
-
-    // Assign `WCP_PROJECT_ENVIRONMENT` and `WCP_PROJECT_ENVIRONMENT_API_KEY`
-    const wcpProjectEnvironment = {
-        id: projectEnvironment.id,
-        apiKey: projectEnvironment.apiKey,
-        org: { id: projectEnvironment.org.id },
-        project: { id: projectEnvironment.project.id }
-    };
-
-    process.env.WCP_PROJECT_ENVIRONMENT = encrypt(wcpProjectEnvironment);
-    process.env.WCP_PROJECT_ENVIRONMENT_API_KEY = projectEnvironment.apiKey;
-};
-
-const updateLastActiveOnHookHandler = async () => {
-    if (!projectEnvironment) {
-        return;
-    }
-
-    // Is this a user environment? If so, let's update his "last active" field.
-    if (projectEnvironment.user) {
-        await updateUserLastActiveOn();
-    }
-};
-
-// Export hooks plugins for deploy and watch commands.
-module.exports = () => [
-    // Deploy hook handlers.
-    {
-        type: "hook-before-deploy",
-        name: "hook-before-deploy-environment-get-environment",
-        hook: getEnvironmentHookHandler
-    },
-    {
-        type: "hook-before-deploy",
-        name: "hook-before-deploy-update-last-active-on",
-        hook: updateLastActiveOnHookHandler
-    },
-
-    // Watch hook handlers.
-    {
-        type: "hook-before-watch",
-        name: "hook-before-watch-environment-get-environment",
-        hook: getEnvironmentHookHandler
-    }
-];

package/commands/wcp/index.js

@@ -1,8 +0,0 @@
-const { command: login } = require("./login");
-const { command: logout } = require("./logout");
-const { command: whoami } = require("./whoami");
-const { command: project } = require("./project");
-
-const hooks = require("./hooks");
-
-module.exports = [login(), logout(), whoami(), project(), hooks()];