@optimizely/ocp-cli 1.0.0-beta.2

package/dist/test/setup.js

@@ -0,0 +1,4 @@
+"use strict";
+// silence expected console.error()
+jest.spyOn(global.console, 'error').mockImplementation(() => jest.fn());
+//# sourceMappingURL=setup.js.map

package/dist/test/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/test/setup.ts"],"names":[],"mappings":";AAAA,mCAAmC;AACnC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@optimizely/ocp-cli",
+  "version": "1.0.0-beta.2",
+  "description": "Optimizely Connect Platform command line interface",
+  "repository": "https://github.com/ZaiusInc/ocp-cli",
+  "license": "Apache-2.0",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
+  "author": "Optimizely, Inc.",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "bin": {
+    "ocp": "./bin/ocp.js"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "src/"
+  ],
+  "scripts": {
+    "build": "npx rimraf remove ./dist/ && npx tsc -p . && node ./node_modules/oo-cli/dist/build.js",
+    "build-watch": "npx rimraf remove ./dist/ && npx nodemon -e ts,json --watch src --exec 'tsc -p . && node ./node_modules/oo-cli/dist/build.js'",
+    "lint": "npx tslint --project .",
+    "test": "npx jest",
+    "release": "release-it"
+  },
+  "dependencies": {
+    "@zaiusinc/app-sdk": "^0.17.5",
+    "@zaiusinc/node-sdk": "^0.8.2",
+    "adm-zip": "^0.4.13",
+    "aws-sdk": "^2.479.0",
+    "chalk": "^2.4.2",
+    "cli-spinners": "^2.2.0",
+    "columnify": "^1.5.4",
+    "date-fns": "^2.29.3",
+    "deepmerge": "^4.0.0",
+    "dotenv": "^10.0.0",
+    "glob": "^7.1.4",
+    "js-yaml": "3.13.1",
+    "marked": "^0.7.0",
+    "marked-terminal": "^3.3.0",
+    "mustache": "^3.1.0",
+    "node-fetch": "^2.6.0",
+    "oo-cli": "0.2.1",
+    "parse-duration": "^0.4.4",
+    "semver": "^6.3.0",
+    "terminal-kit": ">=1.28.42 <1.44.0",
+    "text-table": "0.2.0",
+    "title-case": "^2.1.1",
+    "open": "^8.4.0"
+  },
+  "devDependencies": {
+    "@types/adm-zip": "^0.4.32",
+    "@types/aws-sdk": "^2.7.0",
+    "@types/chalk": "^2.2.0",
+    "@types/cli-spinners": "^1.3.0",
+    "@types/deepmerge": "^2.2.0",
+    "@types/glob": "^7.1.1",
+    "@types/google-protobuf": "^3.7.1",
+    "@types/jest": "^24.0.11",
+    "@types/js-yaml": "3.12.1",
+    "@types/marked": "^0.6.5",
+    "@types/marked-terminal": "^3.1.1",
+    "@types/mustache": "^0.8.32",
+    "@types/node": "^13.7.0",
+    "@types/node-fetch": "^2.5.0",
+    "@types/semver": "^6.0.1",
+    "@types/terminal-kit": "^1.28.0",
+    "@types/text-table": "0.2.0",
+    "@zaiusinc/tslint-presets": "^1.0.0",
+    "copy": "^0.3.2",
+    "jest": "^24.7.1",
+    "nodemon": "^1.18.11",
+    "release-it": "^15.10.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^24.0.2",
+    "tslint": "^5.16.0",
+    "typescript": "^3.7.5"
+  },
+  "resolutions": {
+    "@types/babel__traverse": "7.18.2",
+    "@types/marked": "^0.6.5"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

package/src/commands/accounts/Whoami.ts

@@ -0,0 +1,19 @@
+import {command, help, namespace} from 'oo-cli';
+import {die} from '../../lib/die';
+import {formatError} from '../../lib/formatError';
+import {Rivendell} from '../../lib/Rivendell';
+import chalk from 'chalk';
+
+@namespace('accounts')
+export class WhoamiCommand {
+  @command
+  @help('Show your account information')
+  public async whoami() {
+    try {
+      const me = await Rivendell.whoami();
+      console.log(chalk.gray(require('js-yaml').dump(me)));
+    } catch (e) {
+      die(formatError(e));
+    }
+  }
+}

package/src/commands/accounts/Whois.ts

@@ -0,0 +1,51 @@
+import {command, help, namespace, option, param} from 'oo-cli';
+import {die} from '../../lib/die';
+import {formatError} from '../../lib/formatError';
+import {Rivendell} from '../../lib/Rivendell';
+import Account = Rivendell.Account;
+import chalk from 'chalk';
+import * as table from 'text-table';
+import {styledStringLength} from '../../lib/StringUtils';
+
+@namespace('accounts')
+export class WhoisCommand {
+  @param
+  @help('The search term (e.g. 1.web)')
+  public term!: string;
+
+  @option('a')
+  @help('The availability zone that will be targeted (default: us)')
+  private availability: string = '';
+
+  @command
+  @help('Look up basic account information')
+  public async whois() {
+    try {
+      const accounts = await Rivendell.searchAccounts(this.term, this.availability);
+      if (accounts.length) {
+        this.render(accounts);
+      } else {
+        const zone = this.availability || 'us';
+        console.log(chalk.yellow(`No accounts matching search term '${this.term}' found in ${zone}.`));
+      }
+    } catch (e) {
+      die(formatError(e));
+    }
+  }
+
+  private render(accounts: Account[]) {
+    const header = ['id', 'tracker Id', 'name'].map((item) => chalk.grey(item));
+    const rows = accounts.map((account) => [account.id, account.trackerId, account.name]);
+    const t = table(
+      [
+        header,
+        ...rows
+      ],
+      {
+        hsep: ' '.repeat(8),
+        stringLength: styledStringLength
+      }
+    );
+    console.log(`\n${t}\n`);
+  }
+}

package/src/commands/app/BaseBuildCommand.ts

@@ -0,0 +1,266 @@
+import chalk from 'chalk';
+import {execSync} from 'child_process';
+import {DotenvParseOutput} from 'dotenv';
+import {defaultValue, flag, help, param} from 'oo-cli';
+import {AppContext, appContext} from '../../lib/AppContext';
+import {AppPackager} from '../../lib/AppPackager';
+import {AppUpdater} from '../../lib/AppUpdater';
+import {AppUploader} from '../../lib/AppUploader';
+import {die} from '../../lib/die';
+import {directoryExists} from '../../lib/directoryExists';
+import {formatBuildState} from '../../lib/formatBuildState';
+import {gatherAppEnv, validateAppEnvs} from '../../lib/gatherAppEnv';
+import {handleInterrupt} from '../../lib/handleInterrupt';
+import {TerminalSpinner} from '../../lib/TerminalSpinner';
+import {ErrorList, watchBuild} from '../../lib/build';
+import {Rivendell} from '../../lib/Rivendell';
+import {formatError} from '../../lib/formatError';
+import {RivendellApi} from '../../lib/RivendellApi';
+import {applicableShards, targetShards} from '../../lib/Shards';
+import ApiError = RivendellApi.ApiError;
+import Build = Rivendell.Build;
+import BuildState = Rivendell.BuildState;
+import AppVersion = Rivendell.AppVersion;
+import AppVersionState = Rivendell.AppVersionState;
+import ReviewStatus = Rivendell.ReviewStatus;
+
+export abstract class BaseBuildCommand {
+  @flag('no-progress')
+  @help("Don't display any progress indicators")
+  public noProgress!: boolean;
+
+  @flag('upgrade-deps')
+  @help('Automatically update dependencies')
+  public upgradeDeps!: boolean;
+
+  @param
+  @help('The root directory of the app')
+  @defaultValue('./')
+  public path!: string;
+
+  protected async run(upload: boolean, publish: boolean, usePreviousAppEnvValues: boolean) {
+    handleInterrupt();
+
+    if (!directoryExists(this.path)) {
+      die('Specified path to app does not exist');
+    }
+    process.chdir(this.path);
+
+    const context = appContext();
+    if (!context.appId || !context.version || !context.runtime) {
+      die('Unable to read App ID or version info. Ensure you are uploading the right directory.');
+      return;
+    }
+
+    if (!usePreviousAppEnvValues) {
+      validateAppEnvs(await targetShards());
+    }
+    const shards: string[] = await applicableShards();
+
+    await AppUpdater.ensureDependencies(upload, this.upgradeDeps, context.runtime);
+
+    console.log(chalk.gray('Performing local validation...'));
+    try {
+      execSync('yarn --silent validate', {stdio: 'inherit'});
+    } catch (e) {
+      process.exit(1);
+    }
+    if (upload) {
+      console.log(chalk.gray('Verifying upload constraints...'));
+      try {
+        execSync('git rev-parse --is-inside-work-tree');
+      } catch (e) {
+        console.log(chalk.red('\nApp must be in an initialized Git repository'));
+        process.exit(1);
+      }
+
+      try {
+        const version = await this.fetchAppVersion(context, 'us');
+        const packageUrl = version?.state === AppVersionState.RUNNING
+          ? version?.packageUrl
+          : await this.uploadPackage(context);
+
+        for (const shard of shards) {
+          let appEnv = gatherAppEnv(shard);
+          if (usePreviousAppEnvValues && Object.keys(appEnv).length > 0) {
+            console.log(chalk.yellow('\n--use-previous-app-env-values is on. Ignoring values from .env file'));
+            appEnv = {};
+          }
+          await this.registerOrUpdateVersion(context, packageUrl, appEnv, usePreviousAppEnvValues, shard);
+        }
+
+        if (version?.state !== AppVersionState.RUNNING) {
+          await this.build(context, publish);
+        }
+      } catch (e) {
+        die(formatError(e));
+      }
+    }
+  }
+
+  protected async fetchAppVersion(context: AppContext, shard: string): Promise<AppVersion | null> {
+    try {
+      return await Rivendell.fetchAppVersion(context, shard);
+    } catch (e) {
+      if (e instanceof ApiError && e.response?.status === 404) {
+        console.log(chalk.gray('Existing version not found...'));
+        return null;
+      }
+
+      throw e;
+    }
+  }
+
+  protected isRelease(appVersionId: string) {
+    return !this.isDevVersion(appVersionId);
+  }
+
+  protected isDevVersion(appVersionId?: string) {
+    return appVersionId?.includes('-dev');
+  }
+
+  protected async reviewAppVersion(appId: string, version: string) {
+     if (await this.requiresReview(version)) {
+       const appVersion = await this.fetchAppVersion({appId, version}, 'us');
+       if (appVersion?.state === AppVersionState.PUBLISHED && appVersion.reviewStatus !== ReviewStatus.NOT_REQUIRED) {
+         await Rivendell.reviewAppVersion(appId, version);
+       }
+     }
+  }
+
+  protected async isInReview(appId: string, version: string) {
+      const appVersion = await this.fetchAppVersion({appId, version}, 'us');
+      if (appVersion) {
+        const reviewStatus = appVersion.reviewStatus as ReviewStatus;
+        return reviewStatus === ReviewStatus.IN_REVIEW;
+      } else {
+        return false;
+      }
+  }
+
+  protected async requiresReview(version: string) {
+    return !await this.isAdmin() && this.isRelease(version);
+  }
+
+  private async uploadPackage(context: AppContext): Promise<string> {
+    try {
+      await Rivendell.fetchApp(context.appId!);
+      const packageData = new AppPackager('./').package();
+      return await new AppUploader(context, packageData).upload();
+    } catch (e) {
+      console.log('App ID must be registered before it can be uploaded. Try:');
+      console.log('  ocp app register');
+      throw e;
+    }
+  }
+
+  private async build(context: AppContext, publish: boolean) {
+    try {
+      const build = await this.startBuild(context, publish);
+      await this.watchForBuildCompletion(context, build.id, publish);
+    } catch (e) {
+      console.log('App ID must be registered before it can be uploaded. Try:');
+      console.log('  ocp app register');
+      throw e;
+    }
+  }
+
+  private async registerOrUpdateVersion(
+    context: AppContext,
+    packageUrl: string,
+    appEnv: DotenvParseOutput,
+    usePreviousAppEnvValues: boolean,
+    shard: string)
+  : Promise<void> {
+    try {
+      console.log(chalk.gray(`Checking for existing version (${shard})...`));
+      const version = await this.fetchAppVersion(context, shard);
+      if (version?.state === AppVersionState.RUNNING) {
+        console.log(`AppVersion already running (${shard})`);
+      } else if (version) {
+        await this.updateVersion(context, packageUrl, appEnv, usePreviousAppEnvValues, shard);
+      } else {
+        await this.registerVersion(context, packageUrl, appEnv, usePreviousAppEnvValues, shard);
+      }
+    } catch (e) {
+      die(`${formatError(e)} (${shard})`);
+    }
+  }
+
+  private async registerVersion(
+    context: AppContext,
+    packageUrl: string,
+    appEnv: DotenvParseOutput,
+    usePreviousAppEnvValues: boolean,
+    shard: string
+  ): Promise<void> {
+    console.log(chalk.gray(`Registering a new version (${shard})...`));
+    await Rivendell.registerAppVersion(
+      context.appId!!,
+      context.version!!,
+      packageUrl,
+      appEnv,
+      usePreviousAppEnvValues,
+      shard
+    );
+  }
+
+  private async updateVersion(
+    context: AppContext,
+    packageUrl: string,
+    appEnv: DotenvParseOutput,
+    usePreviousAppEnvValues: boolean,
+    shard: string)
+  : Promise<void> {
+    console.log(chalk.gray(`Updating existing version (${shard})...`));
+    await Rivendell.updateAppVersion(
+      context.appId!!,
+      context.version!!,
+      packageUrl,
+      appEnv,
+      usePreviousAppEnvValues,
+      shard
+    );
+  }
+
+  private async startBuild(context: AppContext, publish: boolean): Promise<Build> {
+    console.log(chalk.gray(`Starting ${publish ? 'build' : 'validation '}...`));
+    return publish
+      ? await Rivendell.build(context.appId!, context.version!)
+      : await Rivendell.verify(context.appId!, context.version!);
+  }
+
+  private async watchForBuildCompletion(context: AppContext, id: number, publish: boolean) {
+    console.log(
+      chalk.gray(`Waiting for ${publish ? 'build' : 'validation'} (id=${id}) to complete... CTRL+C to stop checking.`)
+    );
+
+    const spinner = this.noProgress ? null :
+      new TerminalSpinner().start(`Status: ${formatBuildState(BuildState.NEW)}`);
+    const requiresReview = await this.requiresReview(context.version as string);
+
+    return watchBuild(id, (state) => {
+      spinner?.update(`Status: ${formatBuildState(state)}`);
+    }).then((errors: ErrorList) => {
+      spinner?.stop();
+      if (errors) {
+        die(`${publish ? 'Build' : 'Validation'} failed:\n${errors.map((e) => ` * ${e}`).join('\n')}`);
+      } else if (publish) {
+        if (requiresReview) {
+          console.log(chalk.green('Build complete.'));
+        } else {
+          console.log(chalk.green('Build complete. Ready to be published.'));
+        }
+      } else {
+        console.log(chalk.green('Validation complete. No errors found.'));
+      }
+    }).catch((err) => {
+      die(formatError(err));
+    });
+  }
+
+  private async isAdmin() {
+    const me = await Rivendell.whoami();
+    return me.role === 'administrator' || me.role === 'app_administrator';
+  }
+}