@corva/create-app 0.16.0-rc.0 → 0.17.0-rc.0

package/CHANGELOG.md

@@ -2,7 +2,33 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [0.16.0-rc.0](https://github.com/corva-ai/create-corva-app/compare/v0.16.0-1...v0.16.0-rc.0) (2021-11-23)
+## [0.17.0-rc.0](https://github.com/corva-ai/create-corva-app/compare/v0.17.0-2...v0.17.0-rc.0) (2021-12-08)
+
+## [0.17.0-2](https://github.com/corva-ai/create-corva-app/compare/v0.17.0-0...v0.17.0-2) (2021-12-07)
+
+
+### Features
+
+* add scheduler type option ([e2d3d3d](https://github.com/corva-ai/create-corva-app/commit/e2d3d3dcc7154d841b3da342a36a7edfbc8488e4))
+
+
+### Bug Fixes
+
+* diff app types, runtimes and templates ([7c52817](https://github.com/corva-ai/create-corva-app/commit/7c528173535b9a915372ec469df8043b3830e387))
+
+## [0.17.0-1](https://github.com/corva-ai/create-corva-app/compare/v0.17.0-0...v0.17.0-1) (2021-12-03)
+
+
+### Features
+
+* add scheduler type option ([e2d3d3d](https://github.com/corva-ai/create-corva-app/commit/e2d3d3dcc7154d841b3da342a36a7edfbc8488e4))
+
+
+### Bug Fixes
+
+* diff app types, runtimes and templates ([7c52817](https://github.com/corva-ai/create-corva-app/commit/7c528173535b9a915372ec469df8043b3830e387))
+
+## [0.17.0-0](https://github.com/corva-ai/create-corva-app/compare/v0.16.0-1...v0.17.0-0) (2021-11-23)
 
 ## [0.16.0-1](https://github.com/corva-ai/create-corva-app/compare/v0.16.0-0...v0.16.0-1) (2021-11-18)
 

package/constants/cli.js

@@ -0,0 +1,26 @@
+const APP_RUNTIMES = {
+  UI: 'ui',
+  NODE12: 'nodejs12.x',
+  PYTHON3: 'python3.8',
+};
+
+const TEMPLATE_TYPES = {
+  UI: 'js',
+  UI_TS: 'ts',
+  NODE: 'node',
+  NODE_TYPESCRIPT: 'node-ts',
+  PYTHON: 'python',
+};
+
+const APP_TYPES = {
+  UI: 'ui',
+  SCHEDULER: 'scheduler',
+  STREAM: 'stream',
+  TASK: 'task',
+};
+
+module.exports = {
+  TEMPLATE_TYPES,
+  APP_RUNTIMES,
+  APP_TYPES,
+};

package/constants/manifest.js

@@ -1,3 +1,5 @@
+const { APP_RUNTIMES, APP_TYPES, TEMPLATE_TYPES } = require('./cli');
+
 const defaultManifest = {
   format: 1,
   license: {
@@ -10,7 +12,7 @@ const defaultManifest = {
     authors: [],
   },
   application: {
-    type: 'ui',
+    type: APP_TYPES.UI,
     key: 'app.key-goes-here',
     visibility: 'private',
     name: 'Name of My App',
@@ -68,16 +70,41 @@ const defaultDataAppPythonManifest = {
 };
 
 const defaultTimeSchedulerSettings = {
-  scheduler_type: 'data_time',
   cron_string: '*/5 * * * *',
 };
 
 const defaultDepthSchedulerSettings = {
-  scheduler_type: 'data_depth',
   depth_milestone: 1,
 };
 
-const MANIFEST_MANDATORY_KEYS = ['appType', 'appKey', 'appName', 'category', 'segments', 'runtime'];
+const getManifestMandatoryKeys = (opts) => {
+  const keys = manifestOptions(opts.projectName).reduce((acc, option) => {
+    if (option.required) {
+      acc.push(option.name);
+    }
+
+    return acc;
+  }, []);
+
+  const { appType } = opts;
+
+  if (appType) {
+    if (appType !== APP_TYPES.UI) {
+      keys.push('runtime');
+    }
+
+    if (appType === APP_TYPES.SCHEDULER) {
+      keys.push('schedulerType');
+      keys.push('cronString');
+    }
+  }
+
+  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 };
 
 const manifestOptions = (projectName) => [
   { name: 'developerName', message: 'Enter the Developer Name', default: 'O&G Company' },
@@ -86,11 +113,36 @@ const manifestOptions = (projectName) => [
     type: 'rawlist',
     name: 'appType',
     message: 'Choose the App Type',
-    default: 'ui',
-    choices: ['ui', 'scheduler', 'stream', 'task'],
+    default: APP_TYPES.UI,
+    choices: Object.values(APP_TYPES),
+    required: true,
+  },
+  {
+    type: 'rawlist',
+    name: 'schedulerType',
+    message: 'Choose the scheduler type',
+    default: SCHEDULER_TYPE_NATURAL_TIME.value,
+    choices: [SCHEDULER_TYPE_NATURAL_TIME, SCHEDULER_TYPE_DATA_TIME, SCHEDULER_TYPE_DEPTH],
+    when: (answers) => answers.appType === APP_TYPES.SCHEDULER,
+  },
+  {
+    name: 'cronString',
+    message: 'Provide CRON string for the scheduler',
+    default: '*/5 * * * *',
+    when: (answers) => answers.appType === APP_TYPES.SCHEDULER,
+  },
+  {
+    name: 'appKey',
+    message: 'Enter the App Key',
+    default: 'app.key-goes-here',
+    required: true,
+  },
+  {
+    name: 'appName',
+    message: 'Enter the App Name',
+    default: projectName,
+    required: true,
   },
-  { name: 'appKey', message: 'Enter the App Key', default: 'app.key-goes-here' },
-  { name: 'appName', message: 'Enter the App Name', default: projectName },
   {
     name: 'description',
     message: 'Enter description',
@@ -101,20 +153,32 @@ const manifestOptions = (projectName) => [
     message: 'Enter summary',
     default: 'More information about this app goes here',
   },
-  { name: 'category', message: 'Enter category', default: '' },
+  {
+    name: 'category',
+    message: 'Enter category',
+    default: '',
+    required: true,
+  },
   { name: 'website', message: 'Enter website', default: 'https://www.oandgexample.com/my-app/' },
   {
     type: 'rawlist',
     name: 'segments',
     message: 'Choose segments',
     choices: ['drilling', 'completion'],
+    required: true,
   },
   {
     type: 'rawlist',
     name: 'runtime',
     message: 'Choose runtime',
-    choices: ['python3.8', 'nodejs12.x'],
-    when: (answers) => answers.appType !== 'ui',
+    choices: (answers) => {
+      if (answers && answers.appType !== APP_TYPES.UI) {
+        return Object.values(APP_RUNTIMES).filter((value) => value !== APP_RUNTIMES.UI);
+      }
+
+      return Object.values(APP_RUNTIMES);
+    },
+    when: (answers) => answers.appType !== APP_TYPES.UI,
   },
   {
     type: 'rawlist',
@@ -122,7 +186,7 @@ const manifestOptions = (projectName) => [
     message: 'Please select the desired package manager',
     default: 'yarn',
     choices: ['yarn', 'npm'],
-    when: (answers) => !answers.runtime || !answers.runtime.startsWith('python'),
+    when: (answers) => !answers.runtime || !answers.runtime.startsWith(TEMPLATE_TYPES.PYTHON),
   },
   {
     type: 'confirm',
@@ -130,14 +194,8 @@ const manifestOptions = (projectName) => [
     message: 'Would you like to use TypesScript?',
     default: false,
     when: (answers) =>
-      (answers.runtime && answers.runtime.startsWith('nodejs')) || answers.appType === 'ui',
-  },
-  {
-    type: 'rawlist',
-    name: 'schedulerType',
-    message: 'Choose schedulerType',
-    choices: ['data_time', 'data_depth', 'natural_time'],
-    when: (answers) => answers.appType === 'scheduler',
+      (answers.runtime && answers.runtime.startsWith(TEMPLATE_TYPES.NODE)) ||
+      answers.appType === APP_TYPES.UI,
   },
 ];
 
@@ -149,5 +207,8 @@ module.exports = {
   defaultTimeSchedulerSettings,
   defaultDepthSchedulerSettings,
   manifestOptions,
-  MANIFEST_MANDATORY_KEYS,
+  getManifestMandatoryKeys,
+  SCHEDULER_TYPE_NATURAL_TIME,
+  SCHEDULER_TYPE_DATA_TIME,
+  SCHEDULER_TYPE_DEPTH,
 };

package/constants/package.js

@@ -24,8 +24,8 @@ const dependencies = {
 
 const tsDependencies = {
   devDependencies: {
-    "@tsconfig/create-react-app": "1.0.2",
-    "@types/material-ui": "0.21.9",
+    '@tsconfig/create-react-app': '1.0.2',
+    '@types/material-ui': '0.21.9',
     '@types/react': '^17.0.22',
     '@types/react-dom': '^17.0.9',
     '@typescript-eslint/eslint-plugin': '^4.31.2',

package/helpers/manifest.js

@@ -1,7 +1,8 @@
+const { APP_RUNTIMES, APP_TYPES, TEMPLATE_TYPES } = require('../constants/cli.js');
 const manifestConstants = require('../constants/manifest.js');
 
 function fillManifest(answers) {
-  const runtime = answers.runtime || 'ui';
+  const runtime = answers.runtime || APP_RUNTIMES.UI;
 
   const defaultManifestProperties = _defaultManifestProperties({
     type: answers.appType,
@@ -33,7 +34,11 @@ function fillManifest(answers) {
     settings: {
       ...defaultManifestProperties.settings,
       runtime,
-      ...defaultAppSettings({ type: answers.appType, schedulerType: answers.schedulerType }),
+      ...defaultAppSettings({
+        type: answers.appType,
+        schedulerType: answers.schedulerType,
+        cronString: answers.cronString,
+      }),
     },
   };
 
@@ -41,31 +46,32 @@ function fillManifest(answers) {
 }
 
 function _defaultManifestProperties({ type, runtime }) {
-  if (type === 'ui') {
+  if (type === APP_TYPES.UI) {
     return manifestConstants.defaultUIAppManifest;
   }
 
-  if (runtime.match(/python/)) {
+  if (runtime.startsWith(TEMPLATE_TYPES.PYTHON)) {
     return manifestConstants.defaultDataAppPythonManifest;
   }
 
   return manifestConstants.defaultDataAppNodeManifest;
 }
 
-function defaultAppSettings({ type, schedulerType }) {
+function defaultAppSettings({ type, schedulerType, cronString }) {
   if (!schedulerType) {
     return {};
   }
 
   const schedulerAppSettings =
-    schedulerType == 'data_depth'
+    schedulerType === manifestConstants.SCHEDULER_TYPE_DEPTH.value
       ? manifestConstants.defaultDepthSchedulerSettings
       : manifestConstants.defaultTimeSchedulerSettings;
 
   return {
     app: {
       ...schedulerAppSettings,
-      scheduler_type: schedulerType || 'data_time',
+      scheduler_type: schedulerType,
+      cron_string: cronString,
     },
   };
 }

package/index.js

@@ -23,6 +23,7 @@ const manifestConstants = require('./constants/manifest.js');
 const packageJson = require('./package.json');
 const { clear } = require('console');
 const spawn = require('cross-spawn');
+const { APP_RUNTIMES, TEMPLATE_TYPES, APP_TYPES } = require('./constants/cli');
 
 const YARN_EXECUTABLE = 'yarn';
 
@@ -38,11 +39,6 @@ clear();
 let projectName;
 let program;
 
-const APP_TYPES = {
-  UI: 'ui',
-  NODE: 'node',
-};
-
 function startingMessage() {
   console.log(chalk.green('   Welcome to apps generator for:'));
   console.log(chalk.cyan(figlet.textSync('CORVA.AI', { horizontalLayout: 'full' })));
@@ -55,7 +51,7 @@ function checkNodeVersion() {
     console.log(
       chalk.red(
         `You are using Node ${process.version}.\n\n` +
-          `Please update to Node 10 or higher for a better, fully supported experience.\n`
+        `Please update to Node 10 or higher for a better, fully supported experience.\n`
       )
     );
     // Fall back to latest supported react-scripts on Node 4
@@ -67,7 +63,7 @@ function checkOptions(opts) {
   let isValid = true;
   const values = {};
 
-  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach((key) => {
+  manifestConstants.getManifestMandatoryKeys(opts).forEach((key) => {
     if (!opts[key]) {
       isValid = false;
     }
@@ -92,15 +88,31 @@ async function initialChecks() {
       projectName = name;
     })
     .option('-z, --zip <type>', 'zip app source')
-    .option('-t, --useTypescript', 'use typescript or javascript', false)
     .addOption(
-      new commander.Option(`-p, --packageManager <value>`, 'package manager to use')
+      new commander.Option(`-p, --packageManager [string]`, 'package manager to use')
         .default(YARN_EXECUTABLE)
         .choices(['npm', YARN_EXECUTABLE])
     );
 
-  manifestConstants.MANIFEST_MANDATORY_KEYS.forEach((key) => {
-    program.option(`--${key} [value]`);
+  manifestConstants.manifestOptions(projectName).forEach((value) => {
+    const type = typeof value.default;
+    const option = new commander.Option(`--${value.name} [${type !== 'undefined' && type || 'string'}]`, value.message);
+
+    if (value.choices) {
+      if (typeof value.choices === 'function') {
+        option.choices(value.choices());
+      } else {
+        option.choices(
+          value.choices.map((choice) => `${typeof choice === 'object' ? choice.value : choice}`)
+        );
+      }
+    }
+
+    if (type === 'number') {
+      option.argParser(Number)
+    }
+
+    program.addOption(option);
   });
 
   program.parse(process.argv);
@@ -113,7 +125,7 @@ async function initialChecks() {
   useTypescript = opts.useTypescript || useTypescript;
 
   if (opts.zip) {
-    if (opts.zip === APP_TYPES.UI) {
+    if (opts.zip === APP_RUNTIMES.UI) {
       return uiScripts.zipAppSource(shouldUseYarn());
     }
 
@@ -137,7 +149,9 @@ async function initialChecks() {
 
 async function initPackage(manifest) {
   const appType = manifest.application.type;
-  if (appType === APP_TYPES.UI) await ensureLatestVersion();
+  if (appType === APP_TYPES.UI) {
+    await ensureLatestVersion();
+  }
 
   const root = path.resolve(projectName);
 
@@ -153,17 +167,13 @@ async function initPackage(manifest) {
   // config for every possible version at this point, so just consolidate all versions of a runtime into a single
   // template directory.
   if (appType !== APP_TYPES.UI) {
-    if (runtime.startsWith('python')) {
-      runtime = 'python';
-    } else if (runtime.startsWith('nodejs')) {
-      runtime = 'node';
-
-      if (useTypescript) {
-        runtime += '-ts';
-      }
+    if (runtime.startsWith(TEMPLATE_TYPES.PYTHON)) {
+      runtime = TEMPLATE_TYPES.PYTHON;
+    } else {
+      runtime = useTypescript ? TEMPLATE_TYPES.NODE_TYPESCRIPT : TEMPLATE_TYPES.NODE;
     }
-  } else if (appType === APP_TYPES.UI) {
-    runtime = useTypescript ? 'ts' : 'js';
+  } else {
+    runtime = useTypescript ? TEMPLATE_TYPES.UI_TS : TEMPLATE_TYPES.UI;
   }
 
   addTemplate(root, appType, runtime);
@@ -185,7 +195,7 @@ async function createApp(opts) {
   } else {
     console.log('Please fill your app Metadata');
 
-    inquirer.prompt(manifestConstants.manifestOptions(projectName)).then((answers) => {
+    inquirer.prompt(manifestConstants.manifestOptions(projectName), opts).then((answers) => {
       packageManager = answers.packageManager || packageManager;
       useTypescript = answers.useTypescript || useTypescript;
 
@@ -222,15 +232,39 @@ function addTemplate(root, appType, runtime) {
 function configureApp(root, appType, runtime, manifest) {
   if (appType === APP_TYPES.UI) {
     addPackageJSON(root, manifest.application.name);
-  } else if (runtime.startsWith(APP_TYPES.NODE)) {
+  } else if (runtime.startsWith(TEMPLATE_TYPES.NODE)) {
     updatePackageJSON(root, manifest.application.description, appType, runtime);
   }
+
+  if (runtime.startsWith(TEMPLATE_TYPES.PYTHON) && appType === APP_TYPES.SCHEDULER) {
+    patchSchedulerForPython(root, appType, runtime, manifest);
+  }
+}
+
+function patchSchedulerForPython(root, appType, runtime, manifest) {
+  const schedulerType = manifest.settings.app.scheduler_type;
+
+  if (schedulerType === manifestConstants.SCHEDULER_TYPE_DATA_TIME.value) {
+    return;
+  }
+
+  const templateFolder = path.resolve(__dirname, 'template', appType, runtime);
+  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);
 }
 
 function addPackageJSON(root, appName) {
   const devDependencies = {
     ...packageConstants.dependencies.devDependencies,
-    ...(useTypescript && packageConstants.tsDependencies.devDependencies)
+    ...(useTypescript && packageConstants.tsDependencies.devDependencies),
   };
   const packageJson = {
     name: appName.replace(/\W/g, ''),
@@ -262,7 +296,7 @@ function updatePackageJSON(root, description, appType, runtime) {
 
 function installApp(appPath, appType, runtime) {
   switch (runtime) {
-    case 'python': {
+    case TEMPLATE_TYPES.PYTHON: {
       break;
     }
     default: {
@@ -302,7 +336,7 @@ function installJsApp(appPath, appType) {
   console.log();
   console.log(`Success! Created ${projectName} at ${appPath}`);
 
-  if (appType === APP_TYPES.UI) {
+  if (appType === APP_RUNTIMES.UI) {
     console.log('Inside that directory, you can run several commands:');
     helpCommands();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@corva/create-app",
-    "version": "0.16.0-rc.0",
+    "version": "0.17.0-rc.0",
     "private": false,
     "description": "Create app to use it in CORVA.AI",
     "keywords": [

package/scripts/ui/zipAppSource.js

@@ -85,9 +85,12 @@ async function compressAppToZip(useYarn) {
     name: 'package.json',
   });
 
-  ['manifest.json', 'config-overrides.js', 'tsconfig.json', useYarn ? 'yarn.lock' : 'package-lock.json'].forEach(
-    (name) => archive.file(path.resolve(dirname, name), { name })
-  );
+  [
+    'manifest.json',
+    'config-overrides.js',
+    'tsconfig.json',
+    useYarn ? 'yarn.lock' : 'package-lock.json',
+  ].forEach((name) => archive.file(path.resolve(dirname, name), { name }));
 
   archive.directory(path.resolve(dirname, 'src'), 'src');