@pwrdrvr/microapps-publish 0.0.17 → 0.0.21

package/src/index.ts

@@ -1,454 +1 @@
-#!/usr/bin/env node
-/* eslint-disable no-console */
-
-import 'source-map-support/register';
-// Used by ts-convict
-import 'reflect-metadata';
-import { exec } from 'child_process';
-import * as util from 'util';
-import * as lambda from '@aws-sdk/client-lambda';
-import * as sts from '@aws-sdk/client-sts';
-import { Command, flags as flagsParser } from '@oclif/command';
-import { IConfig as OCLIFIConfig } from '@oclif/config';
-import { handle as errorHandler } from '@oclif/errors';
-import chalk from 'chalk';
-import { promises as fs, pathExists } from 'fs-extra';
-import { Listr, ListrErrorTypes, ListrTask, ListrTaskObject } from 'listr2';
-import { Config, IConfig } from './config/Config';
-import DeployClient, { IDeployVersionPreflightResult } from './DeployClient';
-import S3Uploader from './S3Uploader';
-const asyncSetTimeout = util.promisify(setTimeout);
-const asyncExec = util.promisify(exec);
-
-const RUNNING_TEXT = ' RUNS ';
-const RUNNING = chalk.reset.inverse.yellow.bold(RUNNING_TEXT) + ' ';
-
-const lambdaClient = new lambda.LambdaClient({
-  maxAttempts: 8,
-});
-
-interface IVersions {
-  version: string;
-  alias?: string;
-}
-
-interface IContext {
-  preflightResult: IDeployVersionPreflightResult;
-}
-
-class PublishTool extends Command {
-  static flags = {
-    version: flagsParser.version({
-      char: 'v',
-    }),
-    help: flagsParser.help(),
-    deployerLambdaName: flagsParser.string({
-      char: 'd',
-      multiple: false,
-      required: true,
-      description: 'Name of the deployer lambda function',
-    }),
-    newVersion: flagsParser.string({
-      char: 'n',
-      multiple: false,
-      required: true,
-      description: 'New semantic version to apply',
-    }),
-    repoName: flagsParser.string({
-      char: 'r',
-      multiple: false,
-      required: true,
-      description: 'Name (not URI) of the Docker repo for the app',
-    }),
-    leaveCopy: flagsParser.boolean({
-      char: 'l',
-      default: false,
-      required: false,
-      description: 'Leave a copy of the modifed files as .modified',
-    }),
-  };
-
-  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
-  private static escapeRegExp(value: string): string {
-    return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
-  }
-
-  private VersionAndAlias: IVersions;
-  private IMAGE_TAG = '';
-  private IMAGE_URI = '';
-  private FILES_TO_MODIFY: {
-    path: string;
-    versions: IVersions;
-  }[];
-  private _restoreFilesStarted = false;
-
-  constructor(argv: string[], config: OCLIFIConfig) {
-    super(argv, config);
-    this.restoreFiles = this.restoreFiles.bind(this);
-  }
-
-  async run(): Promise<void> {
-    const { flags: parsedFlags } = this.parse(PublishTool);
-    const version = parsedFlags.newVersion;
-    const leaveFiles = parsedFlags.leaveCopy;
-    const lambdaName = parsedFlags.deployerLambdaName;
-    const ecrRepo = parsedFlags.repoName;
-
-    // Override the config value
-    const config = Config.instance;
-    config.deployer.lambdaName = lambdaName;
-    config.app.semVer = version;
-
-    // Get the account ID and region from STS
-    // TODO: Move this to the right place
-    if (config.app.awsAccountID === 0 || config.app.awsRegion === '') {
-      const stsClient = new sts.STSClient({
-        maxAttempts: 8,
-      });
-      const stsResponse = await stsClient.send(new sts.GetCallerIdentityCommand({}));
-      if (config.app.awsAccountID === 0) {
-        config.app.awsAccountID = parseInt(stsResponse.Account, 10);
-      }
-      if (config.app.awsRegion === '') {
-        config.app.awsRegion = stsClient.config.region as string;
-      }
-    }
-    if (config.app.ecrHost === '') {
-      config.app.ecrHost = `${config.app.awsAccountID}.dkr.ecr.${config.app.awsRegion}.amazonaws.com`;
-    }
-    if (ecrRepo) {
-      config.app.ecrRepoName = ecrRepo;
-    } else if (config.app.ecrRepoName === '') {
-      config.app.ecrRepoName = `microapps-app-${config.app.name}${Config.envLevel}-repo`;
-    }
-
-    this.VersionAndAlias = this.createVersions(version);
-    const versionOnly = { version: this.VersionAndAlias.version };
-
-    this.FILES_TO_MODIFY = [
-      { path: 'package.json', versions: versionOnly },
-      // { path: 'deploy.json', versions: this.VersionAndAlias },
-      { path: 'next.config.js', versions: versionOnly },
-    ] as { path: string; versions: IVersions }[];
-
-    // Install handler to ensure that we restore files
-    process.on('SIGINT', async () => {
-      if (this._restoreFilesStarted) {
-        return;
-      } else {
-        this._restoreFilesStarted = true;
-      }
-      console.log('Caught Ctrl-C, restoring files');
-      await S3Uploader.removeTempDirIfExists();
-      await this.restoreFiles();
-    });
-
-    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');
-    }
-
-    //
-    // TODO: Setup Tasks
-    //
-
-    const tasks = new Listr<IContext>([
-      {
-        title: 'Logging into ECR',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          await this.loginToECR(config);
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Modifying Config Files',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Modify the existing files with the new version
-          for (const fileToModify of this.FILES_TO_MODIFY) {
-            task.output = `Patching version (${this.VersionAndAlias.version}) into ${fileToModify.path}`;
-            if (
-              !(await this.writeNewVersions(fileToModify.path, fileToModify.versions, leaveFiles))
-            ) {
-              task.output = `Failed modifying file: ${fileToModify.path}`;
-            }
-          }
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Preflight Version Check',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          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}`;
-          ctx.preflightResult = await DeployClient.DeployVersionPreflight(config);
-          if (ctx.preflightResult.exists) {
-            task.output = `Warning: App/Version already exists: ${config.app.name}/${config.app.semVer}`;
-          }
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Serverless Next.js Build',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          task.output = `Invoking serverless next.js build for ${config.app.name}/${version}`;
-
-          // Run the serverless next.js build
-          await asyncExec('serverless');
-
-          if (config.app.serverlessNextRouterPath !== undefined) {
-            task.output = 'Copying Serverless Next.js router to build output directory';
-            await fs.copyFile(config.app.serverlessNextRouterPath, './.serverless_nextjs/index.js');
-          }
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Publish to ECR',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Docker, build, tag, push to ECR
-          // Note: Need to already have AWS env vars set
-          await this.publishToECR(config);
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Deploy to Lambda',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Update the Lambda function
-          await this.deployToLambda(config, this.VersionAndAlias);
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Confirm Static Assets Folder Exists',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Check that Static Assets Folder exists
-          if (!(await pathExists(config.app.staticAssetsPath))) {
-            this.error(`Static asset path does not exist: ${config.app.staticAssetsPath}`);
-          }
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: 'Upload Files to S3 Staging AppName/Version Prefix',
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Upload Files to S3 Staging AppName/Version Prefix
-          await S3Uploader.Upload(
-            config,
-            ctx.preflightResult.response.s3UploadUrl,
-            ctx.preflightResult.response,
-          );
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: `Creating MicroApp Application: ${config.app.name}`,
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Call Deployer to Create App if Not Exists
-          await DeployClient.CreateApp(config);
-
-          task.title = origTitle;
-        },
-      },
-      {
-        title: `Creating MicroApp Version: ${config.app.semVer}`,
-        task: async (ctx, task) => {
-          const origTitle = task.title;
-          task.title = RUNNING + origTitle;
-
-          // Call Deployer to Deploy AppName/Version
-          await DeployClient.DeployVersion(config);
-
-          task.title = origTitle;
-        },
-      },
-    ]);
-
-    try {
-      await tasks.run();
-      console.log(`Published: ${config.app.name}/${config.app.semVer}`);
-    } catch (error) {
-      console.log(`Caught exception: ${error.message}`);
-    } finally {
-      await this.restoreFiles();
-    }
-  }
-
-  public async restoreFiles(): Promise<void> {
-    // Put the old files back when succeeded or failed
-    for (const fileToModify of this.FILES_TO_MODIFY) {
-      try {
-        const stats = await fs.stat(`${fileToModify.path}.original`);
-        if (stats.isFile()) {
-          // Remove the possibly modified file
-          await fs.unlink(fileToModify.path);
-
-          // Move the original file back
-          await fs.rename(`${fileToModify.path}.original`, fileToModify.path);
-        }
-      } catch {
-        // don't care... if the file doesn't exist we can't do anything
-      }
-    }
-  }
-
-  private createVersions(version: string): IVersions {
-    return { version, alias: `v${version.replace(/\./g, '_')}` };
-  }
-
-  private async writeNewVersions(
-    path: string,
-    requiredVersions: IVersions,
-    leaveFiles: boolean,
-  ): Promise<boolean> {
-    const stats = await fs.stat(path);
-    if (!stats.isFile) {
-      return false;
-    }
-
-    // Make a backup of the file
-    await fs.copyFile(path, `${path}.original`);
-
-    // File exists, check that it has the required version strings
-    let fileText = await fs.readFile(path, 'utf8');
-
-    for (const key of Object.keys(requiredVersions)) {
-      const placeHolder = key === 'version' ? '0.0.0' : 'v0_0_0';
-      if (fileText.indexOf(placeHolder) === -1) {
-        // The required placeholder is missing
-        return false;
-      } else {
-        const regExp = new RegExp(PublishTool.escapeRegExp(placeHolder), 'g');
-        fileText = fileText.replace(
-          regExp,
-          key === 'version' ? requiredVersions.version : (requiredVersions.alias as string),
-        );
-      }
-    }
-
-    // Write the updated file contents
-    await fs.writeFile(path, fileText, 'utf8');
-
-    // Leave a copy of the modified file if requested
-    if (leaveFiles) {
-      // This copy will overwrite an existing file
-      await fs.copyFile(path, `${path}.modified`);
-    }
-
-    return true;
-  }
-
-  private async loginToECR(config: IConfig): Promise<boolean> {
-    this.IMAGE_TAG = `${config.app.ecrRepoName}:${this.VersionAndAlias.version}`;
-    this.IMAGE_URI = `${config.app.ecrHost}/${this.IMAGE_TAG}`;
-
-    try {
-      await asyncExec(
-        `aws ecr get-login-password --region ${config.app.awsRegion} | docker login --username AWS --password-stdin ${config.app.ecrHost}`,
-      );
-    } catch (error) {
-      throw new Error(`ECR Login Failed: ${error.message}`);
-    }
-
-    return true;
-  }
-
-  private async publishToECR(config: IConfig): Promise<void> {
-    console.log('Starting Docker build');
-    await asyncExec(`docker build -f Dockerfile -t ${this.IMAGE_TAG}  .`);
-    await asyncExec(`docker tag ${this.IMAGE_TAG} ${config.app.ecrHost}/${this.IMAGE_TAG}`);
-    console.log('Starting Docker push to ECR');
-    await asyncExec(`docker push ${config.app.ecrHost}/${this.IMAGE_TAG}`);
-  }
-
-  private async deployToLambda(config: IConfig, versions: IVersions): Promise<void> {
-    // Create Lambda version
-    console.log('Updating Lambda code to point to new Docker image');
-    const resultUpdate = await lambdaClient.send(
-      new lambda.UpdateFunctionCodeCommand({
-        FunctionName: config.app.lambdaName,
-        ImageUri: this.IMAGE_URI,
-        Publish: true,
-      }),
-    );
-    const lambdaVersion = resultUpdate.Version;
-    console.log('Lambda version created: ', resultUpdate.Version);
-
-    let lastUpdateStatus = resultUpdate.LastUpdateStatus;
-    for (let i = 0; i < 5; i++) {
-      // When the function is created the status will be "Pending"
-      // and we have to wait until it's done creating
-      // before we can point an alias to it
-      if (lastUpdateStatus === 'Successful') {
-        console.log(`Lambda function updated, version: ${lambdaVersion}`);
-        break;
-      }
-
-      // If it didn't work, wait and try again
-      await asyncSetTimeout(1000 * i);
-
-      const resultGet = await lambdaClient.send(
-        new lambda.GetFunctionCommand({
-          FunctionName: config.app.lambdaName,
-          Qualifier: lambdaVersion,
-        }),
-      );
-
-      // Save the last update status so we can check on re-loop
-      lastUpdateStatus = resultGet?.Configuration?.LastUpdateStatus;
-    }
-
-    // Create Lambda alias point
-    console.log(`Creating the lambda alias for the new version: ${lambdaVersion}`);
-    const resultLambdaAlias = await lambdaClient.send(
-      new lambda.CreateAliasCommand({
-        FunctionName: config.app.lambdaName,
-        Name: versions.alias,
-        FunctionVersion: lambdaVersion,
-      }),
-    );
-    console.log(`Lambda alias created, name: ${resultLambdaAlias.Name}`);
-  }
-}
-
-// @ts-expect-error catch is actually defined
-PublishTool.run().catch(errorHandler);
-
-export default PublishTool;
+export { run } from '@oclif/command';

