@corva/create-app 0.48.0-0 → 0.48.0-1

package/common/python/.env

@@ -1,12 +1,3 @@
-API_KEY=
-APP_KEY=${APP_KEY}
-APP_NAME=${APP_NAME}
-PROVIDER=${PROVIDER}
-
-API_ROOT_URL=https://api.corva.ai
-DATA_API_ROOT_URL=https://data.corva.ai
-CACHE_URL=redis://localhost:6379
-
 LOG_LEVEL=DEBUG
 LOG_THRESHOLD_MESSAGE_SIZE=99999
 LOG_THRESHOLD_MESSAGE_COUNT=99999

package/common/python/.env.sample

@@ -1,20 +1,4 @@
-# Corva API key to perform actions with the API
-API_KEY=
-# Unique ID of the app
-APP_KEY=
-# Human readable name of the app
-APP_NAME=
-# Company short identifier
-PROVIDER=
-
-# Root URL for Corva API
-API_ROOT_URL=
-# Root URL for Corva Data API
-DATA_API_ROOT_URL=
-# Redis cache url for caching data in Stream/Scheduler apps
-CACHE_URL=
-
-# Logging configuration, see https://corva-ai.github.io/python-sdk/corva-sdk/1.7.0/index.html#_logging
+# Logging configuration, see https://corva-ai.github.io/python-sdk/corva-sdk/1.8.1/index.html#_logging
 LOG_LEVEL=DEBUG
 LOG_THRESHOLD_MESSAGE_SIZE=99999
 LOG_THRESHOLD_MESSAGE_COUNT=99999

package/common/python/requirements.txt

@@ -1,2 +1,2 @@
-corva-sdk==1.7.0
+corva-sdk==1.8.1
 pytest==7.1.1

package/lib/constants/manifest.js

@@ -108,10 +108,15 @@ export const SCHEDULER_TYPE_DATA_TIME = {
   value: 2,
 };
 export const SCHEDULER_TYPE_DEPTH = {
-  name: 'Date Depth',
+  name: 'Depth',
   value: 4,
 };
 
