@pwrdrvr/microapps-publish 0.4.0-alpha.2 → 0.4.0-alpha.4

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,19 +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 { contentType } from 'mime-types';
 import { Config } from '../config/Config';
-import DeployClient, { IDeployVersionPreflightResult } from '../lib/DeployClient';
+import DeployClient, {
+  DeployVersionArgs,
+  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';
 
 interface IContext {
   preflightResult: IDeployVersionPreflightResult;
@@ -40,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,
@@ -79,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;
 
@@ -96,11 +134,18 @@ 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;
 
@@ -127,8 +172,6 @@ export class PublishCommand extends Command {
       }
     }
 
-    this.VersionAndAlias = createVersions(semVer);
-
     if (config.app.staticAssetsPath === undefined) {
       this.error('staticAssetsPath must be specified');
     }
@@ -232,12 +275,9 @@ 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);
@@ -336,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,
@@ -345,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;
           },

package/src/commands/publish.ts

@@ -11,7 +11,10 @@ import { pathExists, createReadStream } from 'fs-extra';
 import { Listr, ListrTask } from 'listr2';
 import { createVersions, IVersions } from '../lib/Versions';
 import { Config, IConfig } from '../config/Config';
-import DeployClient, { IDeployVersionPreflightResult } from '../lib/DeployClient';
+import DeployClient, {
+  DeployVersionArgs,
+  IDeployVersionPreflightResult,
+} from '../lib/DeployClient';
 import { S3Uploader } from '../lib/S3Uploader';
 import { S3TransferUtility } from '../lib/S3TransferUtility';
 import { Upload } from '@aws-sdk/lib-storage';
@@ -24,8 +27,6 @@ const lambdaClient = new lambda.LambdaClient({
   maxAttempts: 8,
 });
 
-type DeployVersionArgs = Parameters<typeof DeployClient.DeployVersionLite>[0];
-
 interface IContext {
   preflightResult: IDeployVersionPreflightResult;
   files: string[];
@@ -68,38 +69,78 @@ 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
     appLambdaName: flagsParser.string({
+      multiple: false,
+      required: false,
+      hidden: true,
+      exclusive: ['app-lambda-name'],
+    }),
+    'app-lambda-name': flagsParser.string({
       char: 'l',
       multiple: false,
       required: false,
       description: 'ARN of lambda version, alias, or function (name or ARN) to deploy',
     }),
+    // Deprecated
     appName: flagsParser.string({
-      char: 'a',
       multiple: false,
       required: false,
+      hidden: true,
+      exclusive: ['app-name'],
+    }),
+    '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,
+      exclusive: ['static-assets-path'],
+    }),
+    'static-assets-path': flagsParser.string({
       char: 's',
       multiple: false,
       required: false,
       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,
@@ -113,7 +154,13 @@ 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',
@@ -151,14 +198,22 @@ export class PublishCommand extends Command {
     const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(PublishCommand);
-    const appLambdaName = parsedFlags.appLambdaName ?? config.app.lambdaName;
-    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 appLambdaName =
+      parsedFlags.appLambdaName ?? parsedFlags['app-lambda-name'] ?? config.app.lambdaName;
+    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;
@@ -365,12 +420,9 @@ 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);

package/src/lib/DeployClient.ts

@@ -19,7 +19,7 @@ export interface IDeployVersionPreflightResult {
   response: IDeployVersionPreflightResponse;
 }
 
-export type DeployVersionArgs = Parameters<typeof DeployClient.DeployVersionLite>;
+export type DeployVersionArgs = Parameters<typeof DeployClient.DeployVersionLite>[0];
 
 export default class DeployClient {
   static readonly _client = new lambda.LambdaClient({