@webiny/cli 5.28.0-beta.0 → 5.29.0-beta.1

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.29.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.29.0-beta.0...v5.29.0-beta.1) (2022-06-25)
+
+**Note:** Version bump only for package @webiny/cli
+
+
+
+
+
+# [5.29.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.28.0...v5.29.0-beta.0) (2022-06-25)
+
+
+### Bug Fixes
+
+* add comment ([c135622](https://github.com/webiny/webiny-js/commit/c135622f8b57c11099003a6cdd46df0a2143c82b))
+* ensure `WCP_PROJECT_ENVIRONMENT_API_KEY` env var ([857a9fd](https://github.com/webiny/webiny-js/commit/857a9fd1994e7723f2265b46ea14c61cbfc8d253))
+* if `WCP_PROJECT_ENVIRONMENT` is present, do not load env ([8c16540](https://github.com/webiny/webiny-js/commit/8c165407fcaf681c9bd99c8d42b6cfecf4c7ce99))
+* move `api` into `apps` folder ([0e9da03](https://github.com/webiny/webiny-js/commit/0e9da03426f5743e88273f6831dd5ba1fd6807aa))
+* only retrieve user if needed ([af4605d](https://github.com/webiny/webiny-js/commit/af4605d3cd24ac44bfb28951ce844b797c7f6b6d))
+* project must be activated in order for WCP interaction to happen ([10d3da5](https://github.com/webiny/webiny-js/commit/10d3da5766a1bf063ccc73f6a33e0b29658d74bc))
+* remove JSON.stringify ([ec44664](https://github.com/webiny/webiny-js/commit/ec446648e1972916769476baf72d5aa6ba004a0a))
+* remove unused code ([d64de94](https://github.com/webiny/webiny-js/commit/d64de94f38dd1f4e4b4df43defa27011b554fc96))
+* rename `getWcpGraphQlApiUrl` to `getWcpGqlApiUrl` ([d18bfad](https://github.com/webiny/webiny-js/commit/d18bfada9a6b512781fbbdb55f95f6e518f9ff7f))
+* rename name of hook ([0ff7b91](https://github.com/webiny/webiny-js/commit/0ff7b91f4cb5321ac9d64b6bc8412a70b8a435c7))
+* update dependencies ([9c28fe9](https://github.com/webiny/webiny-js/commit/9c28fe9625b4d61fbe4137124c36f15022c79db3))
+* update execa across all packages ([01189c5](https://github.com/webiny/webiny-js/commit/01189c595521c69f31aba85692d15622d842b231))
+* use fs-extra and synchronize dep version ([48a0605](https://github.com/webiny/webiny-js/commit/48a0605f8cc8487c81bd52f7b7db7308e5cbda04))
+
+
+### Features
+
+* introduce `createProjectApplicationWorkspace` function ([1cb7279](https://github.com/webiny/webiny-js/commit/1cb7279dab83f91a960484d7d1b1f012c9629026))
+* introduce licensing functionality and updates ([f314b00](https://github.com/webiny/webiny-js/commit/f314b007882c21a9808581de6bc8e55d3b7ed448))
+
+
+
+
+
+# [5.28.0](https://github.com/webiny/webiny-js/compare/v5.28.0-beta.0...v5.28.0) (2022-06-07)
+
+**Note:** Version bump only for package @webiny/cli
+
+
+
+
+
 # [5.28.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.27.0...v5.28.0-beta.0) (2022-06-07)
 
 **Note:** Version bump only for package @webiny/cli

package/README.md

@@ -4,4 +4,4 @@
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
-A pluggable tool to run commands within a Webiny project. 
+A pluggable tool to run commands within a Webiny project. 

package/commands/index.js

@@ -4,13 +4,8 @@ const wcp = require("./wcp");
 const upgrade = require("./upgrade");
 
 module.exports.createCommands = async (yargs, context) => {
-    context.plugins.register(run, telemetry, upgrade);
+    context.plugins.register(run, telemetry, upgrade, wcp);
 
-    // For now, only register WCP related commands if
-    // `WCP_APP_URL` and `WCP_API_URL` env vars are defined.
-    if (process.env.WCP_APP_URL && process.env.WCP_API_URL) {
-        context.plugins.register(wcp);
-    }
     await context.loadUserPlugins();
 
     context.plugins.byType("cli-command").forEach(plugin => {

package/commands/wcp/hooks.js

@@ -1,67 +1,111 @@
-const { getUser, getProjectEnvironmentBySlug, updateUserLastActiveOn } = require("./utils");
+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
+ */
+
+let projectEnvironment;
 
 module.exports = () => [
-    // Within this hook, we're setting the `WCP_ENVIRONMENT_API_KEY` env variable, which can then be used in
-    // build / deploy steps. For example, we pass it to GraphQL and Headless CMS Lambda functions.
     {
         type: "hook-before-deploy",
-        name: "hook-before-deploy-environment-api-key",
+        name: "hook-before-deploy-environment-get-environment",
         async hook(args, context) {
-            // If the `WCP_ENVIRONMENT_API_KEY` has already been assigned, no need to do anything.
-            if (process.env.WCP_ENVIRONMENT_API_KEY) {
+            // If the project isn't activated, do nothing.
+            if (!context.project.config.id) {
                 return;
             }
 
-            const environment = await getProjectEnvironment(args, context);
-            if (environment) {
-                process.env.WCP_ENVIRONMENT_API_KEY = environment.apiKey;
+            if (process.env.WCP_PROJECT_ENVIRONMENT) {
+                // If we have WCP_PROJECT_ENVIRONMENT env var, we set the WCP_PROJECT_ENVIRONMENT_API_KEY too.
+                if (!process.env.WCP_PROJECT_ENVIRONMENT_API_KEY) {
+                    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 orgProject = context.project.config.id;
+            const [orgId, projectId] = orgProject.split("/");
+
+            const isValidId = orgId && projectId;
+            if (!isValidId) {
+                throw new Error(
+                    `It seems the project ID, specified in "webiny.project.ts" file, is invalid.`
+                );
+            }
+
+            const apiKey = process.env.WCP_PROJECT_ENVIRONMENT_API_KEY;
+            if (apiKey) {
+                projectEnvironment = await getProjectEnvironment({ apiKey });
+            } else {
+                // 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 && projectEnvironment.status !== "enabled") {
+                throw new Error(
+                    `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment has been disabled.`
+                );
+            }
+        }
+    },
+    // Within this hook, we're setting the `WCP_PROJECT_ENVIRONMENT` env variable, which can then be used in
+    // build / deploy steps. For example, we pass it to GraphQL and Headless CMS Lambda functions.
+    {
+        type: "hook-before-deploy",
+        name: "hook-before-deploy-project-environment",
+        async hook() {
+            if (!projectEnvironment) {
+                return;
             }
+
+            // Ensure the correct API key is set into environment variable.
+            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;
         }
     },
     // Within this hook, we're updating user's "last active" field.
     {
         type: "hook-before-deploy",
         name: "hook-before-deploy-update-last-active-on",
-        async hook(args, context) {
+        async hook() {
+            if (!projectEnvironment) {
+                return;
+            }
+
             // Is this a user environment? If so, let's update his "last active" field.
-            const environment = await getProjectEnvironment(args, context);
-            if (environment && environment.user) {
+            if (projectEnvironment.user) {
                 await updateUserLastActiveOn();
             }
         }
     }
 ];
-
-const getProjectEnvironment = async (args, context) => {
-    // If the project isn't activated, also do nothing.
-    if (!context.project.config.id) {
-        return;
-    }
-
-    // The `id` has the orgId/projectId structure, for example `my-org-x/my-project-y`.
-    const orgProject = context.project.config.id;
-    const [orgId, projectId] = orgProject.split("/");
-
-    const isValidId = orgId && projectId;
-    if (!isValidId) {
-        throw new Error(
-            `It seems the project ID, specified in "webiny.project.ts" file, is invalid.`
-        );
-    }
-
-    // Check login.
-    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.`
-        );
-    }
-
-    return getProjectEnvironmentBySlug({
-        orgId,
-        projectId,
-        environmentSlug: args.env,
-        userId: user.id
-    });
-};

package/commands/wcp/login.js

@@ -1,7 +1,8 @@
 const open = require("open");
 const { GraphQLClient } = require("graphql-request");
-const { WCP_GRAPHQL_API_URL, WCP_APP_URL, setProjectId, setWcpPat, sleep } = require("./utils");
+const { setProjectId, setWcpPat, sleep } = require("./utils");
 const chalk = require("chalk");
+const { getWcpGqlApiUrl, getWcpAppUrl } = require("@webiny/wcp");
 
 // 120 retries * 2000ms interval = 4 minutes until the command returns an error.
 const LOGIN_RETRIES_COUNT = 30;
@@ -73,7 +74,7 @@ module.exports.command = () => ({
                 });
             },
             async ({ debug, debugLevel, pat: patFromParams }) => {
-                const graphQLClient = new GraphQLClient(WCP_GRAPHQL_API_URL);
+                const graphQLClient = new GraphQLClient(getWcpGqlApiUrl());
 
                 let pat;
 
@@ -115,7 +116,7 @@ module.exports.command = () => ({
                     const queryParams = `pat=${generatedPat}&pat_name=${encodeURIComponent(
                         "Webiny CLI"
                     )}&ref=cli`;
-                    const openUrl = `${WCP_APP_URL}/login/cli?${queryParams}`;
+                    const openUrl = `${getWcpAppUrl()}/login/cli?${queryParams}`;
 
                     debug && context.debug(`Opening ${context.debug.hl(openUrl)}...`);
                     await open(openUrl);
@@ -165,7 +166,7 @@ module.exports.command = () => ({
 
                     if (!result) {
                         throw new Error(
-                            `Could not login. Did you complete the sign in / sign up process at ${WCP_APP_URL}?`
+                            `Could not login. Did you complete the sign in / sign up process at ${getWcpAppUrl()}?`
                         );
                     }
 

package/commands/wcp/utils/{getProjectEnvironmentBySlug.js → getProjectEnvironment.js}

@@ -1,5 +1,6 @@
 const { localStorage, log } = require("@webiny/cli/utils");
 const { request } = require("graphql-request");
+const { getWcpGqlApiUrl } = require("@webiny/wcp");
 
 const ENVIRONMENT_FIELDS = /* GraphQL */ `
     fragment EnvironmentFields on Environment {
@@ -61,11 +62,12 @@ const GET_ENVIRONMENT = /* GraphQL */ `
     }
 `;
 
-module.exports.getProjectEnvironmentBySlug = async ({
+module.exports.getProjectEnvironment = async ({
     orgId,
     projectId,
     userId,
-    environmentSlug
+    environmentId,
+    apiKey
 }) => {
     const pat = localStorage().get("wcpPat");
     if (!pat) {
@@ -76,30 +78,30 @@ module.exports.getProjectEnvironmentBySlug = async ({
         );
     }
 
-    const { WCP_GRAPHQL_API_URL } = require(".");
     const headers = { authorization: pat };
     return request(
-        WCP_GRAPHQL_API_URL,
+        getWcpGqlApiUrl(),
         GET_ENVIRONMENT,
         {
             orgId,
             projectId,
             userId,
-            environmentId: environmentSlug
+            environmentId,
+            apiKey
         },
         headers
     )
         .then(async response => response.projects.getEnvironment)
         .catch(() => {
             return request(
-                WCP_GRAPHQL_API_URL,
+                getWcpGqlApiUrl(),
                 CREATE_ENVIRONMENT,
                 {
                     orgId,
                     projectId,
                     userId,
                     data: {
-                        name: environmentSlug
+                        name: environmentId
                     }
                 },
                 headers

package/commands/wcp/utils/getUser.js

@@ -1,6 +1,7 @@
 const { log } = require("@webiny/cli/utils");
 const { request } = require("graphql-request");
 const { getWcpPat } = require("./getWcpPat");
+const { getWcpGqlApiUrl } = require("@webiny/wcp");
 
 const GET_CURRENT_USER = /* GraphQL */ `
     query GetUser {
@@ -54,26 +55,25 @@ module.exports.getUser = async () => {
     const pat = getWcpPat();
     if (!pat) {
         throw new Error(
-            `It seems you are not logged in. Please login using the ${log.error.hl(
+            `It seems you are not logged into your WCP project. Please log in using the ${log.error.hl(
                 "yarn webiny login"
-            )} command.`
+            )} command. If you are not using WCP, make sure you don't have an "id" property in your "webiny.project.ts" file.`
         );
     }
 
     try {
-        const { WCP_GRAPHQL_API_URL } = require(".");
         const headers = { authorization: pat };
-        user = await request(WCP_GRAPHQL_API_URL, GET_CURRENT_USER, {}, headers).then(
+        user = await request(getWcpGqlApiUrl(), GET_CURRENT_USER, {}, headers).then(
             async response => {
                 const user = response.users.getCurrentUser;
 
-                const orgs = await request(WCP_GRAPHQL_API_URL, LIST_ORGS, {}, headers).then(
+                const orgs = await request(getWcpGqlApiUrl(), LIST_ORGS, {}, headers).then(
                     async response => {
                         const orgs = response.orgs.listOrgs.data;
                         for (let i = 0; i < orgs.length; i++) {
                             const org = orgs[i];
                             org.projects = await request(
-                                WCP_GRAPHQL_API_URL,
+                                getWcpGqlApiUrl(),
                                 LIST_PROJECTS,
                                 { orgId: org.id },
                                 headers
@@ -90,7 +90,7 @@ module.exports.getUser = async () => {
         );
     } catch {
         throw new Error(
-            `It seems the personal access token is incorrect or does not exist. Please log out and again log in using the ${log.error.hl(
+            `It seems the personal access token is incorrect or does not exist. Please log out and log in again using the ${log.error.hl(
                 "yarn webiny login"
             )} command.`
         );

package/commands/wcp/utils/index.js

@@ -1,9 +1,5 @@
-const WCP_APP_URL = process.env.WCP_APP_URL || "https://wcp.webiny.com";
-const WCP_API_URL = process.env.WCP_API_URL || "https://api.wcp.webiny.com/graphql";
-const WCP_GRAPHQL_API_URL = WCP_API_URL + "/graphql";
-
 const { getUser } = require("./getUser");
-const { getProjectEnvironmentBySlug } = require("./getProjectEnvironmentBySlug");
+const { getProjectEnvironment } = require("./getProjectEnvironment");
 const { updateUserLastActiveOn } = require("./updateUserLastActiveOn");
 const { setProjectId } = require("./setProjectId");
 const { setWcpPat } = require("./setWcpPat");
@@ -12,13 +8,10 @@ const { sleep } = require("./sleep");
 
 module.exports = {
     getUser,
-    getProjectEnvironmentBySlug,
+    getProjectEnvironment,
     updateUserLastActiveOn,
     setProjectId,
     setWcpPat,
     getWcpPat,
-    sleep,
-    WCP_APP_URL,
-    WCP_API_URL,
-    WCP_GRAPHQL_API_URL
+    sleep
 };

package/commands/wcp/utils/updateUserLastActiveOn.js

@@ -1,5 +1,6 @@
 const { request } = require("graphql-request");
 const { localStorage, log } = require("@webiny/cli/utils");
+const { getWcpGqlApiUrl } = require("@webiny/wcp");
 
 const UPDATE_LAST_ACTIVE_TO_NOW = /* GraphQL */ `
     mutation UpdateLastActiveToNow {
@@ -22,7 +23,6 @@ module.exports.updateUserLastActiveOn = async () => {
         );
     }
 
-    const { WCP_GRAPHQL_API_URL } = require(".");
     const headers = { authorization: pat };
-    return request(WCP_GRAPHQL_API_URL, UPDATE_LAST_ACTIVE_TO_NOW, {}, headers);
+    return request(getWcpGqlApiUrl(), UPDATE_LAST_ACTIVE_TO_NOW, {}, headers);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/cli",
-	"version": "5.28.0-beta.0",
+	"version": "5.29.0-beta.1",
 	"main": "index.js",
 	"bin": {
 		"webiny": "./bin.js"
@@ -13,16 +13,19 @@
 	"author": "Pavel Denisjuk <pavel@webiny.com>",
 	"description": "A tool to bootstrap a Webiny project.",
 	"dependencies": {
-		"@webiny/telemetry": "5.28.0-beta.0",
+		"@webiny/telemetry": "5.29.0-beta.1",
+		"@webiny/wcp": "5.29.0-beta.1",
 		"boolean": "3.1.4",
 		"camelcase": "5.3.1",
 		"chalk": "4.1.2",
 		"dotenv": "8.2.0",
-		"execa": "2.1.0",
+		"execa": "5.1.1",
 		"fast-glob": "3.2.7",
 		"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.7",
@@ -63,5 +66,5 @@
 			]
 		}
 	},
-	"gitHead": "6503c7f86cfc90660f005acf72049505bfd4fb76"
+	"gitHead": "e4393aa7faa07c7a465ff320d8b4dc51f2f38315"
 }

package/utils/createProjectApplicationWorkspace.js

@@ -0,0 +1,16 @@
+const util = require("util");
+const fs = require("fs-extra");
+const ncpBase = require("ncp");
+const ncp = util.promisify(ncpBase.ncp);
+
+module.exports = async projectApplication => {
+    if (await fs.pathExists(projectApplication.paths.workspace)) {
+        await fs.remove(projectApplication.paths.workspace);
+    }
+
+    await fs.ensureDir(projectApplication.paths.workspace);
+    await ncp(projectApplication.paths.absolute, projectApplication.paths.workspace);
+
+    // Wait a bit and make sure the files are ready to have its content replaced.
+    return new Promise(resolve => setTimeout(resolve, 10));
+};

package/utils/getApiProjectApplicationFolder.js

@@ -0,0 +1,12 @@
+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/getProjectApplication.js

@@ -1,4 +1,4 @@
-const { dirname, basename, join } = require("path");
+const { dirname, basename, join, relative } = require("path");
 const findUp = require("find-up");
 const getProject = require("./getProject");
 const { importModule } = require("./importModule");
@@ -15,31 +15,55 @@ module.exports = args => {
     }
 
     const rootFile = applicationRootFile.replace(/\\/g, "/");
-    const applicationRoot = dirname(rootFile);
+    const projectAppRootPath = dirname(rootFile);
 
     let applicationConfig;
     if (appConfigs.includes(basename(rootFile))) {
         applicationConfig = importModule(rootFile);
     }
 
-    let name, id;
+    let id, name, description;
     if (applicationConfig) {
         id = applicationConfig.id;
         name = applicationConfig.name;
+        description = applicationConfig.description;
     } else {
-        name = basename(applicationRoot);
+        name = basename(projectAppRootPath);
+        description = name;
         id = name;
     }
 
+    const project = getProject(args);
+
+    const projectAppRelativePath = relative(project.root, projectAppRootPath);
+    const projectAppWorkspacePath = join(
+        project.root,
+        ".webiny",
+        "workspaces",
+        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,
-        root: applicationRoot,
+        description,
+        type,
+        root: projectAppRootPath,
+        paths: {
+            relative: projectAppRelativePath,
+            absolute: projectAppRootPath,
+            workspace: projectAppWorkspacePath
+        },
         config: applicationConfig,
-        project: getProject(args),
+        project,
         get packages() {
             const webinyConfigs = glob.sync(
-                join(applicationRoot, "**/webiny.config*.{ts,js}").replace(/\\/g, "/")
+                join(projectAppRootPath, "**/webiny.config*.{ts,js}").replace(/\\/g, "/")
             );
 
             return webinyConfigs.map(config => {

package/utils/index.d.ts

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

package/utils/index.js

@@ -1,15 +1,19 @@
 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");
 const PluginsContainer = require("./PluginsContainer");
 
 module.exports = {
-    importModule,
+    createProjectApplicationWorkspace,
+    getApiProjectApplicationFolder,
     getProject,
     getProjectApplication,
+    importModule,
     localStorage,
     log,
     sendEvent,