@pwrdrvr/microapps-publish 0.3.5 → 0.4.0-alpha.10

package/src/commands/delete.ts

@@ -19,22 +19,40 @@ export class DeleteCommand extends Command {
       char: 'v',
     }),
     help: flagsParser.help(),
+    // Deprecated
     appName: flagsParser.string({
-      char: 'a',
       multiple: false,
       required: false,
-      description: 'Name of the MicroApp',
+      hidden: true,
     }),
+    'app-name': flagsParser.string({
+      char: 'a',
+      multiple: false,
+      exactlyOne: ['app-name', 'appName'],
+      description: 'MicroApps app name (this becomes the path the app is rooted at)',
+    }),
+    // Deprecated
     newVersion: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'new-version': flagsParser.string({
       char: 'n',
       multiple: false,
-      required: true,
+      exactlyOne: ['new-version', 'newVersion'],
       description: 'New semantic version to apply',
     }),
+    // Deprecated
     deployerLambdaName: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'deployer-lambda-name': flagsParser.string({
       char: 'd',
       multiple: false,
-      required: true,
+      exactlyOne: ['deployer-lambda-name', 'deployerLambdaName'],
       description: 'Name of the deployer lambda function',
     }),
   };
@@ -47,10 +65,12 @@ export class DeleteCommand extends Command {
     const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(DeleteCommand);
-    const version = parsedFlags.newVersion;
-    const appName = parsedFlags.appName ?? config.app.name;
-    const deployerLambdaName = parsedFlags.deployerLambdaName ?? config.deployer.lambdaName;
-    const semVer = parsedFlags.newVersion ?? config.app.semVer;
+    const semVer = parsedFlags.newVersion ?? parsedFlags['new-version'] ?? config.app.semVer;
+    const appName = parsedFlags.appName ?? parsedFlags['app-name'] ?? config.app.name;
+    const deployerLambdaName =
+      parsedFlags.deployerLambdaName ??
+      parsedFlags['deployer-lambda-name'] ??
+      config.deployer.lambdaName;
 
     // Override the config value
     config.deployer.lambdaName = deployerLambdaName;
@@ -87,7 +107,7 @@ export class DeleteCommand extends Command {
             task.title = RUNNING + origTitle;
 
             // Confirm the Version Does Not Exist in Published State
-            task.output = `Deleting app/version ${config.app.name}/${version}`;
+            task.output = `Deleting app/version ${config.app.name}/${semVer}`;
             const result = await DeployClient.DeleteVersion({
               config,
               output: (message: string) => (task.output = message),

package/src/commands/nextjs-version.ts

@@ -18,13 +18,27 @@ export class NextJSVersionCommand extends Command {
       char: 'v',
     }),
     help: flagsParser.help(),
+    // Deprecated
     newVersion: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'new-version': flagsParser.string({
       char: 'n',
       multiple: false,
-      required: true,
+      exactlyOne: ['new-version', 'newVersion'],
       description: 'New semantic version to apply',
     }),
+    // Deprecated
     leaveCopy: flagsParser.boolean({
+      char: 'l',
+      default: false,
+      required: false,
+      hidden: true,
+      exclusive: ['leave-copy'],
+    }),
+    'leave-copy': flagsParser.boolean({
       char: 'l',
       default: false,
       required: false,
@@ -44,14 +58,14 @@ export class NextJSVersionCommand extends Command {
     const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(NextJSVersionCommand);
-    const version = parsedFlags.newVersion;
-    const leaveFiles = parsedFlags.leaveCopy;
+    const semVer = parsedFlags.newVersion ?? parsedFlags['new-version'];
+    const leaveFiles = parsedFlags.leaveCopy ?? parsedFlags['leave-copy'];
 
     // Override the config value
     const config = Config.instance;
-    config.app.semVer = version;
+    config.app.semVer = semVer;
 
-    this.VersionAndAlias = createVersions(version);
+    this.VersionAndAlias = createVersions(semVer);
     const versionOnly = { version: this.VersionAndAlias.version };
 
     this.FILES_TO_MODIFY = [{ path: 'next.config.js', versions: versionOnly }];

package/src/commands/preflight.ts

@@ -19,22 +19,40 @@ export class PreflightCommand extends Command {
       char: 'v',
     }),
     help: flagsParser.help(),
+    // Deprecated
     appName: flagsParser.string({
-      char: 'a',
       multiple: false,
       required: false,
-      description: 'Name of the MicroApp',
+      hidden: true,
     }),
+    'app-name': flagsParser.string({
+      char: 'a',
+      multiple: false,
+      exactlyOne: ['app-name', 'appName'],
+      description: 'MicroApps app name (this becomes the path the app is rooted at)',
+    }),
+    // Deprecated
     newVersion: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'new-version': flagsParser.string({
       char: 'n',
       multiple: false,
-      required: true,
+      exactlyOne: ['new-version', 'newVersion'],
       description: 'New semantic version to apply',
     }),
+    // Deprecated
     deployerLambdaName: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'deployer-lambda-name': flagsParser.string({
       char: 'd',
       multiple: false,
-      required: true,
+      exactlyOne: ['deployer-lambda-name', 'deployerLambdaName'],
       description: 'Name of the deployer lambda function',
     }),
     overwrite: flagsParser.boolean({
@@ -54,10 +72,12 @@ export class PreflightCommand extends Command {
     const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(PreflightCommand);
-    const version = parsedFlags.newVersion;
-    const appName = parsedFlags.appName ?? config.app.name;
-    const deployerLambdaName = parsedFlags.deployerLambdaName ?? config.deployer.lambdaName;
-    const semVer = parsedFlags.newVersion ?? config.app.semVer;
+    const appName = parsedFlags.appName ?? parsedFlags['app-name'] ?? config.app.name;
+    const deployerLambdaName =
+      parsedFlags.deployerLambdaName ??
+      parsedFlags['deployer-lambda-name'] ??
+      config.deployer.lambdaName;
+    const semVer = parsedFlags.newVersion ?? parsedFlags['new-version'] ?? config.app.semVer;
     const overwrite = parsedFlags.overwrite;
 
     // Override the config value
@@ -95,7 +115,7 @@ export class PreflightCommand extends Command {
             task.title = RUNNING + origTitle;
 
             // Confirm the Version Does Not Exist in Published State
-            task.output = `Checking if deployed app/version already exists for ${config.app.name}/${version}`;
+            task.output = `Checking if deployed app/version already exists for ${config.app.name}/${semVer}`;
             const preflightResult = await DeployClient.DeployVersionPreflight({
               config,
               needS3Creds: false,

package/src/commands/publish-static.ts

@@ -1,17 +1,21 @@
 import 'reflect-metadata';
 import * as s3 from '@aws-sdk/client-s3';
 import * as sts from '@aws-sdk/client-sts';
+import { Upload } from '@aws-sdk/lib-storage';
 import { Command, flags as flagsParser } from '@oclif/command';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pMap = require('p-map');
 import * as path from 'path';
 import { pathExists, createReadStream } from 'fs-extra';
 import { Listr, ListrTask } from 'listr2';
-import { createVersions, IVersions } from '../lib/Versions';
-import { Config } from '../config/Config';
-import DeployClient, { IDeployVersionPreflightResult } from '../lib/DeployClient';
-import S3Uploader from '../lib/S3Uploader';
-import S3TransferUtility from '../lib/S3TransferUtility';
-import { Upload } from '@aws-sdk/lib-storage';
 import { contentType } from 'mime-types';
+import { Config } from '../config/Config';
+import DeployClient, {
+  DeployVersionArgs,
+  IDeployVersionPreflightResult,
+} from '../lib/DeployClient';
+import { S3Uploader } from '../lib/S3Uploader';
+import { S3TransferUtility } from '../lib/S3TransferUtility';
 
 interface IContext {
   preflightResult: IDeployVersionPreflightResult;
@@ -38,32 +42,64 @@ export class PublishCommand extends Command {
       char: 'v',
     }),
     help: flagsParser.help(),
+    // Deprecated
     deployerLambdaName: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'deployer-lambda-name': flagsParser.string({
       char: 'd',
       multiple: false,
-      required: true,
+      exactlyOne: ['deployer-lambda-name', 'deployerLambdaName'],
       description: 'Name of the deployer lambda function',
     }),
+    // Deprecated
     newVersion: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'new-version': flagsParser.string({
       char: 'n',
       multiple: false,
-      required: true,
+      exactlyOne: ['new-version', 'newVersion'],
       description: 'New semantic version to apply',
     }),
+    // Deprecated
     appName: flagsParser.string({
-      char: 'a',
       multiple: false,
       required: false,
-      description: 'MicroApps app name',
+      hidden: true,
     }),
+    'app-name': flagsParser.string({
+      char: 'a',
+      multiple: false,
+      exactlyOne: ['app-name', 'appName'],
+      description: 'MicroApps app name (this becomes the path the app is rooted at)',
+    }),
+    // Deprecated
     staticAssetsPath: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+    }),
+    'static-assets-path': flagsParser.string({
       char: 's',
       multiple: false,
       required: false,
+      exactlyOne: ['static-assets-path', 'staticAssetsPath'],
       description:
         'Path to files to be uploaded to S3 static bucket at app/version/ path.  Do include app/version/ in path if files are already "rooted" under that path locally.',
     }),
+    // Deprecated
     defaultFile: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+      exclusive: ['default-file'],
+    }),
+    'default-file': flagsParser.string({
       char: 'i',
       multiple: false,
       required: false,
@@ -77,15 +113,19 @@ export class PublishCommand extends Command {
       description:
         'Allow overwrite - Warn but do not fail if version exists. Discouraged outside of test envs if cacheable static files have changed.',
     }),
+    // Deprecated
     noCache: flagsParser.boolean({
+      required: false,
+      default: false,
+      hidden: true,
+    }),
+    'no-cache': flagsParser.boolean({
       required: false,
       default: false,
       description: 'Force revalidation of CloudFront and browser caching of static assets',
     }),
   };
 
-  private VersionAndAlias: IVersions;
-
   async run(): Promise<void> {
     const config = Config.instance;
 
@@ -94,13 +134,20 @@ export class PublishCommand extends Command {
     const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(PublishCommand);
-    const appName = parsedFlags.appName ?? config.app.name;
-    const deployerLambdaName = parsedFlags.deployerLambdaName ?? config.deployer.lambdaName;
-    const semVer = parsedFlags.newVersion ?? config.app.semVer;
-    const staticAssetsPath = parsedFlags.staticAssetsPath ?? config.app.staticAssetsPath;
-    const defaultFile = parsedFlags.defaultFile ?? config.app.defaultFile;
+    const appName = parsedFlags.appName ?? parsedFlags['app-name'] ?? config.app.name;
+    const deployerLambdaName =
+      parsedFlags.deployerLambdaName ??
+      parsedFlags['deployer-lambda-name'] ??
+      config.deployer.lambdaName;
+    const semVer = parsedFlags.newVersion ?? parsedFlags['new-version'] ?? config.app.semVer;
+    const staticAssetsPath =
+      parsedFlags.staticAssetsPath ??
+      parsedFlags['static-assets-path'] ??
+      config.app.staticAssetsPath;
+    const defaultFile =
+      parsedFlags.defaultFile ?? parsedFlags['default-file'] ?? config.app.defaultFile;
     const overwrite = parsedFlags.overwrite;
-    const noCache = parsedFlags.noCache;
+    const noCache = parsedFlags.noCache ?? parsedFlags['no-cache'];
 
     // Override the config value
     config.deployer.lambdaName = deployerLambdaName;
@@ -125,8 +172,6 @@ export class PublishCommand extends Command {
       }
     }
 
-    this.VersionAndAlias = createVersions(semVer);
-
     if (config.app.staticAssetsPath === undefined) {
       this.error('staticAssetsPath must be specified');
     }
@@ -198,11 +243,11 @@ export class PublishCommand extends Command {
         {
           // TODO: Disable this task if no static assets path
           title: 'Enumerate Files to Upload to S3',
-          task: async (ctx, task) => {
+          task: (ctx, task) => {
             const origTitle = task.title;
             task.title = RUNNING + origTitle;
 
-            ctx.files = (await S3TransferUtility.GetFiles(S3Uploader.TempDir)) as string[];
+            ctx.files = S3TransferUtility.GetFiles(S3Uploader.TempDir);
 
             task.title = origTitle;
           },
@@ -210,7 +255,7 @@ export class PublishCommand extends Command {
         {
           // TODO: Disable this task if no static assets path
           title: 'Upload Static Files to S3',
-          task: (ctx, task) => {
+          task: async (ctx, task) => {
             const origTitle = task.title;
             task.title = RUNNING + origTitle;
 
@@ -230,50 +275,87 @@ export class PublishCommand extends Command {
 
             // Setup caching on static assets
             // NoCache - Only used for test deploys, requires browser and CloudFront to refetch every time
-            // Overwrite - Reduces default cache time period from 24 hours to 15 minutes
             // Default - 24 hours
             const CacheControl = noCache
               ? 'max-age=0, must-revalidate, public'
-              : overwrite
-              ? `max-age=${15 * 60}, public`
               : `max-age=${24 * 60 * 60}, public`;
 
             const pathWithoutAppAndVer = path.join(S3Uploader.TempDir, destinationPrefix);
-
-            const tasks: ListrTask<IContext>[] = ctx.files.map((filePath) => ({
-              task: async (ctx: IContext, subtask) => {
-                const relFilePath = path.relative(pathWithoutAppAndVer, filePath);
-
-                const origTitle = relFilePath;
-                subtask.title = RUNNING + origTitle;
-
-                const upload = new Upload({
-                  client: s3Client,
-                  leavePartsOnError: false,
-                  params: {
-                    Bucket: bucketName,
-                    Key: path.relative(S3Uploader.TempDir, filePath),
-                    Body: createReadStream(filePath),
-                    ContentType: contentType(path.basename(filePath)) || 'application/octet-stream',
-                    CacheControl,
-                  },
-                });
-                await upload.done();
-
-                subtask.title = origTitle;
-              },
-            }));
-
-            task.title = origTitle;
-
-            return task.newListr(tasks, {
-              concurrent: 8,
-              rendererOptions: {
-                clearOutput: false,
-                showErrorMessage: true,
-                showTimer: true,
-              },
-            });
+            // Listr causes OOM if passes a list of, say, 5,000 to 20,000 files
+            if (ctx.files.length > 200) {
+              const fileCountMsgInterval = Math.floor(ctx.files.length / 10);
+              let filesPublished = 0;
+
+              await pMap(
+                ctx.files,
+                async (filePath: string) => {
+                  // Can't use tasks for each file
+                  const relFilePath = path.relative(pathWithoutAppAndVer, filePath);
+
+                  if (
+                    ctx.files.length > 1000 &&
+                    (filesPublished % fileCountMsgInterval === 0 ||
+                      filesPublished === ctx.files.length)
+                  ) {
+                    task.output = `Uploaded ${filesPublished} of ${ctx.files.length} files`;
+                  } else if (ctx.files.length <= 1000) {
+                    task.output = `Uploading ${relFilePath}`;
+                  }
+
+                  const upload = new Upload({
+                    client: s3Client,
+                    leavePartsOnError: false,
+                    params: {
+                      Bucket: bucketName,
+                      Key: path.relative(S3Uploader.TempDir, filePath),
+                      Body: createReadStream(filePath),
+                      ContentType:
+                        contentType(path.basename(filePath)) || 'application/octet-stream',
+                      CacheControl,
+                    },
+                  });
+                  await upload.done();
+                  filesPublished++;
+                },
+                { concurrency: 40 },
+              );
+            } else {
+              const tasks: ListrTask<IContext>[] = ctx.files.map((filePath) => ({
+                task: async (ctx: IContext, subtask) => {
+                  const relFilePath = path.relative(pathWithoutAppAndVer, filePath);
+
+                  const origTitle = relFilePath;
+                  subtask.title = RUNNING + origTitle;
+
+                  const upload = new Upload({
+                    client: s3Client,
+                    leavePartsOnError: false,
+                    params: {
+                      Bucket: bucketName,
+                      Key: path.relative(S3Uploader.TempDir, filePath),
+                      Body: createReadStream(filePath),
+                      ContentType:
+                        contentType(path.basename(filePath)) || 'application/octet-stream',
+                      CacheControl,
+                    },
+                  });
+                  await upload.done();
+
+                  subtask.title = origTitle;
+                },
+              }));
+
+              task.title = origTitle;
+
+              return task.newListr(tasks, {
+                concurrent: 8,
+                rendererOptions: {
+                  clearOutput: false,
+                  showErrorMessage: true,
+                  showTimer: true,
+                },
+              });
+            }
           },
         },
         {
@@ -294,8 +376,7 @@ export class PublishCommand extends Command {
             const origTitle = task.title;
             task.title = RUNNING + origTitle;
 
-            // Call Deployer to Deploy AppName/Version
-            await DeployClient.DeployVersion({
+            const request: DeployVersionArgs = {
               appName: config.app.name,
               semVer: config.app.semVer,
               deployerLambdaName: config.deployer.lambdaName,
@@ -303,7 +384,17 @@ export class PublishCommand extends Command {
               appType: 'static',
               overwrite,
               output: (message: string) => (task.output = message),
-            });
+            };
+
+            // Use DeployVersionLite if createAlias is supported
+            if (ctx.preflightResult.response.capabilities?.['createAlias'] === 'true') {
+              task.output = 'Using DeployVersionLite';
+              await DeployClient.DeployVersionLite(request);
+            } else {
+              // Use legacy DeployVersion if createAlias is not supported
+              task.output = 'Using DeployVersion';
+              await DeployClient.DeployVersion(request);
+            }
 
             task.title = origTitle;
           },