Re-create 1.3.0

Author: mnapoli

components/framework/configuration.js

@@ -5,6 +5,7 @@ const configSchema = {
   properties: {
     path: { type: 'string' },
     region: { type: 'string' },
+    config: { type: 'string' },
     params: {
       type: 'object',
       additionalProperties: true,

components/framework/index.js

@@ -116,6 +116,14 @@ class ServerlessFramework {
     this.context.successProgress('removed');
   }
 
+  async package() {
+    this.context.startProgress('packaging');
+
+    await this.exec('serverless', ['package']);
+
+    this.context.successProgress('packaged');
+  }
+
   async info() {
     const { stdout: infoOutput } = await this.exec('serverless', ['info']);
     this.context.writeText(infoOutput);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serverless/compose",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Deploy and orchestrate multiple Serverless Framework services in monorepositories.",
   "main": "src/index.js",
   "repository": "serverless/compose",
@@ -19,14 +19,14 @@
   "author": "serverless.com",
   "license": "MIT",
   "dependencies": {
-    "@aws-sdk/client-cloudformation": "^3.100.0",
-    "@aws-sdk/client-s3": "^3.100.0",
-    "@serverless-components/utils-aws": "^0.0.1",
-    "@serverless/utils": "^6.6.0",
+    "@aws-sdk/client-cloudformation": "^3.137.0",
+    "@aws-sdk/client-s3": "^3.137.0",
+    "@serverless-components/utils-aws": "^0.1.0",
+    "@serverless/utils": "^6.7.0",
     "ajv": "^8.11.0",
     "chalk": "^4.1.2",
     "child-process-ext": "^2.1.1",
-    "ci-info": "^3.3.1",
+    "ci-info": "^3.3.2",
     "cli-cursor": "^3",
     "cross-spawn": "^7.0.3",
     "fs-extra": "^10.1.0",
@@ -38,6 +38,7 @@
     "js-yaml": "^4.1.0",
     "minimist": "^1.2.6",
     "node-fetch": "^2.6.7",
+    "p-limit": "^3.1.0",
     "path2": "^0.1.0",
     "prettyoutput": "^1.2.0",
     "promise-queue": "^2.2.5",
@@ -46,7 +47,7 @@
     "signal-exit": "^3.0.7",
     "strip-ansi": "^6.0.1",
     "traverse": "^0.6.6",
-    "type": "^2.6.0",
+    "type": "^2.6.1",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
@@ -56,12 +57,12 @@
     "aws-sdk-client-mock": "^0.6.2",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.16.0",
+    "eslint": "^8.20.0",
     "eslint-plugin-import": "^2.26.0",
     "git-list-updated": "^1.2.1",
     "mocha": "^9.2.2",
-    "pkg": "^5.7.0",
-    "prettier": "^2.6.2",
+    "pkg": "^5.8.0",
+    "prettier": "^2.7.1",
     "proxyquire": "^2.1.3",
     "sinon": "^13.0.2",
     "sinon-chai": "^3.7.0"

src/ComponentsService.js

@@ -4,6 +4,7 @@ const { resolve } = require('path');
 const { isEmpty, path } = require('ramda');
 const { Graph, alg } = require('graphlib');
 const traverse = require('traverse');
+const pLimit = require('p-limit');
 const ServerlessError = require('./serverless-error');
 const utils = require('./utils');
 const { loadComponent } = require('./load');
@@ -223,10 +224,12 @@ class ComponentsService {
   /**
    * @param {import('./Context')} context
    * @param configuration
+   * @param options
    */
-  constructor(context, configuration) {
+  constructor(context, configuration, options) {
     this.context = context;
     this.configuration = configuration;
+    this.options = options;
 
     // Variables that will be populated during init
     this.allComponents = null;
@@ -304,6 +307,13 @@ class ComponentsService {
     });
   }
 
+  async package(options) {
+    this.context.output.log();
+    this.context.output.log(`Packaging for stage ${this.context.stage}`);
+
+    await this.invokeComponentsInParallel('package', options);
+  }
+
   async logs(options) {
     await this.invokeComponentsInParallel('logs', options);
   }
@@ -330,16 +340,16 @@ class ComponentsService {
   }
 
   async invokeGlobalCommand(command, options) {
-    const globalCommands = ['deploy', 'remove', 'info', 'logs', 'outputs', 'refresh-outputs'];
+    const globalCommands = [
+      'deploy',
+      'remove',
+      'info',
+      'logs',
+      'outputs',
+      'refresh-outputs',
+      'package',
+    ];
     // Specific error messages for popular Framework commands
-    if (command === 'package') {
-      throw new ServerlessError(
-        `"package" is not a global command in Serverless Framework Compose.\nAvailable global commands: ${globalCommands.join(
-          ', '
-        )}.\nYou can package each Serverless Framework service by running "serverless <service-name>:${command}".`,
-        'COMMAND_NOT_FOUND'
-      );
-    }
     if (command === 'invoke') {
       throw new ServerlessError(
         `"invoke" is not a global command in Serverless Framework Compose.\nAvailable global commands: ${globalCommands.join(
@@ -391,7 +401,7 @@ class ComponentsService {
       }
       this.context.logVerbose(`Invoking "${command}" on service "${componentName}"`);
 
-      const isDefaultCommand = ['deploy', 'remove', 'logs', 'info'].includes(command);
+      const isDefaultCommand = ['deploy', 'remove', 'logs', 'info', 'package'].includes(command);
 
       if (isDefaultCommand) {
         // Default command defined for all components (deploy, logs, dev, etc.)
@@ -440,21 +450,29 @@ class ComponentsService {
     await this.instantiateComponents();
 
     this.context.logVerbose(`Executing "${method}" across all services in parallel`);
-    const promises = Object.entries(this.allComponents).map(async ([id, { instance }]) => {
-      if (typeof instance[method] !== 'function') return;
-      try {
-        await instance[method](options);
-        this.context.componentCommandsOutcomes[id] = 'success';
-      } catch (e) {
-        // If the component has an ongoing progress, we automatically set it to "error"
-        if (this.context.progresses.exists(id)) {
-          this.context.progresses.error(id, e);
-        } else {
-          this.context.output.error(formatError(e), [id]);
+    const limit = pLimit(options['max-concurrency'] || Infinity);
+
+    const promises = [];
+
+    for (const [id, { instance }] of Object.entries(this.allComponents)) {
+      const fn = async () => {
+        if (typeof instance[method] !== 'function') return;
+        try {
+          await instance[method](options);
+          this.context.componentCommandsOutcomes[id] = 'success';
+        } catch (e) {
+          // If the component has an ongoing progress, we automatically set it to "error"
+          if (this.context.progresses.exists(id)) {
+            this.context.progresses.error(id, e);
+          } else {
+            this.context.output.error(formatError(e), [id]);
+          }
+          this.context.componentCommandsOutcomes[id] = 'failure';
         }
-        this.context.componentCommandsOutcomes[id] = 'failure';
-      }
-    });
+      };
+
+      promises.push(limit(fn));
+    }
 
     await Promise.all(promises);
   }
@@ -476,6 +494,8 @@ class ComponentsService {
       return;
     }
 
+    const limit = pLimit(this.options['max-concurrency'] || Infinity);
+
     /** @type {Promise<boolean>[]} */
     const promises = [];
 
@@ -519,7 +539,7 @@ class ComponentsService {
         }
       };
 
-      promises.push(fn());
+      promises.push(limit(fn));
     }
 
     const results = await Promise.all(promises);

src/cli/Progresses.js

@@ -245,7 +245,7 @@ class Progresses {
     }
 
     if (this.footerText) {
-      output += `\n${this.footerText.trim()}`;
+      output += `\n${this.footerText.trim()}\r`;
     }
 
     output = this.wrapMultilineText(output);

src/configuration/resolve-variables.js

@@ -13,8 +13,8 @@ const resolveConfigurationVariables = async (
   unrecognizedVariableSources = new Set()
 ) => {
   const regex = /\${(\w*:[\w\d.-]+)}/g;
-  const slsStageRegex = /\${sls:stage}/g;
-  const envRegex = /\${env:(\w*[\w.-_]+)}/g;
+  const slsStageRegex = /\${sls:stage}/;
+  const envRegex = /\${env:(\w*[\w.-_]+)}/;
 
   let variableResolved = false;
   const resolvedConfiguration = traverse(configuration).forEach(function (value) {

src/index.js

@@ -125,7 +125,7 @@ const runComponents = async () => {
   validateOptions(options, method);
 
   try {
-    const componentsService = new ComponentsService(context, configuration);
+    const componentsService = new ComponentsService(context, configuration, options);
     await componentsService.init();
 
     // Additionally, we're raising the listener default limit by 1 for each component - we might revisit it in the future

src/render-help.js

@@ -55,6 +55,12 @@ module.exports = async () => {
   output.writeText(colors.gray('Global options'));
   output.writeText(formatLine('--verbose', 'Enable verbose logs'));
   output.writeText(formatLine('--stage', 'Stage of the service'));
+  output.writeText(
+    formatLine(
+      '--max-concurrency',
+      'Specify the maximum number of concurrently running service commands'
+    )
+  );
   output.writeText();
   output.writeText(colors.gray('Commands'));
 

src/utils/telemetry/generate-payload.js

@@ -71,6 +71,8 @@ module.exports = ({
 
   const commandType = componentName ? 'single' : 'global';
 
+  const stage = (options && options.stage) || 'dev';
+
   const payload = {
     command,
     commandType,
@@ -81,6 +83,7 @@ module.exports = ({
     commandOptionNames: options ? Object.keys(options).filter((key) => key !== '_') : [],
     frameworkLocalUserId: userConfig.get('frameworkId'),
     interruptSignal,
+    stage,
     timestamp: Date.now(),
     timezone,
     versions: usedVersions,
@@ -120,7 +123,7 @@ module.exports = ({
           return serviceDefinition.dependsOn.length;
         })();
         return {
-          type: serviceDefinition.type || 'serverless-framework',
+          type: serviceDefinition.component || 'serverless-framework',
           dependsOnCount,
           paramsCount: Object.values(serviceDefinition.params || {}).length,
         };
@@ -132,10 +135,10 @@ module.exports = ({
         if (!configuration.services[componentName]) {
           return ['unknown'];
         }
-        return [configuration.services[componentName].type || 'serverless-framework'];
+        return [configuration.services[componentName].component || 'serverless-framework'];
       }
       return Object.values(configuration.services).map(
-        (serviceDefinition) => serviceDefinition.type || 'serverless-framework'
+        (serviceDefinition) => serviceDefinition.component || 'serverless-framework'
       );
     })();
 

src/validate-options.js

@@ -17,7 +17,7 @@ function validateCliOptions(options, method) {
   });
 
   // Globally recognized options for global Compose methods
-  const supportedOptions = new Set(['verbose', 'stage']);
+  const supportedOptions = new Set(['verbose', 'stage', 'max-concurrency']);
   // We only validate methods that are explicitly recognized by Compose (excluding pass-through methods for Framework)
 
   const recognizedMethods = new Set([
@@ -27,6 +27,7 @@ function validateCliOptions(options, method) {
     'logs',
     'outputs',
     'refresh-outputs',
+    'package',
   ]);
 
   if (!recognizedMethods.has(method)) return;