refactor(CLI Onboarding): Integrate steps from dashboard plugin

serverless · May 12, 2021 · 105807a · 105807a
1 parent a26a21f
commit 105807a
Show file tree

Hide file tree

Showing 14 changed files with 97 additions and 57 deletions.
diff --git a/.github/prepare-canary.js b/.github/prepare-canary.js
@@ -11,6 +11,6 @@ const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
 
 packageJson.version = `${packageJson.version}-${process.env.GITHUB_SHA.slice(0, 8)}`;
 packageJson.dependencies['@serverless/components'] = 'canary';
-packageJson.dependencies['@serverless/enterprise-plugin'] = 'canary';
+packageJson.dependencies['@serverless/dashboard-plugin'] = 'canary';
 
 fs.writeFileSync(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`);
diff --git a/lib/Serverless.js b/lib/Serverless.js
@@ -144,7 +144,7 @@ class Serverless {
     this.isLocallyInstalled = false;
     this.triggeredDeprecations = logDeprecation.triggeredDeprecations;
 
-    // TODO: Remove once "@serverless/enterprise-plugin" is integrated into this repository
+    // TODO: Remove once "@serverless/dashboard-plugin" is integrated into this repository
     this._commandsSchema = commmandsSchema;
   }
 

diff --git a/lib/classes/PluginManager.js b/lib/classes/PluginManager.js
@@ -165,48 +165,52 @@ class PluginManager {
   resolveServicePlugins(servicePlugs) {
     const pluginsObject = this.parsePluginsObject(servicePlugs);
     const serviceDir = this.serverless.serviceDir;
-    return pluginsObject.modules
-      .filter((name) => name !== '@serverless/enterprise-plugin')
-      .map((name) => {
-        let Plugin;
-        try {
-          Plugin = requireServicePlugin(serviceDir, name, pluginsObject.localPath);
-        } catch (error) {
-          if (!isModuleNotFoundError(error, name)) throw error;
-
-          // Plugin not installed
-          if (
-            resolveCliInput().isHelpRequest ||
-            this.pluginIndependentCommands.has(this.cliCommands[0])
-          ) {
-            // User may intend to install plugins just listed in serverless config
-            // Therefore skip on MODULE_NOT_FOUND case
-            return null;
-          }
+    return (
+      pluginsObject.modules
+        // Initially @serverless/enterprise-plugin was published as external plugin
+        // We ensure to not load it, if for some reason it's still in service configuration
+        .filter((name) => name !== '@serverless/enterprise-plugin')
+        .map((name) => {
+          let Plugin;
+          try {
+            Plugin = requireServicePlugin(serviceDir, name, pluginsObject.localPath);
+          } catch (error) {
+            if (!isModuleNotFoundError(error, name)) throw error;
+
+            // Plugin not installed
+            if (
+              resolveCliInput().isHelpRequest ||
+              this.pluginIndependentCommands.has(this.cliCommands[0])
+            ) {
+              // User may intend to install plugins just listed in serverless config
+              // Therefore skip on MODULE_NOT_FOUND case
+              return null;
+            }
 
-          throw new ServerlessError(
-            [
-              `Serverless plugin "${name}" not found.`,
-              ' Make sure it\'s installed and listed in the "plugins" section',
-              ' of your serverless config file.',
-            ].join(''),
-            'PLUGIN_NOT_FOUND'
-          );
-        }
-        if (!Plugin) {
-          throw new ServerlessError(
-            `Serverless plugin "${name}", didn't export Plugin constructor.`,
-            'MISSING_PLUGIN_NAME'
-          );
-        }
-        return Plugin;
-      });
+            throw new ServerlessError(
+              [
+                `Serverless plugin "${name}" not found.`,
+                ' Make sure it\'s installed and listed in the "plugins" section',
+                ' of your serverless config file.',
+              ].join(''),
+              'PLUGIN_NOT_FOUND'
+            );
+          }
+          if (!Plugin) {
+            throw new ServerlessError(
+              `Serverless plugin "${name}", didn't export Plugin constructor.`,
+              'MISSING_PLUGIN_NAME'
+            );
+          }
+          return Plugin;
+        })
+    );
   }
 
   resolveEnterprisePlugin() {
     if (config.getConfig().enterpriseDisabled) return null;
     this.pluginIndependentCommands.add('login').add('logout').add('dashboard');
-    return require('@serverless/enterprise-plugin');
+    return require('@serverless/dashboard-plugin');
   }
 
   parsePluginsObject(servicePlugs) {

diff --git a/lib/cli/handle-error.js b/lib/cli/handle-error.js
@@ -6,8 +6,8 @@ const chalk = require('chalk');
 const isStandaloneExecutable = require('../utils/isStandaloneExecutable');
 const resolveLocalServerlessPath = require('./resolve-local-serverless-path');
 const slsVersion = require('./../../package').version;
-const sfeVersion = require('@serverless/enterprise-plugin/package.json').version;
-const { platformClientVersion } = require('@serverless/enterprise-plugin');
+const sfeVersion = require('@serverless/dashboard-plugin/package.json').version;
+const { platformClientVersion } = require('@serverless/dashboard-plugin');
 const ServerlessError = require('../serverless-error');
 const tokenizeException = require('../utils/tokenize-exception');
 const resolveIsLocallyInstalled = require('../utils/is-locally-installed');

diff --git a/lib/cli/interactive-setup/index.js b/lib/cli/interactive-setup/index.js
@@ -1,17 +1,23 @@
 'use strict';
 
+const inquirer = require('@serverless/utils/inquirer');
+
 const steps = {
   service: require('./service'),
+  dashboardLogin: require('@serverless/dashboard-plugin/lib/cli/interactive-setup/dashboard-login'),
+  dashboardSetOrg: require('@serverless/dashboard-plugin/lib/cli/interactive-setup/dashboard-set-org'),
   awsCredentials: require('./aws-credentials'),
   autoUpdate: require('./auto-update'),
   tabCompletion: require('./tab-completion'),
 };
 
 module.exports = async (context) => {
+  context = { ...context, inquirer };
   for (const step of Object.values(steps)) {
-    if (await step.isApplicable(context)) {
+    const stepData = await step.isApplicable(context);
+    if (stepData) {
       process.stdout.write('\n');
-      await step.run(context);
+      await step.run(context, stepData);
     }
   }
 };
diff --git a/lib/cli/render-version.js b/lib/cli/render-version.js
@@ -2,9 +2,9 @@
 
 const path = require('path');
 const { version } = require('../../package');
-const { version: dashboardPluginVersion } = require('@serverless/enterprise-plugin/package');
+const { version: dashboardPluginVersion } = require('@serverless/dashboard-plugin/package');
 const { version: componentsVersion } = require('@serverless/components/package');
-const { platformClientVersion } = require('@serverless/enterprise-plugin');
+const { platformClientVersion } = require('@serverless/dashboard-plugin');
 const isStandaloneExecutable = require('../utils/isStandaloneExecutable');
 const resolveLocalServerlessPath = require('./resolve-local-serverless-path');
 const chalk = require('chalk');

diff --git a/lib/utils/telemetry/generatePayload.js b/lib/utils/telemetry/generatePayload.js
@@ -136,15 +136,31 @@ module.exports = async ({
     if (!isLocallyInstalled || (await resolveIsLocallyInstalled())) {
       return {
         'serverless': require('../../../package').version,
-        '@serverless/enterprise-plugin': require('@serverless/enterprise-plugin/package').version,
+        '@serverless/dashboard-plugin': require('@serverless/dashboard-plugin/package').version,
       };
     }
     const localServerlessPath = await resolveLocalServerlessPath();
     return {
       'serverless': require(path.resolve(localServerlessPath, 'package.json')).version,
-      '@serverless/enterprise-plugin': require((
-        await resolve(localServerlessPath, '@serverless/enterprise-plugin/package')
-      ).realPath).version,
+      // Since v2.42.0 it's "@serverless/dashboard-plugin"
+      '@serverless/dashboard-plugin': await (async () => {
+        try {
+          return require((
+            await resolve(localServerlessPath, '@serverless/dashboard-plugin/package')
+          ).realPath).version;
+        } catch {
+          return undefined;
+        }
+      })(),
+      '@serverless/enterprise-plugin': await (async () => {
+        try {
+          return require((
+            await resolve(localServerlessPath, '@serverless/enterprise-plugin/package')
+          ).realPath).version;
+        } catch {
+          return undefined;
+        }
+      })(),
     };
   })();
 

diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
   "dependencies": {
     "@serverless/cli": "^1.5.2",
     "@serverless/components": "^3.9.2",
-    "@serverless/enterprise-plugin": "^4.6.0",
+    "@serverless/dashboard-plugin": "^5.0.0",
     "@serverless/utils": "^4.1.0",
     "ajv": "^6.12.6",
     "ajv-keywords": "^3.5.2",

diff --git a/scripts/pkg/config.js b/scripts/pkg/config.js
@@ -14,10 +14,10 @@ module.exports = {
     // Local invocation artifacts
     '../../lib/plugins/aws/invokeLocal/runtimeWrappers',
     // Dashboard policies
-    '../../node_modules/@serverless/enterprise-plugin/lib/safeguards/policies',
+    '../../node_modules/@serverless/dashboard-plugin/lib/safeguards/policies',
     // Dashboard wrappers
-    '../../node_modules/@serverless/enterprise-plugin/sdk-js/dist/index.js',
-    '../../node_modules/@serverless/enterprise-plugin/sdk-py',
+    '../../node_modules/@serverless/dashboard-plugin/sdk-js/dist/index.js',
+    '../../node_modules/@serverless/dashboard-plugin/sdk-py',
     // Ensure npm is bundled as a dependency
     '../../node_modules/npm/bin/npm-cli.js',
     // Below module is not automatically traced by pkg, we need to point it manually

diff --git a/...serverless/enterprise-plugin/package.json → ...@serverless/dashboard-plugin/package.json b/...serverless/enterprise-plugin/package.json → ...@serverless/dashboard-plugin/package.json
diff --git a/test/unit/lib/classes/PluginManager.test.js b/test/unit/lib/classes/PluginManager.test.js
@@ -657,7 +657,7 @@ describe('PluginManager', () => {
       mockRequire('ServicePluginMock1', ServicePluginMock1);
       mockRequire('ServicePluginMock2', ServicePluginMock2);
       mockRequire('BrokenPluginMock', BrokenPluginMock);
-      mockRequire('@serverless/enterprise-plugin', EnterprisePluginMock);
+      mockRequire('@serverless/dashboard-plugin', EnterprisePluginMock);
     });
 
     it('should load only core plugins when no service plugins are given', () => {
@@ -742,7 +742,7 @@ describe('PluginManager', () => {
       mockRequire.stop('ServicePluginMock1');
       mockRequire.stop('ServicePluginMock2');
       mockRequire.stop('BrokenPluginMock');
-      mockRequire.stop('@serverless/enterprise-plugin');
+      mockRequire.stop('@serverless/dashboard-plugin');
     });
   });
 

diff --git a/test/unit/lib/cli/interactive-setup/index.test.js b/test/unit/lib/cli/interactive-setup/index.test.js
@@ -32,6 +32,19 @@ describe('test/unit/lib/cli/interactive-setup/index.test.js', () => {
         input: 'interactive-setup-test',
       },
 
+      // dashboard-login
+      {
+        instructionString: 'Would you like to enable this?',
+        input: 'Y',
+      },
+      {
+        instructionString: 'login or register?',
+        input: 'j',
+      },
+
+      // dashboard-set-org
+      // Skipped, as internally depends on remote state of data and cannot be easily tested offline
+
       // aws-credentials
       { instructionString: 'Do you want to set them up now?', input: 'Y' },
       { instructionString: 'AWS account', input: 'Y' },

diff --git a/test/unit/lib/plugins/aws/package/compile/functions.test.js b/test/unit/lib/plugins/aws/package/compile/functions.test.js
@@ -2588,7 +2588,7 @@ describe('lib/plugins/aws/package/compile/functions/index.test.js', () => {
       //    - Corresponding url is configured in CF template
       // Test with "deploy" command, and configure `lastLifecycleHookName` to 'aws:deploy:deploy:uploadArtifact'
       // It'll demand stubbing few other AWS calls for that follow this stub:
-      // https://github.com/serverless/enterprise-plugin/blob/cdd53df45dfad18d8bdd79969194a61cb8178671/lib/deployment/parse.test.js#L1585-L1627
+      // https://github.com/serverless/dashboard-plugin/blob/cdd53df45dfad18d8bdd79969194a61cb8178671/lib/deployment/parse.test.js#L1585-L1627
       // Confirm same artifact is used for all functions
     });
 

diff --git a/test/unit/lib/utils/telemetry/generatePayload.test.js b/test/unit/lib/utils/telemetry/generatePayload.test.js
@@ -15,7 +15,7 @@ const fixtures = require('../../../../fixtures/programmatic');
 
 const versions = {
   'serverless': require('../../../../../package').version,
-  '@serverless/enterprise-plugin': require('@serverless/enterprise-plugin/package').version,
+  '@serverless/dashboard-plugin': require('@serverless/dashboard-plugin/package').version,
 };
 
 describe('test/unit/lib/utils/telemetry/generatePayload.test.js', () => {
@@ -224,7 +224,8 @@ describe('test/unit/lib/utils/telemetry/generatePayload.test.js', () => {
       installationType: 'local:fallback',
       versions: {
         'serverless': '2.0.0-local',
-        '@serverless/enterprise-plugin': '4.0.0-local',
+        '@serverless/dashboard-plugin': '4.0.0-local',
+        '@serverless/enterprise-plugin': undefined,
       },
     });
   });