feat(cli): check project deps against cli template

Sometimes a user try to run newer version of `lb4` against existing
applications. This feature will prompt users to confirm if some of
the project deps do not satisify the cli template.

It also checks exit status to avoid unnessary prompts.

Author: raymondfeng

packages/cli/generators/app/index.js

@@ -54,10 +54,12 @@ module.exports = class AppGenerator extends ProjectGenerator {
   }
 
   promptProjectName() {
+    if (this.shouldExit()) return;
     return super.promptProjectName();
   }
 
   promptProjectDir() {
+    if (this.shouldExit()) return;
     return super.promptProjectDir();
   }
 
@@ -83,6 +85,7 @@ module.exports = class AppGenerator extends ProjectGenerator {
   }
 
   promptOptions() {
+    if (this.shouldExit()) return;
     return super.promptOptions();
   }
 

packages/cli/generators/controller/index.js

@@ -66,11 +66,13 @@ module.exports = class ControllerGenerator extends ArtifactGenerator {
   }
 
   promptArtifactName() {
+    if (this.shouldExit()) return;
     return super.promptArtifactName();
   }
 
   promptArtifactType() {
     debug('Prompting for controller type');
+    if (this.shouldExit()) return;
     return this.prompt([
       {
         type: 'list',
@@ -92,6 +94,7 @@ module.exports = class ControllerGenerator extends ArtifactGenerator {
   }
 
   async promptArtifactCrudVars() {
+    if (this.shouldExit()) return;
     if (
       !this.artifactInfo.controllerType ||
       this.artifactInfo.controllerType === ControllerGenerator.BASIC

packages/cli/generators/datasource/index.js

@@ -99,6 +99,7 @@ module.exports = class DataSourceGenerator extends ArtifactGenerator {
    */
   promptConnector() {
     debug('prompting for datasource connector');
+    if (this.shouldExit()) return;
     const prompts = [
       {
         name: 'connector',
@@ -123,6 +124,7 @@ module.exports = class DataSourceGenerator extends ArtifactGenerator {
    * `npm` module name for the connector.
    */
   promptCustomConnectorInfo() {
+    if (this.shouldExit()) return;
     if (this.artifactInfo.connector !== 'other') {
       debug('custom connector option was not selected');
       return;
@@ -149,6 +151,7 @@ module.exports = class DataSourceGenerator extends ArtifactGenerator {
    */
   promptConnectorConfig() {
     debug('prompting for connector config');
+    if (this.shouldExit()) return;
     // Check to make sure connector is from connectors list (not custom)
     const settings =
       (connectors[this.artifactInfo.connector] &&

packages/cli/generators/example/index.js

@@ -54,6 +54,7 @@ module.exports = class extends BaseGenerator {
   _describeExamples() {}
 
   promptExampleName() {
+    if (this.shouldExit()) return;
     if (this.options['example-name']) {
       this.exampleName = this.options['example-name'];
       return;
@@ -80,6 +81,7 @@ module.exports = class extends BaseGenerator {
   }
 
   validateExampleName() {
+    if (this.shouldExit()) return;
     if (this.exampleName in EXAMPLES) return;
     this.exit(
       `Invalid example name: ${this.exampleName}\n` +

packages/cli/generators/model/index.js

@@ -67,6 +67,7 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
 
   // Prompt a user for Model Name
   async promptArtifactName() {
+    if (this.shouldExit()) return;
     await super.promptArtifactName();
     this.artifactInfo.className = utils.toClassName(this.artifactInfo.name);
     this.log();
@@ -77,6 +78,7 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
 
   // Prompt for a Property Name
   async promptPropertyName() {
+    if (this.shouldExit()) return;
     this.log(`Enter an empty property name when done`);
     this.log();
 

packages/cli/generators/openapi/index.js

@@ -46,6 +46,7 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
   }
 
   async askForSpecUrlOrPath() {
+    if (this.shouldExit()) return;
     const prompts = [
       {
         name: 'url',
@@ -64,6 +65,7 @@ module.exports = class OpenApiGenerator extends BaseGenerator {
   }
 
   async loadAndBuildApiSpec() {
+    if (this.shouldExit()) return;
     try {
       const result = await loadAndBuildSpec(this.url, {
         log: this.log,

packages/cli/generators/repository/index.js

@@ -177,7 +177,12 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
     return super.setOptions();
   }
 
+  checkLoopBackProject() {
+    return super.checkLoopBackProject();
+  }
+
   async checkPaths() {
+    if (this.shouldExit()) return;
     // check for datasources
     if (!fs.existsSync(this.artifactInfo.datasourcesDir)) {
       return this.exit(

packages/cli/generators/service/index.js

@@ -58,7 +58,12 @@ module.exports = class ServiceGenerator extends ArtifactGenerator {
     return super.setOptions();
   }
 
+  checkLoopBackProject() {
+    return super.checkLoopBackProject();
+  }
+
   async checkPaths() {
+    if (this.shouldExit()) return;
     // check for datasources
     if (!fs.existsSync(this.artifactInfo.datasourcesDir)) {
       new Error(
@@ -76,6 +81,7 @@ module.exports = class ServiceGenerator extends ArtifactGenerator {
    */
   async promptArtifactName() {
     debug('Prompting for service name');
+    if (this.shouldExit()) return;
 
     if (this.options.name) {
       Object.assign(this.artifactInfo, {name: this.options.name});
@@ -99,6 +105,7 @@ module.exports = class ServiceGenerator extends ArtifactGenerator {
 
   async promptDataSourceName() {
     debug('Prompting for a datasource ');
+    if (this.shouldExit()) return;
     let cmdDatasourceName;
     let datasourcesList;
 
@@ -186,6 +193,7 @@ module.exports = class ServiceGenerator extends ArtifactGenerator {
    * strongly-typed service proxies and corresponding model definitions.
    */
   async inferInterfaces() {
+    if (this.shouldExit()) return;
     let connectorType = utils.getDataSourceConnectorName(
       this.artifactInfo.datasourcesDir,
       this.artifactInfo.dataSourceClass,

packages/cli/lib/base-generator.js

@@ -10,9 +10,8 @@ const chalk = require('chalk');
 const {StatusConflicter, readTextFromStdin} = require('./utils');
 const path = require('path');
 const fs = require('fs');
-const readline = require('readline');
 const debug = require('./debug')('base-generator');
-const assert = require('assert');
+const semver = require('semver');
 
 /**
  * Base Generator for LoopBack 4
@@ -130,17 +129,16 @@ module.exports = class BaseGenerator extends Generator {
    * @param {*} question
    */
   async _getDefaultAnswer(question, answers) {
+    // First check existing answers
+    let defaultVal = answers[question.name];
+    if (defaultVal != null) return defaultVal;
+
+    // Now check the `default` of the prompt
     let def = question.default;
     if (typeof question.default === 'function') {
       def = await question.default(answers);
     }
-    let defaultVal = def;
-
-    if (def == null) {
-      // No `default` is set for the question, check existing answers
-      defaultVal = answers[question.name];
-      if (defaultVal != null) return defaultVal;
-    }
+    defaultVal = def;
 
     if (question.type === 'confirm') {
       return defaultVal != null ? defaultVal : true;
@@ -274,7 +272,7 @@ module.exports = class BaseGenerator extends Generator {
    * keyword 'loopback' under 'keywords' attribute in package.json.
    * 'keywords' is an array
    */
-  checkLoopBackProject() {
+  async checkLoopBackProject() {
     debug('Checking for loopback project');
     if (this.shouldExit()) return false;
     const pkg = this.fs.readJSON(this.destinationPath('package.json'));
@@ -297,8 +295,48 @@ module.exports = class BaseGenerator extends Generator {
           'The command must be run in a LoopBack project.',
       );
       this.exit(err);
+      return;
     }
     this.packageJson = pkg;
+
+    const projectDeps = pkg.dependencies || {};
+    const projectDevDeps = pkg.devDependencies || {};
+
+    const cliPkg = require('../package.json');
+    const templateDeps = cliPkg.config.templateDependencies;
+    const incompatibleDeps = {};
+    for (const d in templateDeps) {
+      const versionRange = projectDeps[d] || projectDevDeps[d];
+      if (!versionRange || semver.intersects(versionRange, templateDeps[d]))
+        continue;
+      incompatibleDeps[d] = [versionRange, templateDeps[d]];
+    }
+
+    if (Object.keys(incompatibleDeps).length === 0) {
+      // No incompatible dependencies
+      return;
+    }
+    this.log(
+      chalk.red(
+        'The project has dependencies with incompatible versions required by the CLI:',
+      ),
+    );
+    for (const d in incompatibleDeps) {
+      this.log(chalk.yellow('- %s: %s (cli %s)'), d, ...incompatibleDeps[d]);
+    }
+    const prompts = [
+      {
+        name: 'ignoreIncompatibleDependencies',
+        message: `Continue to run the command?`,
+        type: 'confirm',
+        default: false,
+      },
+    ];
+    const answers = await this.prompt(prompts);
+    if (answers && answers.ignoreIncompatibleDependencies) {
+      return;
+    }
+    this.exit(new Error('Incompatible dependencies'));
   }
 
   _runNpmScript(projectDir, args) {

packages/cli/test/integration/lib/artifact-generator.js

@@ -85,27 +85,38 @@ module.exports = function(artiGenerator) {
         /No `loopback` keyword found/,
       );
 
-      it('passes if "keywords" maps to "loopback"', () => {
+      testCheckLoopBack(
+        'throws an error if dependencies have incompatible versions',
+        {
+          keywords: ['loopback'],
+          dependencies: {'@loopback/context': '^0.0.0'},
+        },
+        /Incompatible dependencies/,
+      );
+
+      it('passes if "keywords" maps to "loopback"', async () => {
         gen.fs.readJSON.returns({keywords: ['test', 'loopback']});
-        assert.doesNotThrow(() => {
-          gen.checkLoopBackProject();
-        }, Error);
+        await gen.checkLoopBackProject();
       });
 
       function testCheckLoopBack(testName, obj, expected) {
-        it(testName, () => {
+        it(testName, async () => {
           let logs = [];
           gen.log = function(...args) {
             logs = logs.concat(args);
           };
+          gen.prompt = async () => ({
+            ignoreIncompatibleDependencies: false,
+          });
           gen.fs.readJSON.returns(obj);
-          gen.checkLoopBackProject();
+          await gen.checkLoopBackProject();
           assert(gen.exitGeneration instanceof Error);
           assert(gen.exitGeneration.message.match(expected));
           gen.end();
-          assert.deepEqual(logs, [
+          assert.equal(
+            logs[logs.length - 1],
             chalk.red('Generation is aborted:', gen.exitGeneration),
-          ]);
+          );
         });
       }
     });