feat(cli): import LB3 models with a custom base class

docs/site/Importing-LB3-models.md

@@ -60,24 +60,6 @@ _The tracking GitHub issue:
 
 Workaround: define relational metadata & navigational properties manually.
 
-### Models inheriting from custom base class
-
-_The tracking GitHub issue:
-[loopback-next#3813](https://github.com/strongloop/loopback-next/issues/3813)_
-
-Models inheriting from application-specific models (including LB3 built-in
-models like `User`) cannot be imported yet.
-
-Workaround:
-
-1. Modify your LB3 model to inherit from `Model`, `PersistedModel` or
-   `KeyValueModel`.
-
-2. Import the model to LB4
-
-3. Update the imported model to inherit for the desired application-specific
-   model.
-
 ### MongoDB's `ObjectID` type
 
 The tracking GitHub issue:

packages/cli/generators/import-lb3-models/index.js

@@ -48,6 +48,10 @@ module.exports = class Lb3ModelImporter extends BaseGenerator {
       this.destinationPath(),
       this.artifactInfo.outDir,
     );
+    this.artifactInfo.modelDir = path.resolve(
+      this.artifactInfo.rootDir,
+      utils.modelsDir,
+    );
     return super.setOptions();
   }
 
@@ -99,6 +103,14 @@ Learn more at https://loopback.io/doc/en/lb4/Importing-LB3-models.html
     this.modelNames = answers.modelNames;
   }
 
+  async loadExistingLb4Models() {
+    debug(`model list dir ${this.artifactInfo.modelDir}`);
+    this.existingLb4ModelNames = await utils.getArtifactList(
+      this.artifactInfo.modelDir,
+      'model',
+    );
+  }
+
   async migrateSelectedModels() {
     if (this.shouldExit()) return;
     this.modelFiles = [];
@@ -136,6 +148,20 @@ Learn more at https://loopback.io/doc/en/lb4/Importing-LB3-models.html
     );
     debug('LB4 model data', templateData);
 
+    if (!templateData.isModelBaseBuiltin) {
+      const baseName = templateData.modelBaseClass;
+      if (
+        !this.existingLb4ModelNames.includes(baseName) &&
+        !this.modelNames.includes(baseName)
+      ) {
+        this.log(
+          'Adding %s (base of %s) to the list of imported models.',
+          chalk.yellow(baseName),
+          chalk.yellow(name),
+        );
+        this.modelNames.push(baseName);
+      }
+    }
     const fileName = utils.getModelFileName(name);
     const fullTargetPath = path.resolve(this.artifactInfo.relPath, fileName);
     debug('Model %s output file', name, fullTargetPath);

packages/cli/generators/import-lb3-models/migrate-model.js

@@ -17,6 +17,7 @@ const {
   findBuiltinType,
 } = require('../model/property-definition');
 const chalk = require('chalk');
