@pwrdrvr/microapps-publish 0.0.21 → 0.0.25

package/src/commands/nextjs-docker-auto.ts

@@ -5,7 +5,6 @@ import * as lambda from '@aws-sdk/client-lambda';
 import * as s3 from '@aws-sdk/client-s3';
 import * as sts from '@aws-sdk/client-sts';
 import { Command, flags as flagsParser } from '@oclif/command';
-import * as chalk from 'chalk';
 import * as path from 'path';
 import { promises as fs, pathExists, createReadStream } from 'fs-extra';
 import { Listr, ListrTask } from 'listr2';
@@ -81,11 +80,49 @@ export class DockerAutoCommand extends Command {
       description: 'Name (not URI) of the Docker repo for the app',
     }),
     leaveCopy: flagsParser.boolean({
-      char: 'l',
+      char: 'f',
       default: false,
       required: false,
       description: 'Leave a copy of the modifed files as .modified',
     }),
+    appLambdaName: flagsParser.string({
+      char: 'l',
+      multiple: false,
+      required: false,
+      description: 'Name of the application lambda function',
+    }),
+    appName: flagsParser.string({
+      char: 'a',
+      multiple: false,
+      required: false,
+      description: 'MicroApps app name',
+    }),
+    staticAssetsPath: 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.',
+    }),
+    defaultFile: flagsParser.string({
+      char: 'i',
+      multiple: false,
+      required: false,
+      description:
+        'Default file to return when the app is loaded via the router without a version (e.g. when app/ is requested).',
+    }),
+    overwrite: flagsParser.boolean({
+      char: 'o',
+      required: false,
+      default: false,
+      description:
+        'Allow overwrite - Warn but do not fail if version exists. Discouraged outside of test envs if cacheable static files have changed.',
+    }),
+    noCache: flagsParser.boolean({
+      required: false,
+      default: false,
+      description: 'Force revalidation of CloudFront and browser caching of static assets',
+    }),
   };
 
   private VersionAndAlias: IVersions;
