@corva/create-app 0.40.0-1 → 0.41.0-1

package/README.md

@@ -4,7 +4,7 @@ Apps generator for [corva.ai](https://corva.ai).
 
 ## Prerequisites
 
-- NodeJs 12+ (https://nodejs.org/en/download/)
+- NodeJs >= 16.14.0 (https://nodejs.org/en/download/)
 
 ## Installation
 
@@ -46,26 +46,20 @@ Options:
   --appKey [string]               Enter the App Key (default: "app.key-goes-here")
   --appName [string]              Enter the App Name
   --appType [string]              Choose the App Type (choices: "ui", "scheduler", "stream", "task", default: "ui")
-  --bump-version <string>         DEPRECATED Use with zip or release command instead (choices: "major", "minor", "patch", "skip")
   --category [string]             Enter category (default: "")
   --cronString [string]           Provide CRON string for the scheduler (default: "*/5 * * * *")
   --depthMilestone [number]       Provide depth milestone for the scheduler (default: 1)
   --description [string]          Enter description (default: "This is the description of my app. You can do great things with it!")
   --developerIdentifier [string]  Enter the Developer Identifier (default: "oandgc")
   --developerName [string]        Enter the Developer Name (default: "O&G Company")
-  --ignored-files                 File patters to skip zip
-  --release                       DEPRECATED Use release command instead
-  --runtime [string]              Choose runtime (choices: "ui", "nodejs12.x", "nodejs14.x", "python3.8")
+  --runtime [string]              Choose runtime (choices: "ui", "nodejs16.x", "python3.8")
   --schedulerType [number]        Choose the scheduler type (choices: "1", "2", "4", default: 1)
   --segments [string]             Choose segments (choices: "drilling", "completion")
   --summary [string]              Enter summary (default: "More information about this app goes here")
   --website [string]              Enter website (default: "https://www.oandgexample.com/my-app/")
-  --silent [boolean]              Only log result of the operation
-  -V, --version                   output the version number
-  -h, --help                      display help for command
   -p, --packageManager [string]   Please select the desired package manager (choices: "yarn", "npm", default: "yarn")
   -t, --useTypescript [boolean]   Would you like to use TypesScript? (default: false)
-  -z, --zip [string]              DEPRECATED Use zip command instead
+  --silent [boolean]              Only log result of the operation (default: false)
 ```
 
 ### Examples
@@ -98,13 +92,13 @@ Usage: create-corva-app zip [options] <project-directory> [patterns...]
 Bundle app
 
 Arguments:
-  project-directory        Project directory to work with
-  patterns                 Additional patterns to zip (default: [])
+  project-directory                  Project directory to work with
+  patterns                           Additional patterns to zip (default: [])
 
 Options:
-  --bump-version <string>  bump version (choices: "major", "minor", "patch", "skip")
-  --silent [boolean]       Only log result of the operation
-  -h, --help               display help for command
+  --bump-version <string>            Bump version (choices: "major", "minor", "patch", "skip")
+  --ignored-files [ignoredFiles...]  Patterns to skip zip
+  --silent [boolean]                 Only log result of the operation (default: false)
 ```
 
 ### What is getting zipped?
@@ -170,13 +164,18 @@ Usage: create-corva-app release [options] <project-directory> [patterns...]
 Release app
 
 Arguments:
-  project-directory        Project directory to work with
-  patterns                 Additional patterns to zip (default: [])
+  project-directory            Project directory to work with
+  patterns                     Additional patterns to zip (default: [])
 
 Options:
-  --bump-version <string>  bump version (choices: "major", "minor", "patch", "skip")
-  --silent [boolean]       Only log result of the operation
-  -h, --help               display help for command
+  --bump-version <string>      Bump version (choices: "major", "minor", "patch", "skip")
+  --ignored-files [string...]  Patterns to skip zip (default: [])
+  --env [string]               Environment to use (choices: "qa", "staging", "production", default: "qa")
+  --api-key [string]           Pre generated API key for authorization during app upload
+  --notes [string]             Add custom notes to published app
+  --label [string]             Put a label on the release (choices: "BETA", "STABLE")
+  --remove-on-fail [boolean]   Remove release if it fails during deployment (default: false)
+  --silent [boolean]           Only log result of the operation (default: false)
 ```
 
 ### Examples

package/bin/cca.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { run } from '../lib/main.js';
+
+await run();

package/bin/create-corva-app.cjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require('child_process');
+const { resolve } = require('path');
+
+const cmd = [
+  'node',
+  '--no-warnings',
+  '--experimental-json-modules',
+  resolve(__dirname, 'cca.js'),
+  ...process.argv.slice(2),
+];
+
+spawnSync(cmd.join(' '), { stdio: 'inherit', shell: true });

package/lib/bump-version.option.js

@@ -1,6 +1,6 @@
-const { Option, InvalidArgumentError } = require('commander');
-const chalk = require('chalk');
-const semver = require('semver');
+import { Option, InvalidArgumentError } from 'commander';
+import chalk from 'chalk';
+import semver from 'semver';
 
 const flags = '--bump-version <string>';
 const description = 'Bump version';
@@ -17,14 +17,23 @@ function argParser(value, previous) {
       .join(', ')} or a valid semver version.`
   );
 }
-const bumpVersionOption = new Option(flags, description).choices(choices).argParser(argParser);
+export const bumpVersionOption = new Option(flags, description)
+  .choices(choices)
+  .argParser(argParser);
+
+export const apiKeyOption = new Option('--api-key [string]',
+  'Pre generated API key for authorization during app upload')
 
-const bumpVersionOptionDeprecated = new Option(
+export const envOption = new Option('--env [string]', 'Environment to use')
+  .choices(['qa', 'staging', 'production'])
+  .default('qa')
+
+export const silentOption = new Option('--silent [boolean]', 'Only log result of the operation').default(false)
+
+export const bumpVersionOptionDeprecated = new Option(
   flags,
   chalk.bgYellow`DEPRECATED` +
-    ` Use with ${chalk.cyan`zip`} or ${chalk.cyan`release`} command instead`
+  ` Use with ${chalk.cyan`zip`} or ${chalk.cyan`release`} command instead`
 )
   .choices(choices)
   .argParser(argParser);
-
-module.exports = { bumpVersionOption, bumpVersionOptionDeprecated };

package/lib/constants/cli.js

@@ -1,12 +1,12 @@
-const APP_RUNTIMES = {
+export const APP_RUNTIMES = {
   UI: 'ui',
-  NODE12: 'nodejs12.x',
-  NODE14: 'nodejs14.x',
+  // NODE12: 'nodejs12.x',
+  // NODE14: 'nodejs14.x',
   NODE16: 'nodejs16.x',
   PYTHON3: 'python3.8',
 };
 
-const TEMPLATE_TYPES = {
+export const TEMPLATE_TYPES = {
   UI: 'js',
   UI_TS: 'ts',
   NODE: 'node',
@@ -14,15 +14,9 @@ const TEMPLATE_TYPES = {
   PYTHON: 'python',
 };
 
-const APP_TYPES = {
+export const APP_TYPES = {
   UI: 'ui',
   SCHEDULER: 'scheduler',
   STREAM: 'stream',
   TASK: 'task',
 };
-
-module.exports = {
-  TEMPLATE_TYPES,
-  APP_RUNTIMES,
-  APP_TYPES,
-};

package/lib/constants/manifest.js

@@ -1,6 +1,6 @@
-const { APP_RUNTIMES, APP_TYPES, TEMPLATE_TYPES } = require('./cli');
+import { APP_RUNTIMES, APP_TYPES, TEMPLATE_TYPES } from './cli.js';
 
-const defaultManifest = {
+export const defaultManifest = {
   format: 1,
   license: {
     type: 'MIT',
@@ -32,7 +32,7 @@ const defaultManifest = {
   datasets: {},
 };
 
-const defaultUIAppManifest = {
+export const defaultUIAppManifest = {
   application: {
     ui: { initial_size: { w: 4, h: 10 } },
   },
@@ -45,7 +45,7 @@ const defaultUIAppManifest = {
   },
 };
 
-const defaultDataAppNodeManifest = {
+export const defaultDataAppNodeManifest = {
   settings: {
     entrypoint: {
       file: 'index.js',
@@ -57,7 +57,7 @@ const defaultDataAppNodeManifest = {
   },
 };
 
-const defaultDataAppPythonManifest = {
+export const defaultDataAppPythonManifest = {
   settings: {
     entrypoint: {
       file: 'lambda_function',
@@ -69,7 +69,7 @@ const defaultDataAppPythonManifest = {
   },
 };
 
-const getManifestMandatoryKeys = (opts) => {
+export const getManifestMandatoryKeys = (opts) => {
   const keys = manifestOptions(opts.projectName).reduce((acc, option) => {
     if (option.required) {
       acc.push(option.name);
@@ -99,11 +99,11 @@ const getManifestMandatoryKeys = (opts) => {
   return keys;
 };
 
-const SCHEDULER_TYPE_NATURAL_TIME = { name: 'Natural Time', value: 1 };
-const SCHEDULER_TYPE_DATA_TIME = { name: 'Data Time', value: 2 };
-const SCHEDULER_TYPE_DEPTH = { name: 'Date Depth', value: 4 };
+export const SCHEDULER_TYPE_NATURAL_TIME = { name: 'Natural Time', value: 1 };
+export const SCHEDULER_TYPE_DATA_TIME = { name: 'Data Time', value: 2 };
+export const SCHEDULER_TYPE_DEPTH = { name: 'Date Depth', value: 4 };
 
-const manifestOptions = (projectName = 'Corva Dev Center App') => [
+export const manifestOptions = (projectName = 'Corva Dev Center App') => [
   { name: 'developerName', message: 'Enter the Developer Name', default: 'O&G Company' },
   { name: 'developerIdentifier', message: 'Enter the Developer Identifier', default: 'oandgc' },
   {
@@ -210,15 +210,3 @@ const manifestOptions = (projectName = 'Corva Dev Center App') => [
     default: false,
   },
 ];
-
-module.exports = {
-  defaultManifest,
-  defaultUIAppManifest,
-  defaultDataAppNodeManifest,
-  defaultDataAppPythonManifest,
-  manifestOptions,
-  getManifestMandatoryKeys,
-  SCHEDULER_TYPE_NATURAL_TIME,
-  SCHEDULER_TYPE_DATA_TIME,
-  SCHEDULER_TYPE_DEPTH,
-};

package/lib/constants/messages.js

@@ -1,9 +1,9 @@
-const chalk = require('chalk');
+import chalk from 'chalk';
 
-const SUCCESS_ICON = '  ✅  \n';
-const ERROR_ICON = '  ❌  \n';
+export const SUCCESS_ICON = '  ✅  \n';
+export const ERROR_ICON = '  ❌  \n';
 
-const RELEASE = {
+export const RELEASE = {
   createZip: 'Creating zip archive...\n',
   createZipError: 'Could not create zip archive.',
   createZipSuccess: `Zip archive has been created ${SUCCESS_ICON}`,
@@ -13,9 +13,3 @@ const RELEASE = {
   getAppKeyError: "Could not find app key. Please make sure it's defined in manifest.json",
   uploadApp: 'Uploading app...',
 };
-
-module.exports = {
-  RELEASE,
-  SUCCESS_ICON,
-  ERROR_ICON,
-};

package/lib/constants/package.js

@@ -129,13 +129,13 @@ const nodeTsYarnPackage = {
   scripts: nodeTsYarnScripts,
 };
 
-const extendWithTsConfig = (package, version) => {
-  package.devDependencies = {
+const extendWithTsConfig = (packageJson, version) => {
+  packageJson.devDependencies = {
     [`@tsconfig/node${version}`]: `^${version === '12' ? '1.0.9' : '1.0.1'}`,
-    ...package.devDependencies,
+    ...packageJson.devDependencies,
   };
 
-  return package;
+  return packageJson;
 };
 
 const defaults = {
@@ -169,8 +169,6 @@ const defaults = {
   },
 };
 
-module.exports = {
-  getDefaultsForPackageJson: (manifest, runtime) => {
-    return defaults[runtime.language][runtime.packageManager][manifest.type](runtime);
-  },
+export const getDefaultsForPackageJson = (manifest, runtime) => {
+  return defaults[runtime.language][runtime.packageManager][manifest.type](runtime);
 };

package/lib/flow.js

@@ -1,17 +1,21 @@
-'use strict';
+import chalk from 'chalk';
+import { SUCCESS_ICON } from './constants/messages.js';
+import { resolve, sep } from 'node:path';
+import { logger } from './helpers/logger.js';
 
-const chalk = require('chalk');
-const { SUCCESS_ICON } = require('./constants/messages');
-const { resolve, sep } = require('path');
-const logger = require('./helpers/logger');
+import Debug from 'debug';
 
-const debug = require('debug')('cca:flow');
+const debug = Debug('cca:flow');
 
-const runFlow = async (flow, context, indent = '') => {
+export const runFlow = async (flow, context, indent = '') => {
   logger.write(
-    `${indent}Running ${chalk.cyan(flow.name)} in ${chalk.cyan(resolve(context.dirName).split(sep).pop())}\n`
+    `${indent}Running ${chalk.cyan(flow.name)} in ${chalk.cyan(
+      resolve(context.dirName).split(sep).pop()
+    )}\n`
   );
 
+  context.progress = () => logger.write('.')
+
   const result = await runSteps(flow.steps, context, indent + '  ');
 
   logger.write(`${indent}Done!` + SUCCESS_ICON);
@@ -43,5 +47,3 @@ const runSteps = async (steps = [], context = {}, indent = '') => {
 
   return context;
 };
-
-module.exports = { runFlow };

package/lib/flows/lib/api.js

@@ -1,50 +1,35 @@
-const axios = require('axios');
+import got from 'got';
+import Debug from 'debug';
+import { StepError } from './step-error.js';
+import _ from 'lodash/fp.js';
+
+const debug = Debug('cca:api');
+
+/**
+ * Connect to Corva API
+ *
+ */
+export class Api {
+  /**
+    * @type {import('got').Got}
+    */
+  #api;
 
- /**
-   * Connect to Corva API
-   *
-   */
-class Api {
   constructor(envName, apiKey, authToken = null) {
-    this.baseURL = `https://api${
-      envName === 'production' ? '' : `.${envName}`
-    }.corva.ai`;
+    const prefixUrl = `https://api${envName === 'production' ? '' : `.${envName}`}.corva.ai`;
 
-    this.config = {
+    this.#api = got.extend({
+      prefixUrl,
+      retry: { limit: 0 },
       headers: {
-        'Authorization': authToken ? `Bearer ${authToken}` :`API ${apiKey}`,
+        'Authorization': authToken ? `Bearer ${authToken}` : `API ${apiKey}`,
         'Content-Type': 'application/json',
         'Accept': 'application/json',
       },
-    };
-  }
-
-  /**
-   * Get api url
-   *
-   * @private
-   *
-   * @param {string} path
-   *
-   * @returns  {string}
-   */
-  getUrl(path) {
-    return `${this.baseURL}${path}`;
-  }
-
-  /**
-   * Send api request
-   *
-   * @private
-   *
-   * @param {string} path
-   * @param {string} method
-   * @param {object} data
-   *
-   * @returns  {object}
-   */
-  sendRequest(method, url, data = null) {
-    return data ? axios[method](url, data, this.config) : axios[method](url, this.config);
+      hooks: {
+        beforeRequest: [debug]
+      }
+    })
   }
 
   /**
@@ -57,10 +42,10 @@ class Api {
    * @returns  {object}
    */
   async getAppByKey(appKey) {
-    const url = this.getUrl(`/v2/apps?per_page=2&search=${appKey}`);
-    const response = await this.sendRequest('get', url);
+    const { data: [app] } = await this.#api.get('v2/apps', {
+      searchParams: { per_page: 2, search: appKey }
+    }).json();
 
-    const app = response.data.data[0];
     if (!app || app.attributes.app_key != appKey) {
       throw new Error(`App with key - ${appKey}, not exist`);
     }
@@ -78,16 +63,13 @@ class Api {
    * @returns  {object}
    */
   async getAppDatasetsOperationWrite(appId) {
-    const url = this.getUrl(
-      `/v2/apps/${appId}/app_datasets?dataset_operation=write&fields[]=app_dataset.dataset_name`
-    );
-    const response = await this.sendRequest('get', url);
+    const { data } = await this.#api.get(`v2/apps/${appId}/app_datasets?dataset_operation=write&fields[]=app_dataset.dataset_name`).json();
 
-    if (!response.data.data.length) {
-      throw new Error(`App with ID - ${appId}, has not any datasets`);
+    if (!data.length) {
+      throw new Error(`App with ID - ${appId}, has no datasets`);
     }
 
-    return response.data.data;
+    return data;
   }
 
   /**
@@ -97,16 +79,14 @@ class Api {
    *
    * @param {string} assetId
    *
-   * @returns  {object[]}
+   * @returns  {Promise<object[]>}
    */
   async getAssetById(assetId) {
-    const url = this.getUrl(`/v2/assets/${assetId}`);
-    const response = await this.sendRequest('get', url);
+    const { data } = await this.#api.get(`v2/assets/${assetId}`).json();
 
-    return response.data.data;
+    return data;
   }
 
-
   /**
    * Get asset streams
    *
@@ -116,15 +96,20 @@ class Api {
    *
    * @returns  {object[]}
    */
-   async getStreamByAssetId(assetId) {
-    const url = this.getUrl(`/v1/app_streams?asset_id=${assetId}&segment=drilling&status=complete`);
-    const response = await this.sendRequest('get', url);
+  async getStreamByAssetId(assetId) {
+    const data = await this.#api.get(`v1/app_streams`, {
+      searchParams: {
+        asset_id: assetId,
+        segment: 'drilling',
+        status: 'complete'
+      }
+    }).json();
 
-    if (!response.data[0]) {
+    if (!data[0]) {
       throw new Error(`Could not found streams for asset ID - ${assetId}`);
     }
 
-    return response.data;
+    return data;
   }
 
   /**
@@ -137,18 +122,13 @@ class Api {
    * @returns  {object[]}
    */
   async getWellByAssetId(assetId) {
-    const data = {
-      assets: [assetId],
-    };
+    const { wells } = await this.#api.post('v2/assets/resolve', { json: { assets: [assetId], } }).json();
 
-    const url = this.getUrl(`/v2/assets/resolve`);
-    const response = await this.sendRequest('post', url, data);
-
-    if (!response.data.wells.length) {
+    if (!wells.length) {
       throw new Error(`Could not found wells by asset ID - ${assetId}`);
     }
 
-    return response.data.wells;
+    return wells;
   }
 
   /**
@@ -165,7 +145,7 @@ class Api {
    * @returns  {object}
    */
   async queueAppRun(appId, version, wellId, appDatasetsNames, streamId) {
-    const data = {
+    const json = {
       app_run: {
         app_stream_id: streamId,
         well_id: wellId,
@@ -181,9 +161,9 @@ class Api {
       },
     };
 
-    const url = this.getUrl(`/v2/apps/${appId}/app_runs`);
-    const response = await this.sendRequest('post', url, data);
-    return response.data.data;
+    const { data } = await this.#api.post(`v2/apps/${appId}/app_runs`, { json }).json();
+
+    return data;
   }
 
   /**
@@ -195,11 +175,10 @@ class Api {
    *
    * @returns  {object[]}
    */
-   async getAppRuns(appId) {
-    const url = this.getUrl(`/v2/apps/${appId}/app_runs?page=1&per_page=500&status[]=pending&status[]=in_progress&status[]=running`);
-    const response = await this.sendRequest('get', url);
+  async getAppRuns(appId) {
+    const { data } = await this.#api.get(`v2/apps/${appId}/app_runs?page=1&per_page=500&status[]=pending&status[]=in_progress&status[]=running`).json();
 
-    return response.data.data;
+    return data;
   }
 
   /**
@@ -212,14 +191,104 @@ class Api {
    *
    * @returns
    */
-    async uploadPackages(appKey, formData) {
-      const url = this.getUrl(`/v2/apps/${appKey}/packages/upload`);
-      this.config.headers = {
-        ...this.config.headers,
-        ...formData.getHeaders(),
+  async uploadPackages(appKey, formData) {
+    const uploadURL = `v2/apps/${appKey}/packages/upload`;
+
+    try {
+      const { data } = await this.#api.post(uploadURL, {
+        headers: formData.getHeaders(),
+        body: formData,
+      }).json();
+
+      return {
+        id: data.id,
+        status: data.attributes.status,
       };
-      return this.sendRequest('post', url, formData)
+    } catch (e) {
+      throw new StepError(
+        `${JSON.parse(e.response.body).message || ''} \nPOST: ${uploadURL} failed.`,
+        { cause: e }
+      );
+
     }
-}
+  }
+
+
+  /**
+* @param {string} appId
+* @param {string} id
+* @param {string} notes
+*
+* @returns { Promise<{id: number, status: string}>}
+*/
+  async addNotes(appId, id, notes) {
+    const { data } = await this.#api.patch(`v2/apps/${appId}/packages/${id}`, {
+      json: { package: { notes } },
+    }).json();
 
-module.exports = { Api };
+    return {
+      id: data.id,
+      status: data.attributes.status,
+    };
+  }
+
+  /**
+* @param {string} appId
+* @param {string} uploadId
+*
+* @returns { Promise<{id: number, status: string}>}
+*/
+  async checkApp(appId, uploadId) {
+    const { data } = await this.#api.get(`v2/apps/${appId}/packages/${uploadId}`).json();
+
+    return {
+      id: data.id,
+      status: data.attributes.status,
+    };
+  }
+
+  /**
+ * @param {string} appId
+ * @param {string} uploadId
+ *
+ * @returns { Promise<void>}
+ */
+  deleteAppUpload(appId, uploadId) {
+    return this.#api.del(`v2/apps/${appId}/packages/${uploadId}`).json();
+  }
+
+  /**
+ * @param {string} appId
+ * @param {string} id
+ *
+ * @returns { Promise<{id: number, status: string}>}
+ */
+  async publishApp(appId, id) {
+    console.log(`v2/apps/${appId}/packages/${id}`, {
+      json: { package: { status: 'published' } },
+    })
+    const { data } = await this.#api.patch(`v2/apps/${appId}/packages/${id}`, {
+      json: { package: { status: 'published' } },
+    }).json();
+
+    console.log('done')
+
+    return {
+      id: data.id,
+      status: data.attributes.status,
+    };
+  }
+
+  /**
+ * @param {string} appId
+ * @param {string} id
+ * @param {'BETA' | 'PROD'} label
+ *
+ * @returns { Promise<{id: number, status: string}>}
+ */
+  async putLabel(appId, id, label) {
+    await this.#api.patch(`v2/apps/${appId}/packages/${id}`, {
+      json: { package: { label } },
+    });
+  }
+}