feat(cli): generate relations while discovering models

Signed-off-by: Muhammad Aaqil <[email protected]>

Author: aaqilniz

packages/cli/generators/discover/index.js

@@ -331,7 +331,7 @@ module.exports = class DiscoveryGenerator extends ArtifactGenerator {
         {
           schema: modelInfo.owner,
           disableCamelCase: this.artifactInfo.disableCamelCase,
-          associations: this.options.relations,
+          // associations: this.options.relations,
           ...discoveryOptions,
         },
       );
@@ -463,6 +463,7 @@ module.exports = class DiscoveryGenerator extends ArtifactGenerator {
     // end message to output something nice, before it was "Discover undefined was created in src/models/"
     this.artifactInfo.type = 'Models';
     this.artifactInfo.relationConfigs = relations;
+    repositoryConfigs['relations'] = JSON.stringify(relations);
     this.artifactInfo.repositoryConfigs = repositoryConfigs;
     this.artifactInfo.name = this.artifactInfo.modelDefinitions
       .map(d => d.name)
@@ -471,5 +472,47 @@ module.exports = class DiscoveryGenerator extends ArtifactGenerator {
 
   async end() {
     await super.end();
+    await this._generateRepositories();
+  }
+
+  async _generateRepositories() {
+    if (
+      !this.artifactInfo.repositoryConfigs ||
+      !this.artifactInfo.repositoryConfigs.repositories ||
+      this.artifactInfo.repositoryConfigs.repositories.size === 0
+    ) {
+      debug(
+        'No repository configurations found, skipping repository generation',
+      );
+      return;
+    }
+    const {repositories, datasource, repositoryBaseClass, relations} =
+      this.artifactInfo.repositoryConfigs;
+    // Convert Set to Array and iterate
+    const modelList = Array.from(repositories);
+    for (let index = 0; index < modelList.length; index++) {
+      const model = modelList[index];
+      const repoGenOptions = {
+        name: model,
+        model,
+        datasource,
+        repositoryBaseClass,
+        yes: true,
+        skipInstall: true,
+        skipCache: true,
+      };
+      if (index === modelList.length - 1) {
+        repoGenOptions.relations = relations;
+      }
+      // Use composeWith to invoke the repository generator
+      const repoGen = require('../repository');
+      this.composeWith(
+        {
+          Generator: repoGen,
+          path: require.resolve('../repository'),
+        },
+        repoGenOptions,
+      );
+    }
   }
 };

packages/cli/generators/repository/index.js

@@ -571,5 +571,37 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
     );
     this.artifactInfo.name = `${this.artifactInfo.className}Repository`;
     await super.end();
+    await this._generateRelations();
+  }
+
+  async _generateRelations() {
+    if (!this.artifactInfo.relations) {
+      debug('No relation configurations found, skipping relation generation');
+      return;
+    }
+    this.artifactInfo.relations = JSON.parse(this.artifactInfo.relations);
+    if (!this.artifactInfo.relations.length) {
+      debug('No relation configurations found, skipping relation generation');
+      return;
+    }
+    this.artifactInfo.relations.forEach(relation => {
+      const repoGen = require('../relation');
+      this.composeWith(
+        {
+          Generator: repoGen,
+          path: require.resolve('../relation'),
+        },
+        {
+          sourceModel: relation.sourceModel,
+          destinationModel: relation.destinationModel,
+          foreignKeyName: relation.foreignKeyName,
+          relationType: relation.relationType,
+          registerInclusionResolver: relation.registerInclusionResolver,
+          yes: true,
+          skipInstall: true,
+          skipCache: true,
+        },
+      );
+    });
   }
 };

packages/cli/lib/artifact-generator.js