+export const LOG_TYPES = {
+  TIME: 'time',
+  DEPTH: 'depth',
+};
+
 export const manifestOptions = (projectName = 'Corva Dev Center App') => [
   {
     name: 'developerName',
@@ -152,6 +157,13 @@ export const manifestOptions = (projectName = 'Corva Dev Center App') => [
     when: (answers) => answers.schedulerType === SCHEDULER_TYPE_DEPTH.value,
     filter: (value) => (isNaN(value) ? value : Number(value)),
   },
+  {
+    name: 'logType',
+    message: 'Choose the log type',
+    default: LOG_TYPES.TIME,
+    choices: Object.values(LOG_TYPES),
+    when: (answers) => answers.appType === APP_TYPES.STREAM,
+  },
   {
     name: 'appKey',
     message: 'Enter the App Key',

package/lib/constants/package.js

@@ -71,26 +71,28 @@ const tsUiPackage = {
 const nodeNpmScripts = {
   'bundle': 'create-corva-app zip .',
   'test': 'npm audit --production && npm run unit',
-  'unit': 'jest --passWithNoTests',
-  'lint': 'eslint .',
-  'lint:fix': 'eslint . --fix',
+  'unit': 'jest --setupFiles dotenv/config',
+  'lint': 'eslint --ext .js,.ts .',
+  'lint:fix': 'eslint --ext .js,.ts --fix .',
 };
 
 const nodeDependencies = {
-  '@corva/node-sdk': '^7.2.0',
+  '@corva/node-sdk': '^8.0.1',
 };
 
 const nodeDevDependencies = {
-  '@corva/eslint-config-node': '^5.0.0',
+  '@corva/eslint-config-node': '^5.1.1',
   'jest': '^27.5.1',
+  'dotenv': '^16.0.3',
+  'eslint': '^8.2.0',
+  'prettier': '^2.0.0',
+  'typescript': '^4.9.4',
 };
 
 const nodeTsDevDependencies = {
-  '@corva/eslint-config-node': '^5.0.0',
+  ...nodeDevDependencies,
   '@types/jest': '^27.4.1',
-  'jest': '^27.5.1',
   'ts-jest': '^27.1.4',
-  'typescript': '^4.6.3',
 };
 
 const nodeYarnScripts = {
@@ -100,12 +102,16 @@ const nodeYarnScripts = {
 
 const nodeTsScripts = {
   ...nodeNpmScripts,
-  build: 'tsc -p tsconfig.build.json',
+  'build': 'tsc -p tsconfig.build.json',
+  'lint': 'eslint --ext .ts .',
+  'lint:fix': 'eslint --ext .ts --fix .',
 };
 
 const nodeTsYarnScripts = {
   ...nodeYarnScripts,
-  build: 'tsc -p tsconfig.build.json',
+  'build': 'tsc -p tsconfig.build.json',
+  'lint': 'eslint --ext .ts .',
+  'lint:fix': 'eslint --ext .ts --fix .',
 };
 
 const nodeNpmPackage = {
@@ -126,6 +132,10 @@ const nodeTsNpmPackage = {
   ...nodeNpmPackage,
   devDependencies: nodeTsDevDependencies,
   scripts: nodeTsScripts,
+  jest: {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+  },
 };
 
 const nodeTsYarnPackage = {

package/lib/flows/lib/manifest.js

@@ -1,4 +1,15 @@
+import set from 'lodash/set.js';
 import { APP_TYPES, APP_RUNTIMES } from '../../constants/cli.js';
+import {
+  SCHEDULER_TYPE_DATA_TIME,
+  SCHEDULER_TYPE_DEPTH,
+  SCHEDULER_TYPE_NATURAL_TIME,
+} from '../../constants/manifest.js';
+
+const SCHEDULER_MAPPING = [SCHEDULER_TYPE_DATA_TIME, SCHEDULER_TYPE_DEPTH, SCHEDULER_TYPE_NATURAL_TIME].reduce(
+  (acc, type) => set(acc, type.value, type.name.toLowerCase().replace(/ /, '-')),
+  {},
+);
 
 const NODE_RUNTIMES = [APP_RUNTIMES.NODE12, APP_RUNTIMES.NODE14, APP_RUNTIMES.NODE16];
 
@@ -15,6 +26,22 @@ export class Manifest {
     return this.manifest.application.type;
   }
 
+  get subtype() {
+    if (this.isScheduler()) {
+      return SCHEDULER_MAPPING[this.manifest.settings.app.scheduler_type];
+    }
+
+    if (this.isStream()) {
+      return this.manifest.settings.app.log_type;
+    }
+
+    return '';
+  }
+
+  get templateName() {
+    return this.type + (this.isScheduler() || this.isStream() ? `_${this.subtype}` : '');
+  }
+
   get name() {
     return this.manifest.application.name;
   }
@@ -47,4 +74,8 @@ export class Manifest {
   isScheduler() {
     return this.manifest.application.type === APP_TYPES.SCHEDULER;
   }
+
+  isStream() {
+    return this.manifest.application.type === APP_TYPES.STREAM;
+  }
 }

package/lib/helpers/manifest.js

@@ -34,12 +34,7 @@ export function fillManifest(answers) {
     settings: {
       ...defaultManifestProperties.settings,
       runtime,
-      app: defaultAppSettings({
-        type: answers.appType,
-        schedulerType: answers.schedulerType,
-        cronString: answers.cronString,
-        depthMilestone: answers.depthMilestone,
-      }),
+      app: defaultAppSettings(answers),
     },
   };
 
@@ -58,9 +53,11 @@ function _defaultManifestProperties({ type, runtime }) {
   return manifestConstants.defaultDataAppNodeManifest;
 }
 
-function defaultAppSettings({ type, schedulerType, cronString, depthMilestone }) {
-  if (!schedulerType || type !== APP_TYPES.SCHEDULER) {
-    return {};
+function defaultAppSettings({ appType, schedulerType, cronString, depthMilestone, logType }) {
+  if (!schedulerType || appType !== APP_TYPES.SCHEDULER) {
+    return {
+      log_type: logType,
+    };
   }
 
   if (schedulerType === manifestConstants.SCHEDULER_TYPE_DEPTH.value) {

package/lib/helpers/resolve-app-runtime.js

@@ -53,6 +53,27 @@ const checkNodeVersion = (version) => async () => {
 
 export const IS_WINDOWS = process.platform === 'win32';
 
+const semverVersionsMapping = {
+  node: {
+    16: '16.19.0',
+    18: '18.13.0',
+  },
+  python: {
+    '3.8': '3.8.16',
+    '3.9': '3.9.16',
+    '3.10': '3.10.9',
+    '3.11': '3.11.1',
+  },
+};
+
+/**
+ * @typedef {Object} Runtime
+ * @property {string} language
+ * @property {boolean} isRuntimeAvailable
+ * @property {string} packageManager
+ * @property {string} version
+ * @property {string} semver
+ */
 export const resolveAppRuntime = (opts) => {
   if (opts.appType === APP_TYPES.UI) {
     const version = '16';
@@ -62,6 +83,7 @@ export const resolveAppRuntime = (opts) => {
       isRuntimeAvailable: checkNodeVersion(version),
       packageManager: opts.packageManager,
       version,
+      semver: semverVersionsMapping.node[version],
     };
   }
 
@@ -73,6 +95,7 @@ export const resolveAppRuntime = (opts) => {
       isRuntimeAvailable: checkNodeVersion(version),
       packageManager: opts.packageManager,
       version,
+      semver: semverVersionsMapping.node[version],
     };
   }
 
@@ -86,5 +109,6 @@ export const resolveAppRuntime = (opts) => {
         : checkCliVersion('python3', version),
     packageManager: 'pip',
     version,
+    semver: semverVersionsMapping.python[version],
   };
 };

package/lib/main.js

@@ -410,7 +410,7 @@ async function addTemplate(root, manifest, runtime) {
   logger.log(chalk.green('Copying app template...'));
   logger.log();
 
-  const templateFolder = path.resolve(__dirname, '..', 'templates', runtime.language, manifest.type);
+  const templateFolder = path.resolve(__dirname, '..', 'templates', manifest.templateName, runtime.language);
 
   utils.copyFolderRecursiveSync(templateFolder, root);
 
@@ -450,13 +450,24 @@ async function configureApp(root, manifest, runtime) {
     await addTsConfigs(root, manifest, runtime);
   }
 
-  if (manifest.isPython() && manifest.isScheduler()) {
-    patchSchedulerForPython(root, manifest, runtime);
+  if (manifest.isPython()) {
+    await addPythonConfigs(root, manifest, runtime);
   }
 }
 
 const addNvmRc = async (root, manifest, runtime) => {
-  await fs.outputFile(path.join(root, '.nvmrc'), `${runtime.version}\n`);
+  await fs.outputFile(path.join(root, '.nvmrc'), `${runtime.semver}\n`);
+};
+
+/**
+ *
+ * @param {string} root
+ * @param {Manifest} manifest
+ * @param {import('./helpers/resolve-app-runtime.js').Runtime} runtime
+ */
+const addPythonConfigs = async (root, manifest, runtime) => {
+  await fs.writeFile(path.resolve(root, '.python-version'), `${runtime.semver}\n`);
+  await fs.writeFile(path.resolve(root, '.python-virtualenv'), `${manifest.unix_name}\n`);
 };
 
 const addTsConfigs = (root, manifest, runtime) => {
@@ -471,6 +482,7 @@ const addTsConfigs = (root, manifest, runtime) => {
         extends: `@tsconfig/node${runtime.version}/tsconfig.json`,
         compilerOptions: {
           inlineSourceMap: true,
+          strict: false,
         },
       },
       writejsonOptions,
@@ -487,46 +499,39 @@ const addTsConfigs = (root, manifest, runtime) => {
   ]);
 };
 
-function patchSchedulerForPython(root, manifest, runtime) {
-  const schedulerType = manifest.manifest.settings.app.scheduler_type;
-
-  if (schedulerType === manifestConstants.SCHEDULER_TYPE_DATA_TIME.value) {
-    return;
-  }
-
-  const templateFolder = path.resolve(__dirname, '..', 'templates', runtime.language, manifest.type);
-  const originalType = 'ScheduledDataTimeEvent';
-  const replacementType =
-    schedulerType === manifestConstants.SCHEDULER_TYPE_DEPTH.value
-      ? 'ScheduledDepthEvent'
-      : 'ScheduledNaturalTimeEvent';
-  const patchedCode = fs
-    .readFileSync(path.join(templateFolder, 'lambda_function.py'), 'utf-8')
-    .replace(new RegExp(originalType, 'g'), replacementType);
-
-  fs.writeFileSync(path.join(root, 'lambda_function.py'), patchedCode);
-}
-
 /**
  *
  * @param {string} root
  * @param {import('./flows/lib/manifest').Manifest} manifest
  */
 function addPackageJSON(root, manifest, runtime) {
-  const defaults = getDefaultsForPackageJson(manifest, runtime);
+  const {
+    version,
+    description,
+    scripts,
+    dependencies,
+    devDependencies,
+    main,
+    license = 'UNLICENSED',
+    private: isPrivate = true,
+    ...rest
+  } = getDefaultsForPackageJson(manifest, runtime);
 
   const packageJson = {
     name: manifest.unix_name,
-    version: defaults.version,
-    description: manifest.description || defaults.description,
+    version,
+    description: manifest.description || description,
+    main,
+    private: isPrivate,
+    license,
     engines: {
       node: `^${runtime.version}`,
       [runtime.packageManager]: '*',
     },
-    scripts: defaults.scripts,
-    dependencies: defaults.dependencies,
-    devDependencies: defaults.devDependencies,
-    ...(defaults.jest && { jest: defaults.jest }),
+    scripts,
+    dependencies,
+    devDependencies,
+    ...rest,
   };
 
   return fs.writeJSON(path.join(root, 'package.json'), packageJson, writejsonOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corva/create-app",
-  "version": "0.48.0-0",
+  "version": "0.48.0-1",
   "private": false,
   "description": "Create an app to use it in CORVA.AI",
   "keywords": [
@@ -67,6 +67,7 @@
     "@commitlint/config-conventional": "^17.3.0",
     "@corva/eslint-config-browser": "^0.1.7",
     "@corva/eslint-config-node": "^5.1.1",
+    "@corva/node-sdk": "^8.0.1",
     "@types/cross-spawn": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",

package/templates/scheduler_data-time/javascript/__test__/processor.spec.js

@@ -0,0 +1,15 @@
+const { ScheduledDataTimeEvent } = require('@corva/node-sdk');
+const { app_runner } = require('@corva/node-sdk/lib/testing');
+
+const { processor } = require('..');
+
+test('processes event', async () => {
+  const event = new ScheduledDataTimeEvent({
+    company_id: 1,
+    asset_id: 1234,
+    start_time: 1578291000,
+    end_time: 1578291300,
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/scheduler_data-time/javascript/index.js

@@ -0,0 +1,15 @@
+const { Corva } = require('@corva/node-sdk');
+
+/**
+ *
+ * @param {import('@corva/node-sdk').ScheduledDataTimeEvent} event
+ * @param {import('@corva/node-sdk').StatefulContext} context
+ */
+const processor = async (event, context) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+exports.processor = processor;
+
+exports.handler = new Corva().scheduled(processor);

package/templates/scheduler_data-time/typescript/__test__/processor.spec.ts

@@ -0,0 +1,15 @@
+import { app_runner } from '@corva/node-sdk/lib/testing';
+import { ScheduledDataTimeEvent } from '@corva/node-sdk';
+
+import { processor } from '..';
+
+test('processes event', async () => {
+  const event = new ScheduledDataTimeEvent({
+    company_id: 1,
+    asset_id: 1234,
+    start_time: 1578291000,
+    end_time: 1578291300,
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/scheduler_data-time/typescript/index.ts

@@ -0,0 +1,8 @@
+import { Corva, ScheduledDataTimeEvent, StatefulContext } from '@corva/node-sdk';
+
+export const processor = async (event: ScheduledDataTimeEvent, context: StatefulContext) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+export const handler = new Corva().scheduled(processor);

package/templates/scheduler_depth/javascript/README.md

@@ -0,0 +1,19 @@
+# Dev Center Node.js Polling Scheduler Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/scheduler_depth/javascript/__test__/processor.spec.js

@@ -0,0 +1,17 @@
+const { ScheduledDepthEvent } = require('@corva/node-sdk');
+const { app_runner } = require('@corva/node-sdk/lib/testing');
+
+const { processor } = require('..');
+
+test('processes event', async () => {
+  const event = new ScheduledDepthEvent({
+    company_id: 1,
+    asset_id: 1234,
+    top_depth: 0,
+    bottom_depth: 1,
+    log_identifier: '5701c048cf9a',
+    interval: 1,
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/scheduler_depth/javascript/index.js

@@ -0,0 +1,15 @@
+const { Corva } = require('@corva/node-sdk');
+
+/**
+ *
+ * @param {import('@corva/node-sdk').ScheduledDepthEvent} event
+ * @param {import('@corva/node-sdk').StatefulContext} context
+ */
+const processor = async (event, context) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+exports.processor = processor;
+
+exports.handler = new Corva().scheduled(processor);

package/templates/scheduler_depth/python/README.md

@@ -0,0 +1,31 @@
+# Dev Center Python Polling Scheduler Data App
+
+## Getting started
+
+[Python SDK Documentation](https://corva-ai.github.io/python-sdk)
+
+### 1. Install
+
+You need to have `make` installed:
+
+- Windows: [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install)
+- OS X: [Command Line Tools for Xcode](https://developer.apple.com/download/more/)
+- Linux: refer to your distro-specific docs
+
+To install dependencies run:
+
+```sh
+make
+```
+
+### 2. Run Tests
+
+```sh
+make test
+```
+
+### 3. Create app zip
+
+```sh
+make bundle
+```

package/templates/scheduler_depth/python/lambda_function.py

@@ -0,0 +1,7 @@
+from corva import Api, Cache, Logger, ScheduledDepthEvent, scheduled
+
+
+@scheduled
+def lambda_handler(event: ScheduledDepthEvent, api: Api, cache: Cache):
+    """Insert your logic here"""
+    Logger.info('Hello, World!')

package/templates/scheduler_depth/python/test/app_test.py

@@ -0,0 +1,10 @@
+from corva import ScheduledDepthEvent
+from lambda_function import lambda_handler
+
+
+def test_app(app_runner):
+    event = ScheduledDepthEvent(
+        company_id=1, asset_id=1234, top_depth=0, bottom_depth=1, log_identifier="log_identifier", interval=1
+    )
+
+    app_runner(lambda_handler, event=event)

package/templates/scheduler_depth/typescript/README.md

@@ -0,0 +1,25 @@
+# Dev Center Node.js TypeScript Polling Scheduler Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Build
+
+```
+npm run build
+```
+
+### 4. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/scheduler_depth/typescript/__test__/processor.spec.ts

@@ -0,0 +1,17 @@
+import { app_runner } from '@corva/node-sdk/lib/testing';
+import { ScheduledDepthEvent } from '@corva/node-sdk';
+
+import { processor } from '..';
+
+test('processes event', async () => {
+  const event = new ScheduledDepthEvent({
+    company_id: 1,
+    asset_id: 1234,
+    top_depth: 0,
+    bottom_depth: 1,
+    log_identifier: '5701c048cf9a',
+    interval: 1,
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});

package/templates/scheduler_depth/typescript/index.ts

@@ -0,0 +1,8 @@
+import { Corva, ScheduledDepthEvent, StatefulContext } from '@corva/node-sdk';
+
+export const processor = async (event: ScheduledDepthEvent, context: StatefulContext) => {
+  // Insert your logic here
+  context.logger.info('Hello, World!');
+};
+
+export const handler = new Corva().scheduled(processor);

package/templates/scheduler_natural-time/javascript/README.md

@@ -0,0 +1,19 @@
+# Dev Center Node.js Polling Scheduler Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/templates/scheduler_natural-time/javascript/__test__/processor.spec.js

@@ -0,0 +1,15 @@
+const { ScheduledNaturalTimeEvent } = require('@corva/node-sdk');
+const { app_runner } = require('@corva/node-sdk/lib/testing');
+
+const { processor } = require('..');
+
+test('processes event', async () => {
+  const event = new ScheduledNaturalTimeEvent({
+    company_id: 1,
+    asset_id: 1234,
+    schedule_start: 1578291000,
+    interval: 60,
+  });
+
+  expect(await app_runner(processor, event)).toBeUndefined();
+});