@webiny/cli 5.40.0-beta.2 → 5.40.0-beta.4

package/cli.js

@@ -7,7 +7,7 @@ yargs.help(false);
 // Loads environment variables from multiple sources.
 require("./utils/loadEnvVariables");
 
-const { blue, red } = require("chalk");
+const { blue, red, bold, bgYellow } = require("chalk");
 const context = require("./context");
 const { createCommands } = require("./commands");
 
@@ -58,22 +58,29 @@ yargs
             process.exit(1);
         }
 
-        if (error) {
+        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);
-            // 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);
-            }
+        }
 
+        const gracefulError = error.cause?.gracefulError;
+        if (gracefulError instanceof 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
-                });
-            }
+            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);

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,10 @@
+const execa = require("execa");
+
+module.exports.getNpmVersion = async () => {
+    try {
+        const { stdout } = await execa("npm", ["--version"]);
+        return stdout;
+    } catch (err) {
+        return "";
+    }
+};

package/commands/about/index.js

@@ -1,20 +1,27 @@
 const NO_VALUE = "-";
+const isCI = require("is-ci");
 
 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,
-                Template: context.project.config.template || NO_VALUE,
+                "Database Setup": getDatabaseSetupLabel(),
                 "Debug Enabled": process.env.DEBUG === "true" ? "Yes" : "No",
                 "Feature Flags": process.env.WEBINY_FEATURE_FLAGS || "N/A"
             }
@@ -22,13 +29,20 @@ const getData = async context => {
         {
             sectionName: "Webiny Control Panel (WCP)",
             data: {
-                "Project ID": context.project.config.id || process.env.WCP_PROJECT_ID,
-                User: await getUser()
-                    .catch(() => "N/A")
-                    .then(res => res.email),
-                Authentication: process.env.WEBINY_PROJECT_ENVIRONMENT_API_KEY
-                    ? "Project Environment API Key"
-                    : "Personal Access Token"
+                "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"
             }
         },
         {
@@ -36,19 +50,9 @@ const getData = async context => {
             data: {
                 "@pulumi/pulumi": pulumiVersion,
                 "@pulumi/aws": pulumiAwsVersion,
-                "Used AWS Region": process.env.AWS_REGION,
                 "Secrets Provider": process.env.PULUMI_SECRETS_PROVIDER,
                 "Using Password": process.env.PULUMI_CONFIG_PASSPHRASE ? "Yes" : "No"
             }
-        },
-        {
-            sectionName: "Host",
-            data: {
-                OS: `${process.platform} (${process.arch})`,
-                "Node.js": process.version,
-                NPX: await getNpxVersion(),
-                Yarn: await getYarnVersion()
-            }
         }
     ];
 };