+const {isDeepStrictEqual} = require('util');
 
 module.exports = {
   importLb3ModelDefinition,
@@ -43,12 +44,29 @@ function importLb3ModelDefinition(modelCtor, log) {
 
   logNamingIssues(modelName, log);
 
+  const baseDefinition = modelCtor.base.definition;
+  const baseProps = {...baseDefinition.properties};
+
+  // Core LB3 models like PersistedModel come with an id property that's
+  // injected by juggler. We don't want to inherit that property, because
+  // in LB4, we want models to define the id property explicitly.
+  if (isCoreModel(modelCtor.base)) {
+    delete baseProps.id;
+  }
+
   const templateData = {
     name: modelName,
     className: pascalCase(modelName),
     ...migrateBaseClass(modelCtor.settings.base),
-    properties: migrateModelProperties(modelCtor.definition.properties),
-    settings: migrateModelSettings(modelCtor.definition.settings, log),
+    properties: migrateModelProperties(
+      modelCtor.definition.properties,
+      baseProps,
+    ),
+    settings: migrateModelSettings(
+      modelCtor.definition.settings,
+      baseDefinition.settings,
+      log,
+    ),
   };
 
   const settings = templateData.settings;
@@ -59,7 +77,7 @@ function importLb3ModelDefinition(modelCtor, log) {
   return templateData;
 }
 
-function migrateModelProperties(properties) {
+function migrateModelProperties(properties = {}, inherited = {}) {
   const templateData = {};
 
   // In LB 3.x, primary keys are typically contributed by connectors later in
@@ -72,7 +90,16 @@ function migrateModelProperties(properties) {
     });
 
   for (const prop in properties) {
-    const def = migratePropertyDefinition(properties[prop]);
+    const propDef = properties[prop];
+
+    // Skip the property if it was inherited from the base model (the parent)
+    const baseProp = inherited[prop];
+    if (baseProp && isDeepStrictEqual(propDef, baseProp)) {
+      delete templateData[prop];
+      continue;
+    }
+
+    const def = migratePropertyDefinition(propDef);
     templateData[prop] = createPropertyTemplateData(def);
   }
 
@@ -132,21 +159,30 @@ function migrateBaseClass(base) {
     };
   }
 
-  // TODO: handle inheritance from application models
-  throw new Error(
-    'Models inheriting from app-specific models cannot be migrated yet. ' +
-      `Base model configured: ${baseModelName}`,
-  );
+  return {
+    modelBaseClass: baseModelName,
+    isModelBaseBuiltin: false,
+  };
 }
 
-function migrateModelSettings(settings = {}, log) {
+function migrateModelSettings(settings = {}, inherited = {}, log) {
   // Shallow-clone the object to prevent modification of external data
   settings = {...settings};
 
   // "strict" mode is enabled only when explicitly requested
   // LB3 models allow additional properties by default
   settings.strict = settings.strict === true;
 
+  // Remove settings inherited from the base model
+  for (const key in inherited) {
+    // Always emit the value of 'strict' setting, make it explicit
+    if (key === 'strict') continue;
+
+    if (isDeepStrictEqual(settings[key], inherited[key])) {
+      delete settings[key];
+    }
+  }
+
   if (settings.forceId === 'auto') {
     // The value 'auto' is used when a parent model wants to let the child
     // model make the decision automatically, depending on whether the child
@@ -204,3 +240,10 @@ function migrateModelSettings(settings = {}, log) {
 
   return settings;
 }
+
+function isCoreModel(modelCtor) {
+  const name = modelCtor.modelName;
+  return (
+    name === 'Model' || name === 'PersistedModel' || name === 'KeyValueModel'
+  );
+}

packages/cli/package.json

@@ -28,6 +28,7 @@
     "@types/ejs": "^3.0.1",
     "@types/node": "^10.17.16",
     "glob": "^7.1.6",
+    "loopback": "^3.26.0",
     "loopback-datasource-juggler": "^4.18.1",
     "mem-fs": "^1.1.3",
     "mem-fs-editor": "^6.0.0",
@@ -50,7 +51,6 @@
     "json5": "^2.1.1",
     "latest-version": "^5.1.0",
     "lodash": "^4.17.15",
-    "loopback": "^3.26.0",
     "minimist": "^1.2.0",
     "mkdirp": "^1.0.3",
     "natural-compare": "^1.4.0",

packages/cli/snapshots/integration/generators/import-lb3-models.integration.snapshots.js

@@ -11,13 +11,7 @@ exports[`lb4 import-lb3-models imports CoffeeShop model from lb3-example app 1`]
 import {Entity, model, property} from '@loopback/repository';
 
 @model({
-  settings: {
-    strict: false,
-    forceId: false,
-    replaceOnPUT: true,
-    validateUpsert: true,
-    idInjection: true
-  }
+  settings: {strict: false, forceId: false, validateUpsert: true, idInjection: true}
 })
 export class CoffeeShop extends Entity {
   @property({
@@ -62,3 +56,140 @@ exports[`lb4 import-lb3-models imports CoffeeShop model from lb3-example app 2`]
 export * from './coffee-shop.model';
 
 `;
+
+
+exports[`lb4 import-lb3-models imports a model inheriting from a custom base class 1`] = `
+import {model, property} from '@loopback/repository';
+import {UserBase} from '.';
+
+@model({settings: {strict: false, customCustomerSetting: true}})
+export class Customer extends UserBase {
+  @property({
+    type: 'boolean',
+  })
+  isPreferred?: boolean;
+
+  // Define well-known properties here
+
+  // Indexer property to allow additional data
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [prop: string]: any;
+
+  constructor(data?: Partial<Customer>) {
+    super(data);
+  }
+}
+
+export interface CustomerRelations {
+  // describe navigational properties here
+}
+
+export type CustomerWithRelations = Customer & CustomerRelations;
+
+`;
+
+
+exports[`lb4 import-lb3-models imports a model inheriting from a custom base class 2`] = `
+import {model, property} from '@loopback/repository';
+import {User} from '.';
+
+@model({settings: {strict: false, customUserBaseSetting: true}})
+export class UserBase extends User {
+  @property({
+    type: 'boolean',
+    required: true,
+    default: false,
+  })
+  isAccountVerified: boolean;
+
+  // Define well-known properties here
+
+  // Indexer property to allow additional data
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [prop: string]: any;
+
+  constructor(data?: Partial<UserBase>) {
+    super(data);
+  }
+}
+
+export interface UserBaseRelations {
+  // describe navigational properties here
+}
+
+export type UserBaseWithRelations = UserBase & UserBaseRelations;
+
+`;
+
+
+exports[`lb4 import-lb3-models imports a model inheriting from a custom base class 3`] = `
+import {Entity, model, property} from '@loopback/repository';
+
+@model({
+  settings: {
+    strict: false,
+    caseSensitiveEmail: true,
+    hidden: ['password', 'verificationToken'],
+    maxTTL: 31556926,
+    ttl: 1209600
+  }
+})
+export class User extends Entity {
+  @property({
+    type: 'number',
+    id: 1,
+    generated: true,
+    updateOnly: true,
+  })
+  id?: number;
+
+  @property({
+    type: 'string',
+  })
+  realm?: string;
+
+  @property({
+    type: 'string',
+  })
+  username?: string;
+
+  @property({
+    type: 'string',
+    required: true,
+  })
+  password: string;
+
+  @property({
+    type: 'string',
+    required: true,
+  })
+  email: string;
+
+  @property({
+    type: 'boolean',
+  })
+  emailVerified?: boolean;
+
+  @property({
+    type: 'string',
+  })
+  verificationToken?: string;
+
+  // Define well-known properties here
+
+  // Indexer property to allow additional data
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [prop: string]: any;
+
+  constructor(data?: Partial<User>) {
+    super(data);
+  }
+}
+
+export interface UserRelations {
+  // describe navigational properties here
+}
+
+export type UserWithRelations = User & UserRelations;
+
+`;