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

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 } },
+    });
+  }
+}

package/lib/flows/lib/create-zip-archive.js

@@ -1,9 +1,11 @@
-const archiver = require('archiver');
-const debug = require('debug')('cca:zip');
-const { promises: fs, createWriteStream } = require('fs');
-const path = require('path');
+import archiver from 'archiver';
+import Debug from 'debug';
 
-const createZipArchive = async (dirName, zipName, itemsToZip = []) => {
+const debug = Debug('cca:zip');
+import { promises as fs, createWriteStream } from 'node:fs';
+import path from 'node:path';
+
+export const createZipArchive = async (dirName, zipName, itemsToZip = []) => {
   const filePath = path.resolve(dirName, zipName);
   const archive = archiver.create('zip', {});
   const output = createWriteStream(filePath);
@@ -73,5 +75,3 @@ const getDataToZip = async (itemsToZip, dirName) => {
 
   return allData.filter((f) => f.exists);
 };
-
-module.exports = { createZipArchive };

package/lib/flows/lib/json.js

@@ -1,10 +1,12 @@
-const { resolve } = require('path');
-const { promises: fs } = require('fs');
-const os = require('os');
+import { resolve } from 'node:path';
+import { promises as fs } from 'node:fs';
+import os from 'node:os';
 
-const debug = require('debug')('cca:json');
+import Debug from 'debug';
 
-const loadJson = async (dirName, fileName) => {
+const debug = Debug('cca:json');
+
+export const loadJson = async (dirName, fileName) => {
   const fullPath = resolve(dirName, fileName);
 
   try {
@@ -21,8 +23,6 @@ const loadJson = async (dirName, fileName) => {
   }
 };
 
-const saveJson = async (dirName, fileName, data) => {
+export const saveJson = async (dirName, fileName, data) => {
   return fs.writeFile(resolve(dirName, fileName), JSON.stringify(data, null, 2) + os.EOL);
 };
-
-module.exports = { loadJson, saveJson };

package/lib/flows/lib/manifest.js

@@ -1,8 +1,8 @@
-const { APP_TYPES, APP_RUNTIMES } = require('../../constants/cli');
+import { APP_TYPES, APP_RUNTIMES } from '../../constants/cli.js';
 
 const NODE_RUNTIMES = [APP_RUNTIMES.NODE12, APP_RUNTIMES.NODE14, APP_RUNTIMES.NODE16];
 
-class Manifest {
+export class Manifest {
   constructor(manifest) {
     this.manifest = manifest;
   }
@@ -12,11 +12,11 @@ class Manifest {
   }
 
   get type() {
-    return this.manifest.application.type
+    return this.manifest.application.type;
   }
 
   get name() {
-    return this.manifest.application.name
+    return this.manifest.application.name;
   }
 
   get unix_name() {
@@ -25,7 +25,7 @@ class Manifest {
   }
 
   get description() {
-    return this.manifest.application.description
+    return this.manifest.application.description;
   }
 
   isNode() {
@@ -48,5 +48,3 @@ class Manifest {
     return this.manifest.application.type === APP_TYPES.SCHEDULER;
   }
 }
-
-module.exports = { Manifest };

package/lib/flows/lib/step-error.js

@@ -1,4 +1,4 @@
-class StepError extends Error {
+export class StepError extends Error {
   cause;
   name;
 
@@ -8,5 +8,3 @@ class StepError extends Error {
     this.cause = cause;
   }
 }
-
-module.exports = { StepError };

package/lib/flows/prepare.js

@@ -1,8 +1,6 @@
-const { LOAD_APP_FILES_STEP } = require('./steps/prepare-load-app-files');
+import { LOAD_APP_FILES_STEP } from './steps/prepare-load-app-files.js';
 
-const PREPARE_FLOW = {
+export const PREPARE_FLOW = {
   name: 'prepare',
   steps: [LOAD_APP_FILES_STEP],
 };
-
-module.exports = { PREPARE_FLOW };

package/lib/flows/release.js

@@ -1,18 +1,26 @@
-const { PREPARE_FLOW } = require('./prepare');
-const { GET_APP_KEY_STEP } = require('./steps/release-get-app-key');
-const { GET_RELEASE_CONFIG_STEP } = require('./steps/release-get-config');
-const { UPLOAD_ZIP_TO_CORVA_STEP } = require('./steps/release-upload-zip-to-corva');
-const { ZIP_SIMPLE_FLOW } = require('./zip-simple');
+import { PREPARE_FLOW } from './prepare.js';
+import { SETUP_API_CLIENT_STEP } from './steps/release/get-config.js';
+import { UPLOAD_ZIP_TO_CORVA_STEP } from './steps/release/upload-zip-to-corva.js';
+import { ZIP_SIMPLE_FLOW } from './zip-simple.js';
+import { WAIT_FOR_BUILD_FINISH_STEP } from './steps/release/wait-for-build.js';
+import { REMOVE_FAILED_UPLOAD_STEP } from './steps/release/remove-failed-upload.js';
+import { ADD_LABEL_STEP } from './steps/release/add-label.js';
+import { ADD_NOTES_STEP } from './steps/release/add-notes.js';
+import { PUBLISH_PACKAGE_STEP } from './steps/release/publish.js';
+import { RELEASE_PREPARE_DATA_STEP } from './steps/release/prepare-data.js';
 
-const RELEASE_FLOW = {
+export const RELEASE_FLOW = {
   name: 'release',
   steps: [
     PREPARE_FLOW,
-    GET_RELEASE_CONFIG_STEP,
-    GET_APP_KEY_STEP,
+    SETUP_API_CLIENT_STEP,
+    RELEASE_PREPARE_DATA_STEP,
     ZIP_SIMPLE_FLOW,
     UPLOAD_ZIP_TO_CORVA_STEP,
+    WAIT_FOR_BUILD_FINISH_STEP,
+    REMOVE_FAILED_UPLOAD_STEP,
+    PUBLISH_PACKAGE_STEP,
+    ADD_LABEL_STEP,
+    ADD_NOTES_STEP
   ],
 };
-
-module.exports = { RELEASE_FLOW };

package/lib/flows/rerun.js

@@ -1,10 +1,8 @@
-const { PREPARE_FLOW } = require('./prepare');
-const { RERUN_STEPS } = require('./steps/rerun');
-const { GET_RELEASE_CONFIG_STEP } = require('./steps/release-get-config');
+import { PREPARE_FLOW } from './prepare.js';
+import { RERUN_STEPS } from './steps/rerun.js';
+import { SETUP_API_CLIENT_STEP } from './steps/release/get-config.js';
 
-const RERUN_FLOW = {
+export const RERUN_FLOW = {
   name: 'rerun',
-  steps: [PREPARE_FLOW, GET_RELEASE_CONFIG_STEP, ...RERUN_STEPS],
+  steps: [PREPARE_FLOW, SETUP_API_CLIENT_STEP, ...RERUN_STEPS],
 };
-
-module.exports = { RERUN_FLOW };

package/lib/flows/steps/prepare-load-app-files.js

@@ -1,7 +1,7 @@
-const { loadJson } = require('../lib/json');
-const { Manifest } = require('../lib/manifest');
+import { loadJson } from '../lib/json.js';
+import { Manifest } from '../lib/manifest.js';
 
-const LOAD_APP_FILES_STEP = {
+export const LOAD_APP_FILES_STEP = {
   message: "Loading Corva app's files...",
   async fn(context) {
     const manifest =
@@ -12,7 +12,3 @@ const LOAD_APP_FILES_STEP = {
     return { pkg, manifest };
   },
 };
-
-module.exports = {
-  LOAD_APP_FILES_STEP,
-};

package/lib/flows/steps/release/add-label.js

@@ -0,0 +1,11 @@
+
+export const ADD_LABEL_STEP = {
+  message: 'Adding label...',
+  async fn({ options: { label }, api, appId, packageId }) {
+    if (!label) {
+      return;
+    }
+
+    await api.putLabel(appId, packageId, label);
+  }
+}

package/lib/flows/steps/release/add-notes.js

@@ -0,0 +1,10 @@
+export const ADD_NOTES_STEP = {
+  message: 'Adding notes...',
+  async fn({ api, appId, packageId, options: { notes } }) {
+    if (!notes) {
+      return;
+    }
+
+    await api.addNotes(appId, packageId, notes);
+  }
+}

package/lib/flows/steps/release/get-config.js

@@ -0,0 +1,37 @@
+import { RELEASE } from '../../../constants/messages.js';
+import { promises as fs } from 'node:fs';
+import dotenv from 'dotenv';
+import { resolve } from 'node:path';
+import { StepError } from '../../lib/step-error.js';
+import { Api } from '../../lib/api.js';
+
+async function getVarsFromDotEnv({ dirName }) {
+  try {
+    const envFile = await fs.readFile(resolve(dirName, '.env'));
+    return dotenv.parse(envFile);
+  } catch (error) {
+    return {};
+  }
+}
+
+export const SETUP_API_CLIENT_STEP = {
+  message: RELEASE.getAuthToken,
+  fn: async ({ dirName, options: { apiKey, env } }) => {
+    const parsedEnv = await getVarsFromDotEnv({ dirName });
+
+    const CORVA_API_ENV = env || process.env.CORVA_API_ENV || parsedEnv.CORVA_API_ENV;
+    const AUTH_TOKEN = process.env.AUTH_TOKEN || parsedEnv.AUTH_TOKEN;
+    const API_KEY = apiKey || process.env.API_KEY || parsedEnv.API_KEY;
+
+    if (!AUTH_TOKEN && !API_KEY) {
+      throw new StepError(RELEASE.getAuthTokenError);
+    }
+
+    const api = new Api(CORVA_API_ENV, API_KEY, AUTH_TOKEN);
+
+    return {
+      CORVA_API_ENV: CORVA_API_ENV || 'qa',
+      api
+    };
+  },
+};

package/lib/flows/steps/release/prepare-data.js

@@ -0,0 +1,10 @@
+export const RELEASE_PREPARE_DATA_STEP = {
+  message: 'Preparing data...',
+  async fn({ api, manifest }) {
+    const app = await api.getAppByKey(manifest.manifest.application.key.toLowerCase());
+
+    return {
+      appId: app.id,
+    }
+  }
+}

package/lib/flows/steps/release/publish.js

@@ -0,0 +1,9 @@
+export const PUBLISH_PACKAGE_STEP = {
+  message: 'Publishing app...',
+  /**
+   * 
+   * @param {object} param0 
+   * @param {import('../../lib/api').Api} param0.api
+   */
+  async fn({ api, appId, packageId }) { await api.publishApp(appId, packageId) }
+}

package/lib/flows/steps/release/remove-failed-upload.js

@@ -0,0 +1,20 @@
+import { resolve } from 'node:path'
+import { unlink } from 'node:fs/promises'
+
+export const REMOVE_FAILED_UPLOAD_STEP = {
+  message: 'Cleaning up...',
+  async fn({ api, appId, packageId, removeOnFail, uploadStatus, dirName, zipFileName }) {
+    if (uploadStatus === 'draft') {
+      await unlink(resolve(dirName, zipFileName));
+
+      return;
+    }
+
+    if (removeOnFail) {
+      await unlink(resolve(dirName, zipFileName));
+      await api.deleteAppUpload(appId, packageId);
+    }
+
+    throw new Error(`Got unexpected status '${uploadStatus}' while processing package ${packageId}.`);
+  }
+}

package/lib/flows/steps/release/upload-zip-to-corva.js

@@ -0,0 +1,25 @@
+import { RELEASE } from '../../../constants/messages.js';
+import FormData from 'form-data';
+import { resolve } from 'node:path';
+import { createReadStream } from 'node:fs';
+import { StepError } from '../../lib/step-error.js';
+import _ from 'lodash/fp.js';
+
+export const UPLOAD_ZIP_TO_CORVA_STEP = {
+  message: RELEASE.uploadApp,
+  /**
+   * 
+   * @param {object} param0 
+   * @param {import('../../lib/api').Api} param0.api 
+   * @param {import('../../lib/manifest').Manifest} param0.manifest 
+   */
+  fn: async ({ zipFileName, manifest, api, dirName }) => {
+    const form = new FormData();
+
+    form.append('package', createReadStream(resolve(dirName, zipFileName)), 'package.zip');
+
+    const { id: packageId, status: uploadStatus } = await api.uploadPackages(manifest.manifest.application.key, form)
+
+    return { packageId }
+  },
+};

package/lib/flows/steps/release/wait-for-build.js

@@ -0,0 +1,29 @@
+import Debug from 'debug';
+import { waitForMs } from '../../lib/waitForMs.mjs';
+
+const debug = Debug('cca:flow:release:step:wait-for-build');
+
+const PROCESSING_STATUSES = ['pending', 'processing', 'queued', 'deploying'];
+
+export const WAIT_FOR_BUILD_FINISH_STEP = {
+  message: 'Wait till the app will process to draft status...',
+  /**
+   * @param {object} param0
+   * @param {import('../../lib/api').Api} param0.api 
+   */
+  async fn({ api, appId, packageId, progress }) {
+    do {
+      const { status } = await api.checkApp(appId, packageId);
+
+      progress()
+
+      debug(`Status: ${status}`);
+
+      if (!PROCESSING_STATUSES.includes(status)) {
+        return { uploadStatus: status };
+      }
+
+      await waitForMs(5000);
+    } while (true);
+  }
+}