@@ -84,7 +88,7 @@ module.exports = {
                     console.log(bold(sectionName));
 
                     Object.keys(data).forEach(key => {
-                        console.log(key.padEnd(30), data[key] || NO_VALUE);
+                        console.log(key.padEnd(36), data[key] || NO_VALUE);
                     });
                 });
             }

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,10 +1,10 @@
-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(
@@ -17,6 +17,8 @@ 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 %s!`, "disabled");

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 = "";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/cli",
-	"version": "5.40.0-beta.2",
+	"version": "5.40.0-beta.4",
 	"main": "index.js",
 	"bin": {
 		"webiny": "./bin.js"
@@ -13,8 +13,8 @@
 	"author": "Pavel Denisjuk <pavel@webiny.com>",
 	"description": "A tool to bootstrap a Webiny project.",
 	"dependencies": {
-		"@webiny/telemetry": "5.40.0-beta.2",
-		"@webiny/wcp": "5.40.0-beta.2",
+		"@webiny/telemetry": "5.40.0-beta.4",
+		"@webiny/wcp": "5.40.0-beta.4",
 		"boolean": "3.2.0",
 		"camelcase": "5.3.1",
 		"chalk": "4.1.2",
@@ -25,6 +25,7 @@
 		"fs-extra": "9.1.0",
 		"graphql-request": "3.7.0",
 		"inquirer": "7.3.3",
+		"is-ci": "3.0.1",
 		"ncp": "2.0.0",
 		"open": "8.4.0",
 		"pirates": "4.0.5",
@@ -64,5 +65,5 @@
 			]
 		}
 	},
-	"gitHead": "15e414a228687140ce2f30bd2f55763368e99827"
+	"gitHead": "42f3b1c985d6f8317d5c1084838b43a270c79f01"
 }

package/types.d.ts

@@ -2,12 +2,16 @@
  * Rename file to types.ts when switching the package to Typescript.
  */
 
+import glob from "fast-glob";
+import { dirname, join } from "path";
+
 /**
  * A simplified plugins container interface, used specifically within the Webiny CLI.
  * Not in relation with "@webiny/plugins" package.
  */
 export interface PluginsContainer {
     byType<T extends Plugin>(type: T["type"]): T[];
+
     byName<T extends Plugin>(name: T["name"]): T;
 }
 
@@ -18,6 +22,7 @@ export interface PluginsContainer {
 export interface Plugin {
     type: string;
     name?: string;
+
     [key: string]: any;
 }
 
@@ -36,11 +41,65 @@ interface Project {
     root: string;
 }
 
+export interface ProjectApplication {
+    /**
+     * Unique ID of the project application.
+     */
+    id: string;
+    /**
+     * Name of the project application.
+     */
+    name: string;
+    /**
+     * Description of the project application.
+     */
+    description: string;
+    /**
+     * Type of the project application.
+     */
+    type: string;
+    /**
+     * Root path of the project application.
+     */
+    root: string;
+    /**
+     * Commonly used paths.
+     */
+    paths: {
+        relative: string;
+        absolute: string;
+        workspace: string;
+    };
+    /**
+     * Project application config (exported via `webiny.application.ts` file).
+     */
+    config: Record<string, any>;
+    /**
+     * Project application package.json.
+     */
+    project: Project;
+
+    /**
+     * A list of all the packages in the project application.
+     */
+    get packages(): Array<{
+        name: string;
+        paths: {
+            root: string;
+            packageJson: string;
+            config: string;
+        };
+        packageJson: Record<string, any>;
+        get config(): any;
+    }>;
+}
+
 /**
  * A type that represents the logging method.
  */
 interface Log {
     (...args: any): string;
+
     hl: (...args: any) => string;
     highlight: (...args: any) => string;
 }

package/utils/getProjectApplication.js

@@ -43,16 +43,10 @@ module.exports = args => {
         projectAppRelativePath
     );
 
-    // If we're missing the `pulumi` property in the `applicationConfig` object, that
-    // means we're dealing with an old project application where all of the Pulumi code is
-    // located in user's project. New projects applications have this code abstracted away.
-    const type = applicationConfig.pulumi ? "v5-workspaces" : "v5";
-
     return {
         id,
         name,
         description,
-        type,
         root: projectAppRootPath,
         paths: {
             relative: projectAppRelativePath,
@@ -72,6 +66,8 @@ module.exports = args => {
                 return {
                     name: packageJson.name,
                     paths: {
+                        absolute: dirname(config),
+                        relative: relative(project.root, dirPath),
                         root: dirname(config),
                         packageJson: join(dirPath, "package.json"),
                         config

package/utils/index.js

@@ -2,7 +2,6 @@ const { importModule } = require("./importModule");
 const createProjectApplicationWorkspace = require("./createProjectApplicationWorkspace");
 const getProject = require("./getProject");
 const getProjectApplication = require("./getProjectApplication");
-const getApiProjectApplicationFolder = require("./getApiProjectApplicationFolder");
 const localStorage = require("./localStorage");
 const log = require("./log");
 const sendEvent = require("./sendEvent");
@@ -14,7 +13,6 @@ const noop = () => {
 
 module.exports = {
     createProjectApplicationWorkspace,
-    getApiProjectApplicationFolder,
     getProject,
     getProjectApplication,
     importModule,

package/utils/loadEnvVariables.js

@@ -24,6 +24,15 @@ if (yargs.argv.env) {
     paths.push(path.join(project.root, `.env.${yargs.argv.env}`));
 }
 
+// If the `WCP_PROJECT_ID` environment variable is not set already, we check if there's
+// a WCP project ID set via the `webiny.project.ts` config file. If so, we assign it
+// to the `WCP_PROJECT_ID` environment variable.
+if (!process.env.WCP_PROJECT_ID) {
+    if (project.config.id) {
+        process.env.WCP_PROJECT_ID = project.config.id;
+    }
+}
+
 // Let's load environment variables
 for (let i = 0; i < paths.length; i++) {
     const path = paths[i];

package/utils/sendEvent.js

@@ -1,15 +1,11 @@
 const { sendEvent } = require("@webiny/telemetry/cli");
 const getProject = require("./getProject");
 
-module.exports = ({ event, properties, extraPayload }) => {
+module.exports = (event, properties) => {
     const project = getProject();
     if (project.config.cli && project.config.cli.telemetry === false) {
         return;
     }
 
-    return sendEvent({
-        event,
-        properties,
-        extraPayload
-    });
+    return sendEvent({ event, properties });
 };

package/utils/getApiProjectApplicationFolder.js

@@ -1,12 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-// This function has been created in order to help preserve backwards compatibility
-// (from 5.29.0, the `api` app has been moved into the `apps/api` directory).
-module.exports = project => {
-    if (fs.existsSync(path.join(project.root, "api"))) {
-        return "api";
-    }
-
-    return "apps/api";
-};

package/utils/index.d.ts

@@ -1 +0,0 @@
-export function getApiProjectApplicationFolder(project: Record<string, any>): boolean;