feat(cubejs-cli): Move helpers to TypeScript

Author: ovr

packages/cubejs-cli/package.json

@@ -12,7 +12,7 @@
     "node": ">=8.11.1"
   },
   "bin": {
-    "cubejs": "src/index.js"
+    "cubejs": "dist/index.js"
   },
   "scripts": {
     "tsc": "tsc",
@@ -42,6 +42,7 @@
     "request-promise": "^4.2.5"
   },
   "devDependencies": {
+    "@types/cross-spawn": "^6.0.2",
     "@types/node": "^14.11.10",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^13.1.0",

packages/cubejs-cli/src/cli.js

@@ -4,48 +4,25 @@ eslint import/no-dynamic-require: 0
 /*
 eslint global-require: 0
  */
+
 const program = require('commander');
 const fs = require('fs-extra');
 const path = require('path');
-const os = require('os');
 const chalk = require('chalk');
-const spawn = require('cross-spawn');
 const crypto = require('crypto');
 const inquirer = require('inquirer');
 
 const Config = require('./config');
 const templates = require('./templates');
 const { deploy } = require('./deploy');
 const { token, defaultExpiry, collect } = require('./token');
-const { requireFromPackage, event, displayError } = require('./utils');
+import { executeCommand, npmInstall, writePackageJson, requireFromPackage, event, displayError } from './utils';
 
 const packageJson = require('../package.json');
 
 program.name(Object.keys(packageJson.bin)[0])
   .version(packageJson.version);
 
-const executeCommand = (command, args) => {
-  const child = spawn(command, args, { stdio: 'inherit' });
-  return new Promise((resolve, reject) => {
-    child.on('close', code => {
-      if (code !== 0) {
-        reject(new Error(`${command} ${args.join(' ')} failed with exit code ${code}`));
-        return;
-      }
-      resolve();
-    });
-  });
-};
-
-const writePackageJson = async (json) => fs.writeJson('package.json', json, {
-  spaces: 2,
-  EOL: os.EOL
-});
-
-const npmInstall = (dependencies, isDev) => executeCommand(
-  'npm', ['install', isDev ? '--save-dev' : '--save'].concat(dependencies)
-);
-
 const logStage = (stage) => {
   console.log(`- ${stage}`);
 };

packages/cubejs-cli/src/index.js

@@ -24,4 +24,4 @@ if (major < 8) {
   process.exit(1);
 }
 
-require('./cubejsCli');
+require('./cli');

packages/cubejs-cli/src/track.js

@@ -0,0 +1,57 @@
+const fetch = require('node-fetch');
+const crypto = require('crypto');
+
+export type BaseEvent = any;
+export type Event = BaseEvent & any;
+
+let flushPromise: Promise<any>|null = null;
+let trackEvents: Array<Event> = [];
+
+const flush = async (toFlush?: Array<Event>, retries: number = 10): Promise<any> => {
+  if (!toFlush) {
+    toFlush = trackEvents;
+    trackEvents = [];
+  }
+
+  if (!toFlush.length) {
+    return;
+  }
+
+  try {
+    const sentAt = new Date().toJSON();
+    const result = await fetch('https://track.cube.dev/track', {
+      method: 'post',
+      body: JSON.stringify(toFlush.map(r => ({ ...r, sentAt }))),
+      headers: { 'Content-Type': 'application/json' },
+    });
+    if (result.status !== 200 && retries > 0) {
+      // eslint-disable-next-line consistent-return
+      return flush(toFlush, retries - 1);
+    }
+
+    // console.log(await result.json());
+  } catch (e) {
+    if (retries > 0) {
+      // eslint-disable-next-line consistent-return
+      return flush(toFlush, retries - 1);
+    }
+    // console.log(e);
+  }
+};
+
+export const track = async (event: BaseEvent) => {
+  trackEvents.push({
+    ...event,
+    id: crypto.randomBytes(16).toString('hex'),
+    clientTimestamp: new Date().toJSON()
+  });
+
+  const currentPromise = (flushPromise || Promise.resolve()).then(() => flush()).then(() => {
+    if (currentPromise === flushPromise) {
+      flushPromise = null;
+    }
+  });
+
+  flushPromise = currentPromise;
+  return flushPromise;
+};

packages/cubejs-cli/src/track.ts

@@ -1,12 +1,39 @@
-const path = require('path');
-const fs = require('fs-extra');
-const { machineIdSync } = require('node-machine-id');
-const chalk = require('chalk');
-const track = require('./track');
+import os from 'os';
+import { spawn } from 'cross-spawn';
+import fs from 'fs-extra';
+import path from 'path';
+import chalk from 'chalk';
+import { machineIdSync } from 'node-machine-id';
+
+import { track } from './track';
+
+export const executeCommand = (command: string, args: string[]) => {
+  const child = spawn(command, args, { stdio: 'inherit' });
+
+  return new Promise((resolve, reject) => {
+    child.on('close', (code: number) => {
+      if (code !== 0) {
+        reject(new Error(`${command} ${args.join(' ')} failed with exit code ${code}`));
+        return;
+      }
+
+      resolve();
+    });
+  });
+};
+
+export const writePackageJson = async (json: any) => fs.writeJson('package.json', json, {
+  spaces: 2,
+  EOL: os.EOL
+});
+
+export const npmInstall = (dependencies: string[], isDev?: boolean) => executeCommand(
+  'npm', ['install', isDev ? '--save-dev' : '--save'].concat(dependencies)
+);
 
 const anonymousId = machineIdSync();
 
-const event = async (name, props) => {
+export const event = async (name: string, props: any) => {
   try {
     await track({
       event: name,
@@ -18,9 +45,7 @@ const event = async (name, props) => {
   }
 };
 
-exports.event = event;
-
-const displayError = async (text, options = {}) => {
+export const displayError = async (text: string, options = {}) => {
   console.error('');
   console.error(chalk.cyan('Cube.js Error ---------------------------------------'));
   console.error('');
@@ -39,27 +64,23 @@ const displayError = async (text, options = {}) => {
   process.exit(1);
 };
 
-exports.displayError = displayError;
-
-exports.requireFromPackage = async (module) => {
+export const requireFromPackage = async (moduleName: string) => {
   if (
-    !(await fs.pathExists(path.join(process.cwd(), 'node_modules', module))) &&
+    !(await fs.pathExists(path.join(process.cwd(), 'node_modules', moduleName))) &&
     !(await fs.pathExists(path.join(process.cwd(), 'node_modules', `${module}.js`)))
   ) {
     await displayError(
-      `${module} dependency not found. Please run this command from project directory.`
+      `${moduleName} dependency not found. Please run this command from project directory.`
     );
   }
 
   // eslint-disable-next-line global-require,import/no-dynamic-require
-  return require(path.join(process.cwd(), 'node_modules', module));
+  return require(path.join(process.cwd(), 'node_modules', moduleName));
 };
 
-const logStage = async (stage, eventName, props) => {
+const logStage = async (stage: string, eventName: string, props: any) => {
   console.log(`- ${stage}`);
   if (eventName) {
     await event(eventName, props);
   }
 };
-
-exports.logStage = logStage;

packages/cubejs-cli/src/utils.js renamed to packages/cubejs-cli/src/utils.ts

@@ -330,6 +330,13 @@
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
   integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==
 
+"@types/cross-spawn@^6.0.2":
+  version "6.0.2"
+  resolved "https://registry.yarnpkg.com/@types/cross-spawn/-/cross-spawn-6.0.2.tgz#168309de311cd30a2b8ae720de6475c2fbf33ac7"
+  integrity sha512-KuwNhp3eza+Rhu8IFI5HUXRP0LIhqH5cAjubUvGXXthh4YYBuP2ntwEX+Cz8GJoZUHlKo247wPWOfA9LYEq4cw==
+  dependencies:
+    "@types/node" "*"
+
 "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0":
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.1.tgz#42995b446db9a48a11a07ec083499a860e9138ff"
@@ -355,7 +362,7 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
   integrity sha1-7ihweulOEdK4J7y+UnC86n8+ce4=
 
-"@types/node@^14.11.10":
+"@types/node@*", "@types/node@^14.11.10":
   version "14.11.10"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.11.10.tgz#8c102aba13bf5253f35146affbf8b26275069bef"
   integrity sha512-yV1nWZPlMFpoXyoknm4S56y2nlTAuFYaJuQtYRAOU7xA/FJ9RY0Xm7QOkaYMMmr8ESdHIuUb6oQgR/0+2NqlyA==