package/src/{DeployClient.ts → lib/DeployClient.ts}

@@ -1,14 +1,12 @@
 import * as lambda from '@aws-sdk/client-lambda';
-
-// eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
 import {
   IDeployVersionPreflightRequest,
   IDeployVersionPreflightResponse,
   ICreateApplicationRequest,
   IDeployerResponse,
   IDeployVersionRequest,
-} from '@pwrdrvr/microapps-deployer';
-import { IConfig } from './config/Config';
+} from '@pwrdrvr/microapps-deployer-lib';
+import { IConfig } from '../config/Config';
 
 export interface IDeployVersionPreflightResult {
   exists: boolean;
@@ -46,13 +44,25 @@ export default class DeployClient {
     }
   }
 
-  public static async DeployVersionPreflight(
-    config: IConfig,
-  ): Promise<IDeployVersionPreflightResult> {
+  /**
+   * Check if version exists.
+   * Optionally get S3 creds for static asset upload.
+   * @param config
+   * @param output
+   * @returns
+   */
+  public static async DeployVersionPreflight(opts: {
+    config: IConfig;
+    needS3Creds?: boolean;
+    output: (message: string) => void;
+  }): Promise<IDeployVersionPreflightResult> {
+    const { config, needS3Creds = true, output } = opts;
+
     const request = {
       type: 'deployVersionPreflight',
       appName: config.app.name,
       semVer: config.app.semVer,
+      needS3Creds,
     } as IDeployVersionPreflightRequest;
     const response = await this._client.send(
       new lambda.InvokeCommand({
@@ -66,9 +76,10 @@ export default class DeployClient {
         Buffer.from(response.Payload).toString('utf-8'),
       ) as IDeployVersionPreflightResponse;
       if (dResponse.statusCode === 404) {
-        console.log(`App/Version do not exist: ${config.app.name}/${config.app.semVer}`);
+        output(`App/Version does not exist: ${config.app.name}/${config.app.semVer}`);
         return { exists: false, response: dResponse };
       } else {
+        output(`App/Version exists: ${config.app.name}/${config.app.semVer}`);
         return { exists: true, response: dResponse };
       }
     } else {
@@ -76,7 +87,18 @@ export default class DeployClient {
     }
   }
 
-  public static async DeployVersion(config: IConfig): Promise<void> {
+  /**
+   * Copy S3 static assets from staging to live bucket.
+   * Create API Gateway Integration for app (if needed).
+   * Give API Gateway permission to call the Lambda.
+   * Create API Gateway routes for this specific version.
+   * @param config
+   * @param task
+   */
+  public static async DeployVersion(
+    config: IConfig,
+    output: (message: string) => void,
+  ): Promise<void> {
     const request = {
       type: 'deployVersion',
       appName: config.app.name,
@@ -96,9 +118,10 @@ export default class DeployClient {
         Buffer.from(response.Payload).toString('utf-8'),
       ) as IDeployerResponse;
       if (dResponse.statusCode === 201) {
-        console.log(`Deploy succeeded: ${config.app.name}/${config.app.semVer}`);
+        output(`Deploy succeeded: ${config.app.name}/${config.app.semVer}`);
       } else {
-        console.log(`Deploy failed with: ${dResponse.statusCode}`);
+        output(`Deploy failed with: ${dResponse.statusCode}`);
+        throw new Error(`Lambda call to DeployVersionfailed with: ${dResponse.statusCode}`);
       }
     } else {
       throw new Error(`Lambda call to DeployVersion failed: ${JSON.stringify(response)}`);

package/src/{S3TransferUtility.ts → lib/S3TransferUtility.ts}

@@ -6,12 +6,19 @@ import { promises as fs, createReadStream } from 'fs';
 import * as path from 'path';
 import * as s3 from '@aws-sdk/client-s3';
 import { Upload } from '@aws-sdk/lib-storage';
-// eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
-import { IDeployVersionPreflightResponse } from '@pwrdrvr/microapps-deployer';
+import { IDeployVersionPreflightResponse } from '@pwrdrvr/microapps-deployer-lib';
 import { contentType } from 'mime-types';
 import pMap from 'p-map';
 
 export default class S3TransferUtility {
+  /**
+   * @deprecated 2021-11-27
+   *
+   * @param s3Path
+   * @param destPrefixPath
+   * @param bucketName
+   * @param preflightResponse
+   */
   public static async UploadDir(
     s3Path: string,
     destPrefixPath: string,
@@ -70,7 +77,12 @@ export default class S3TransferUtility {
   // Recursive getFiles from
   // https://stackoverflow.com/a/45130990/831465
 
-  private static async GetFiles(dir: string): Promise<string | string[]> {
+  /**
+   * Resursively enumerate the files to be uploaded
+   * @param dir
+   * @returns
+   */
+  public static async GetFiles(dir: string): Promise<string | string[]> {
     const dirents = await fs.readdir(dir, { withFileTypes: true });
     const files = await Promise.all(
       dirents.map((dirent) => {

package/src/{S3Uploader.ts → lib/S3Uploader.ts}

@@ -1,23 +1,55 @@
-import path from 'path';
-// eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
-import { IDeployVersionPreflightResponse } from '@pwrdrvr/microapps-deployer';
-import fs from 'fs-extra';
-import { IConfig } from './config/Config';
+import * as path from 'path';
+import { IDeployVersionPreflightResponse } from '@pwrdrvr/microapps-deployer-lib';
+import * as fs from 'fs-extra';
+import { IConfig } from '../config/Config';
 import S3TransferUtility from './S3TransferUtility';
 
 export default class S3Uploader {
+  /**
+   * Copy files to local upload directory
+   * @param config
+   * @param s3UploadPath
+   * @param preflightResponse
+   */
+  public static async CopyToUploadDir(config: IConfig, s3UploadPath: string): Promise<void> {
+    const { destinationPrefix } = S3Uploader.ParseUploadPath(s3UploadPath);
+
+    // Make a local root dir for the upload
+    const tempUploadPath = path.join(S3Uploader._tempDir, destinationPrefix);
+    await S3Uploader.removeTempDirIfExists();
+    await fs.mkdir(tempUploadPath, { recursive: true });
+
+    // Copy the files in the source dir to the root dir
+    // Note: It would be faster to move the files, then move them back
+    await fs.copy(config.app.staticAssetsPath, tempUploadPath);
+  }
+
+  public static ParseUploadPath(s3UploadPath: string): {
+    bucketName: string;
+    destinationPrefix: string;
+  } {
+    // Parse the S3 Source URI
+    const uri = new URL(s3UploadPath);
+    const bucketName = uri.host;
+    const destinationPrefix = uri.pathname.length >= 1 ? uri.pathname.slice(1) : '';
+
+    return { bucketName, destinationPrefix };
+  }
+
+  /**
+   * Upload files to S3
+   * @deprecated 2021-11-27
+   * @param config
+   * @param s3UploadPath
+   * @param preflightResponse
+   */
   public static async Upload(
     config: IConfig,
     s3UploadPath: string,
     preflightResponse: IDeployVersionPreflightResponse,
   ): Promise<void> {
     try {
-      //const destinationPrefix = `${config.app.name}/${config.app.semVer}`;
-
-      // Parse the S3 Source URI
-      const uri = new URL(s3UploadPath);
-      const bucketName = uri.host;
-      const destinationPrefix = uri.pathname.length >= 1 ? uri.pathname.slice(1) : '';
+      const { destinationPrefix, bucketName } = S3Uploader.ParseUploadPath(s3UploadPath);
 
       // Make a local root dir for the upload
       const tempUploadPath = path.join(S3Uploader._tempDir, destinationPrefix);
@@ -56,4 +88,7 @@ export default class S3Uploader {
   }
 
   private static readonly _tempDir = './deploytool-temp';
+  public static get TempDir(): string {
+    return S3Uploader._tempDir;
+  }
 }