@@ -128,53 +128,6 @@ module.exports = class ArtifactGenerator extends BaseGenerator {
         .split(this.classNameSeparator)
         .map(utils.toClassName);
       const classesOutput = classes.join(this.classNameSeparator);
-      if (
-        this.artifactInfo.repositoryConfigs &&
-        this.artifactInfo.repositoryConfigs.repositories.size
-      ) {
-        const {repositories, datasource, repositoryBaseClass} =
-          this.artifactInfo.repositoryConfigs;
-        for (const model of repositories) {
-          const config = {repositoryBaseClass, datasource, model, name: model};
-          try {
-            const {execSync} = require('child_process');
-            const cmd =
-              "lb4 repository --config='" + JSON.stringify(config) + "' --yes";
-            execSync(cmd, {
-              cwd: process.cwd(),
-              stdio: ['ignore', 'pipe', 'pipe'],
-              encoding: 'utf8',
-            });
-          } catch (error) {
-            console.log(error);
-          }
-        }
-      } else {
-        debug(
-          'No repository configurations found, skipping repository generation',
-        );
-      }
-      if (
-        this.artifactInfo.relationConfigs &&
-        this.artifactInfo.relationConfigs.length
-      ) {
-        for (const configs of this.artifactInfo.relationConfigs) {
-          try {
-            const {execSync} = require('child_process');
-            const cmd =
-              "lb4 relation --config='" + JSON.stringify(configs) + "' --yes";
-            execSync(cmd, {
-              cwd: process.cwd(),
-              stdio: ['ignore', 'pipe', 'pipe'],
-              encoding: 'utf8',
-            });
-          } catch (error) {
-            console.log(error);
-          }
-        }
-      } else {
-        debug('No relation configurations found, skipping relation generation');
-      }
       // User Output
       this.log();
       this.log(

packages/cli/lib/base-generator.js

@@ -461,7 +461,6 @@ module.exports = class BaseGenerator extends Generator {
         );
       }
     }