@@ -95,19 +132,31 @@ export class DockerAutoCommand extends Command {
   private _restoreFilesStarted = false;
 
   async run(): Promise<void> {
-    const RUNNING_TEXT = ' RUNS ';
-    const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+    const config = Config.instance;
+
+    // const RUNNING_TEXT = ' RUNS ';
+    // const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+    const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
 
     const { flags: parsedFlags } = this.parse(DockerAutoCommand);
-    const version = parsedFlags.newVersion;
+    const appLambdaName = parsedFlags.appLambdaName ?? config.app.lambdaName;
+    const appName = parsedFlags.appName ?? config.app.name;
     const leaveFiles = parsedFlags.leaveCopy;
-    const lambdaName = parsedFlags.deployerLambdaName;
-    const ecrRepo = parsedFlags.repoName;
+    const deployerLambdaName = parsedFlags.deployerLambdaName ?? config.deployer.lambdaName;
+    const semVer = parsedFlags.newVersion ?? config.app.semVer;
+    const ecrRepo = parsedFlags.repoName ?? config.app.ecrRepoName;
+    const staticAssetsPath = parsedFlags.staticAssetsPath ?? config.app.staticAssetsPath;
+    const defaultFile = parsedFlags.defaultFile ?? config.app.defaultFile;
+    const overwrite = parsedFlags.overwrite;
+    const noCache = parsedFlags.noCache;
 
     // Override the config value
-    const config = Config.instance;
-    config.deployer.lambdaName = lambdaName;
-    config.app.semVer = version;
+    config.deployer.lambdaName = deployerLambdaName;
+    config.app.lambdaName = appLambdaName;
+    config.app.name = appName;
+    config.app.semVer = semVer;
+    config.app.staticAssetsPath = staticAssetsPath;
+    config.app.defaultFile = defaultFile;
 
     // Get the account ID and region from STS
     // TODO: Move this to the right place
@@ -132,7 +181,7 @@ export class DockerAutoCommand extends Command {
       config.app.ecrRepoName = `microapps-app-${config.app.name}${Config.envLevel}-repo`;
     }
 
-    this.VersionAndAlias = createVersions(version);
+    this.VersionAndAlias = createVersions(semVer);
     const versionOnly = { version: this.VersionAndAlias.version };
 
     this.FILES_TO_MODIFY = [
@@ -153,11 +202,8 @@ export class DockerAutoCommand extends Command {
       await restoreFiles(this.FILES_TO_MODIFY);
     });
 
-    if (config === undefined) {
-      this.error('Failed to load the config file');
-    }
     if (config.app.staticAssetsPath === undefined) {
-      this.error('StaticAssetsPath must be specified in the config file');
+      this.error('staticAssetsPath must be specified');
     }
 
     //
@@ -201,16 +247,23 @@ export class DockerAutoCommand 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}`;
             ctx.preflightResult = await DeployClient.DeployVersionPreflight({
               config,
+              overwrite,
               output: (message: string) => (task.output = message),
             });
             if (ctx.preflightResult.exists) {
-              task.output = `Warning: App/Version already exists: ${config.app.name}/${config.app.semVer}`;
+              if (!overwrite) {
+                throw new Error(
+                  `App/Version already exists: ${config.app.name}/${config.app.semVer}`,
+                );
+              } else {
+                task.title = `Warning: App/Version already exists: ${config.app.name}/${config.app.semVer}`;
+              }
+            } else {
+              task.title = `App/Version does not exist: ${config.app.name}/${config.app.semVer}`;
             }
-
-            task.title = origTitle;
           },
         },
         {
@@ -219,7 +272,7 @@ export class DockerAutoCommand extends Command {
             const origTitle = task.title;
             task.title = RUNNING + origTitle;
 
-            task.output = `Invoking serverless next.js build for ${config.app.name}/${version}`;
+            task.output = `Invoking serverless next.js build for ${config.app.name}/${semVer}`;
 
             // Run the serverless next.js build
             await asyncExec('serverless');
@@ -317,6 +370,16 @@ export class DockerAutoCommand 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) => ({
@@ -334,7 +397,7 @@ export class DockerAutoCommand extends Command {
                     Key: path.relative(S3Uploader.TempDir, filePath),
                     Body: createReadStream(filePath),
                     ContentType: contentType(path.basename(filePath)) || 'application/octet-stream',
-                    CacheControl: 'max-age=86400; public',
+                    CacheControl,
                   },
                 });
                 await upload.done();
@@ -362,7 +425,7 @@ export class DockerAutoCommand extends Command {
             task.title = RUNNING + origTitle;
 
             // Call Deployer to Create App if Not Exists
-            await DeployClient.CreateApp(config);
+            await DeployClient.CreateApp({ config });
 
             task.title = origTitle;
           },
@@ -374,7 +437,12 @@ export class DockerAutoCommand extends Command {
             task.title = RUNNING + origTitle;
 
             // Call Deployer to Deploy AppName/Version
-            await DeployClient.DeployVersion(config, (message: string) => (task.output = message));
+            await DeployClient.DeployVersion({
+              config,
+              appType: 'lambda',
+              overwrite,
+              output: (message: string) => (task.output = message),
+            });
 
             task.title = origTitle;
           },
@@ -389,9 +457,6 @@ export class DockerAutoCommand extends Command {
 
     try {
       await tasks.run();
-      // this.log(`Published: ${config.app.name}/${config.app.semVer}`);
-    } catch (error) {
-      this.log(`Caught exception: ${error.message}`);
     } finally {
       await S3Uploader.removeTempDirIfExists();
       await restoreFiles(this.FILES_TO_MODIFY);

package/src/commands/nextjs-version-restore.ts

@@ -1,12 +1,8 @@
 import 'reflect-metadata';
 import { Command, flags as flagsParser } from '@oclif/command';
-import * as chalk from 'chalk';
 import { Listr } from 'listr2';
 import { createVersions, IVersions, restoreFiles } from '../lib/Versions';
 
-const RUNNING_TEXT = ' RUNS ';
-const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
-
 export class NextJSVersionRestoreCommand extends Command {
   static description = 'Restore next.config.js';
 
@@ -30,6 +26,10 @@ export class NextJSVersionRestoreCommand extends Command {
   }[];
 
   async run(): Promise<void> {
+    // const RUNNING_TEXT = ' RUNS ';
+    // const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+    const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+
     const { flags: parsedFlags } = this.parse(NextJSVersionRestoreCommand);
 
     this.VersionAndAlias = createVersions('0.0.0');
@@ -64,10 +64,6 @@ export class NextJSVersionRestoreCommand extends Command {
       },
     );
 
-    try {
-      await tasks.run();
-    } catch (error) {
-      this.log(`Caught exception: ${error.message}`);
-    }
+    await tasks.run();
   }
 }

package/src/commands/nextjs-version.ts

@@ -1,13 +1,9 @@
 import 'reflect-metadata';
 import { Command, flags as flagsParser } from '@oclif/command';
-import * as chalk from 'chalk';
 import { Listr } from 'listr2';
 import { Config } from '../config/Config';
 import { createVersions, IVersions, restoreFiles, writeNewVersions } from '../lib/Versions';
 
-const RUNNING_TEXT = ' RUNS ';
-const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
-
 export class NextJSVersionCommand extends Command {
   static description = 'Apply version to next.config.js overtop of 0.0.0 placeholder';
 
@@ -43,6 +39,10 @@ export class NextJSVersionCommand extends Command {
   }[];
 
   async run(): Promise<void> {
+    // const RUNNING_TEXT = ' RUNS ';
+    // const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+    const RUNNING = ''; //chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+
     const { flags: parsedFlags } = this.parse(NextJSVersionCommand);
     const version = parsedFlags.newVersion;
     const leaveFiles = parsedFlags.leaveCopy;
@@ -104,10 +104,6 @@ export class NextJSVersionCommand extends Command {
       },
     );
 
-    try {
-      await tasks.run();
-    } catch (error) {
-      this.log(`Caught exception: ${error.message}`);
-    }
+    await tasks.run();
   }
 }

package/src/commands/preflight.ts

@@ -1,14 +1,10 @@
 import 'reflect-metadata';
 import * as sts from '@aws-sdk/client-sts';
 import { Command, flags as flagsParser } from '@oclif/command';
-import * as chalk from 'chalk';
 import { Listr } from 'listr2';
 import { Config } from '../config/Config';
 import DeployClient from '../lib/DeployClient';
 
-const RUNNING_TEXT = ' RUNS ';
-const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
-
 export class PreflightCommand extends Command {
   static description = 'Check if app/version are available';
 
@@ -41,16 +37,28 @@ export class PreflightCommand extends Command {
       required: true,
       description: 'Name of the deployer lambda function',
     }),
+    overwrite: flagsParser.boolean({
+      char: 'o',
+      required: false,
+      default: false,
+      description:
+        'Allow overwrite - Warn but do not fail if version exists. Discouraged outside of test envs if cacheable static files have changed.',
+    }),
   };
 
   async run(): Promise<void> {
     const config = Config.instance;
 
+    // const RUNNING_TEXT = ' RUNS ';
+    // const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
+    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 overwrite = parsedFlags.overwrite;
 
     // Override the config value
     config.deployer.lambdaName = deployerLambdaName;
@@ -74,10 +82,6 @@ export class PreflightCommand extends Command {
       }
     }
 
-    if (config === undefined) {
-      this.error('Failed to load the config file');
-    }
-
     //
     // Setup Tasks
     //
@@ -95,13 +99,20 @@ export class PreflightCommand extends Command {
             const preflightResult = await DeployClient.DeployVersionPreflight({
               config,
               needS3Creds: false,
+              overwrite,
               output: (message: string) => (task.output = message),
             });
             if (preflightResult.exists) {
-              task.output = `Warning: App/Version already exists: ${config.app.name}/${config.app.semVer}`;
+              if (!overwrite) {
+                throw new Error(
+                  `App/Version already exists: ${config.app.name}/${config.app.semVer}`,
+                );
+              } else {
+                task.title = `Warning: App/Version already exists: ${config.app.name}/${config.app.semVer}`;
+              }
+            } else {
+              task.title = `App/Version does not exist: ${config.app.name}/${config.app.semVer}`;
             }
-
-            task.title = origTitle;
           },
         },
       ],
@@ -112,10 +123,6 @@ export class PreflightCommand extends Command {
       },
     );
 
-    try {
-      await tasks.run();
-    } catch (error) {
-      this.log(`Caught exception: ${error.message}`);
-    }
+    await tasks.run();
   }
 }