feat(cubejs-cli): Run dev-server/server commands from @cubejs-backend/core

Author: ovr

packages/cubejs-cli/package.json

@@ -39,11 +39,13 @@
     "node-fetch": "^2.6.0",
     "node-machine-id": "^1.1.10",
     "request": "^2.88.2",
-    "request-promise": "^4.2.5"
+    "request-promise": "^4.2.5",
+    "semver": "^7.3.2"
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.2",
     "@types/node": "^14.11.10",
+    "@types/semver": "^7.3.4",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^13.1.0",
     "eslint-plugin-import": "^2.16.0",

packages/cubejs-cli/src/cli.js

@@ -14,14 +14,22 @@ import inquirer from 'inquirer';
 
 import { configureDevServerCommand } from './command/dev-server';
 import { configureServerCommand } from './command/server';
-import { executeCommand, npmInstall, writePackageJson, requireFromPackage, event, displayError } from './utils';
+import {
+  executeCommand,
+  npmInstall,
+  writePackageJson,
+  requireFromPackage,
+  event,
+  displayError,
+  loadCliManifest,
+} from './utils';
 
 const Config = require('./config');
 const templates = require('./templates');
 const { deploy } = require('./deploy');
 const { token, defaultExpiry, collect } = require('./token');
 
-const packageJson = require('../package.json');
+const packageJson = loadCliManifest();
 
 program.name(Object.keys(packageJson.bin)[0])
   .version(packageJson.version);

packages/cubejs-cli/src/command/proxy-command.ts

@@ -1,6 +1,7 @@
 import { CommanderStatic } from 'commander';
-import { displayError, packageExists, requireFromPackage } from '../utils';
+import { displayError, loadCliManifest, packageExists, requireFromPackage, requirePackageManifest } from '../utils';
 import chalk from 'chalk';
+import semver from 'semver';
 
 export async function proxyCommand(program: CommanderStatic, command: string) {
   const serverPackageExists = packageExists('@cubejs-backend/server');
@@ -9,24 +10,60 @@ export async function proxyCommand(program: CommanderStatic, command: string) {
     .command(command);
 
   if (serverPackageExists) {
-    const OriginalCommandPackage = await requireFromPackage(`@cubejs-backend/server/dist/command/${command}`);
-    // eslint-disable-next-line new-cap
-    const Command = new OriginalCommandPackage.default([]);
+    const PackageManifiest = await requirePackageManifest('@cubejs-backend/server');
+
+    if (PackageManifiest.cubejsCliVersion) {
+      const cliManifiest = loadCliManifest();
+      if (semver.satisfies(cliManifiest.version, PackageManifiest.cubejsCliVersion)) {
+        const OriginalCommandPackage = await requireFromPackage(
+          `@cubejs-backend/server/dist/command/${command}`
+        );
+        // eslint-disable-next-line new-cap
+        const Command = new OriginalCommandPackage.default([]);
+
+        commandInfo
+          .description(OriginalCommandPackage.default.description)
+          .action(
+            () => Command.run().catch(
+              (e: any) => displayError(e.stack || e.message)
+            )
+          );
+
+        return;
+      }
+
+      const message = `${chalk.red('Unavailable.')} @cubejs-backend/server inside current directory requires ` +
+        `cubejs-cli (${PackageManifiest.cubejsCliVersion}).`;
+
+      commandInfo
+        .description(
+          message
+        )
+        .action(
+          () => displayError(message)
+        );
+
+      return;
+    }
+
+    const message = `${chalk.red('Unavailable.')} Please upgrade @cubejs-backend/server.`;
 
     commandInfo
-      .description(OriginalCommandPackage.default.description)
+      .description(
+        message
+      )
       .action(
-        () => Command.run().catch(
-          (e: any) => displayError(e.stack || e.message)
-        )
+        () => displayError(message)
       );
   } else {
+    const message = `${chalk.red('Unavailable.')} Please run this command from project directory.`;
+
     commandInfo
       .description(
-        chalk.red('Unavailable.') + ' Please run this command from project directory.'
+        message
       )
       .action(
-        () => displayError('Unavailable. Please run this command from project directory.')
+        () => displayError(message)
       );
   }
 

packages/cubejs-cli/src/utils.ts

@@ -84,6 +84,20 @@ export const requiredPackageExists = async (moduleName: string) => {
   }
 };
 
+export const requirePackageManifest = async (moduleName: string) => {
+  await requiredPackageExists(moduleName);
+
+  const modulePath = path.join(process.cwd(), 'node_modules', moduleName);
+
+  if (!fs.pathExistsSync(modulePath) && !fs.pathExistsSync(path.join(modulePath, 'package.json'))) {
+    await displayError(
+      `${moduleName} dependency package.json not found. Please run this command from project directory.`
+    );
+  }
+
+  return require(path.join(modulePath, 'package.json'));
+};
+
 export const requireFromPackage = async (moduleName: string) => {
   await requiredPackageExists(moduleName);
 
@@ -97,3 +111,7 @@ const logStage = async (stage: string, eventName: string, props: any) => {
     await event(eventName, props);
   }
 };
+
+export function loadCliManifest() {
+  return require('../package.json');
+}

packages/cubejs-cli/yarn.lock

@@ -372,6 +372,11 @@
   resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0"
   integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==
 
+"@types/semver@^7.3.4":
+  version "7.3.4"
+  resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.3.4.tgz#43d7168fec6fa0988bb1a513a697b29296721afb"
+  integrity sha512-+nVsLKlcUCeMzD2ufHEYuJ9a2ovstb6Dp52A5VsoKxDXgvE051XgHI/33I1EymwkRGQkwnA0LkhnUzituGs4EQ==
+
 "@types/stack-utils@^1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"
@@ -4221,6 +4226,11 @@ semver@^6.0.0, semver@^6.1.2:
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
   integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
 
+semver@^7.3.2:
+  version "7.3.2"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.2.tgz#604962b052b81ed0786aae84389ffba70ffd3938"
+  integrity sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==
+
 serialize-javascript@3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-3.0.0.tgz#492e489a2d77b7b804ad391a5f5d97870952548e"

packages/cubejs-server/package.json

@@ -23,6 +23,7 @@
   "bin": {
     "cubejs-dev-server": "./bin/dev-server.js"
   },
+  "cubejsCliVersion": "^0.22",
   "scripts": {
     "tsc": "tsc",
     "watch": "tsc -w",