-    process.exit(0);
   }
 
   /**

packages/cli/snapshots/integration/generators/discover.integration.snapshots.js

@@ -60,13 +60,7 @@ export type ViewWithRelations = View & ViewRelations;
 exports[`lb4 discover integration model discovery discovers models with --relations 1`] = `
 import {Entity, model, property, belongsTo} from '@loopback/repository';
 
-@model({
-  settings: {
-    foreignKeys: {
-      doctorRel: {name: 'doctorRel', entity: 'Doctor', entityKey: 'id', foreignKey: 'reportsTo'}
-    }
-  }
-})
+@model()
 export class Doctor extends Entity {
   @property({
     type: 'number',
@@ -82,8 +76,7 @@ export class Doctor extends Entity {
   name?: string;
 
   @belongsTo(() => Doctor)
-  reportsTo?: number;
-
+  reportsTo: number;
   // Define well-known properties here
 
   // Indexer property to allow additional data
@@ -163,21 +156,10 @@ export type TestWithRelations = Test & TestRelations;
 
 exports[`lb4 discover integration model discovery generate relations with --relations 1`] = `
 import {Entity, model, property, belongsTo} from '@loopback/repository';
-import {Doctor,Patient} from '.';
-
-@model({
-  settings: {
-    foreignKeys: {
-      doctorIdRel: {name: 'doctorIdRel', entity: 'Doctor', entityKey: 'id', foreignKey: 'doctorId'},
-      patientIdRel: {
-        name: 'patientIdRel',
-        entity: 'Patient',
-        entityKey: 'pid',
-        foreignKey: 'patientId'
-      }
-    }
-  }
-})
+import {Doctor} from './doctor.model';
+import {Patient} from './patient.model';
+
+@model()
 export class Appointment extends Entity {
   @property({
     type: 'number',
@@ -188,13 +170,11 @@ export class Appointment extends Entity {
     mysql: {columnName: 'id', dataType: 'int', dataLength: null, dataPrecision: 10, dataScale: 0, nullable: 'N', generated: 1},
   })
   id?: number;
-
-  @belongsTo(() => Patient)
-  patientId?: number;
-
   @belongsTo(() => Doctor)
-  doctorId?: number;
+  doctorId: number;
 
+  @belongsTo(() => Patient)
+  patientId: number;
   // Define well-known properties here
 
   // Indexer property to allow additional data

packages/cli/test/fixtures/discover/index.js

@@ -6,4 +6,14 @@ exports.SANDBOX_FILES = [
     file: 'mem.datasource.js',
     content: fs.readFileSync(require.resolve('./mem.datasource.js.txt')),
   },
+  {
+    path: 'src/datasources',
+    file: 'mem.datasource.ts',
+    content: fs.readFileSync(require.resolve('./mem.datasource.ts.txt')),
+  },
+  {
+    path: 'src/datasources',
+    file: 'index.ts',
+    content: `export * from './mem.datasource';\n`,
+  },
 ];

packages/cli/test/fixtures/discover/mem.datasource.js.txt

@@ -171,9 +171,6 @@ const fullDefinitions = [
     modelSettings: {
       settings: {
         idInjection: false,
-        relations: {
-          doctorRel: {model: 'Doctor', type: 'belongsTo', foreignKey: 'reportsTo'},
-        }
       }
     }
   },
@@ -239,10 +236,6 @@ const fullDefinitions = [
     modelSettings: {
       settings: {
         idInjection: false,
-        relations: {
-          doctorIdRel: {model: 'Doctor', type: 'belongsTo', foreignKey: 'doctorId'},
-          patientIdRel: {model: 'Patient', type: 'belongsTo', foreignKey: 'patientId'}
-        }
       }
     }
   },

packages/cli/test/fixtures/discover/mem.datasource.ts.txt

@@ -0,0 +1,22 @@
+import {lifeCycleObserver, LifeCycleObserver} from '@loopback/core';
+import {juggler} from '@loopback/repository';
+
+const config = {
+  name: 'mem',
+  connector: 'memory',
+};
+
+@lifeCycleObserver('datasource')
+export class MemDataSource extends juggler.DataSource
+  implements LifeCycleObserver {
+  static dataSourceName = 'mem';
+  static readonly defaultConfig = config;
+
+  constructor(
+    dsConfig: object = config,
+  ) {
+    super(dsConfig);
+  }
+}
+
+export default MemDataSource;

packages/cli/test/integration/generators/discover.integration.js

@@ -97,6 +97,18 @@ const appointmentModel = path.join(
   'src/models/appointment.model.ts',
 );
 const doctorModel = path.join(sandbox.path, 'src/models/doctor.model.ts');
+const doctorRepository = path.join(
+  sandbox.path,
+  'src/repositories/doctor.repository.ts',
+);
+const appointmentRepository = path.join(
+  sandbox.path,
+  'src/repositories/appointment.repository.ts',
+);
+const patientRepository = path.join(
+  sandbox.path,
+  'src/repositories/patient.repository.ts',
+);
 
 const defaultExpectedIndexFile = path.join(sandbox.path, 'src/models/index.ts');
 const movedExpectedTestModel = path.join(sandbox.path, 'src/test.model.ts');
@@ -111,8 +123,8 @@ describe('lb4 discover integration', () => {
     beforeEach('reset sandbox', async () => {
       await sandbox.reset();
       await sandbox.mkdir('dist/datasources');
+      await sandbox.mkdir('src/datasources');
     });
-
     it('generates all models without prompts using --all --dataSource', /** @this {Mocha.Context} */ async function () {
       this.timeout(10000);
       await testUtils
@@ -212,7 +224,8 @@ describe('lb4 discover integration', () => {
       assert.file(defaultExpectedTestModel);
       expectFileToMatchSnapshot(defaultExpectedTestModel);
     });
-    it('generate relations with --relations', async () => {
+    it('generate relations with --relations', /** @this {Mocha.Context} */ async function () {
+      this.timeout(50000);
       await testUtils
         .executeGenerator(generator)
         .inDir(sandbox.path, () =>
@@ -221,10 +234,14 @@ describe('lb4 discover integration', () => {
           }),
         )
         .withOptions(relationsSetTrue);
+      assert.file(appointmentRepository);
+      assert.file(patientRepository);
+      assert.file(doctorRepository);
       assert.file(appointmentModel);
       expectFileToMatchSnapshot(appointmentModel);
     });
-    it('discovers models with --relations', async () => {
+    it('discovers models with --relations', /** @this {Mocha.Context} */ async function () {
+      this.timeout(50000);
       await testUtils
         .executeGenerator(generator)
         .inDir(sandbox.path, () =>
@@ -233,6 +250,9 @@ describe('lb4 discover integration', () => {
           }),
         )
         .withOptions(relationsSetTrue);
+      assert.file(appointmentRepository);
+      assert.file(patientRepository);
+      assert.file(doctorRepository);
       assert.file(doctorModel);
       expectFileToMatchSnapshot(doctorModel);
     });