fix(sequelize): support "defaultScope" via Model settings

Signed-off-by: KalleV <[email protected]>

Author: KalleV

extensions/sequelize/src/__tests__/fixtures/controllers/index.ts

@@ -7,6 +7,7 @@ export * from './doctor.controller';
 export * from './patient.controller';
 export * from './product.controller';
 export * from './programming-languange.controller';
+export * from './scoped-task.controller';
 export * from './task.controller';
 export * from './test.controller.base';
 export * from './todo-list-todo.controller';

extensions/sequelize/src/__tests__/fixtures/controllers/scoped-task.controller.ts

@@ -0,0 +1,19 @@
+import {repository} from '@loopback/repository';
+import {get, response} from '@loopback/rest';
+import {ScopedTaskRepository} from '../repositories';
+import {TestControllerBase} from './test.controller.base';
+
+export class ScopedTaskController extends TestControllerBase {
+  constructor(
+    @repository(ScopedTaskRepository)
+    public scopedTaskRepository: ScopedTaskRepository,
+  ) {
+    super(scopedTaskRepository);
+  }
+
+  @get('/scoped-tasks/sync-sequelize-model')
+  @response(200)
+  async syncSequelizeModel(): Promise<void> {
+    await this.beforeEach();
+  }
+}

extensions/sequelize/src/__tests__/fixtures/models/index.ts

@@ -6,6 +6,7 @@ export * from './doctor.model';
 export * from './patient.model';
 export * from './product.model';
 export * from './programming-language.model';
+export * from './scoped-task.model';
 export * from './task.model';
 export * from './todo-list.model';
 export * from './todo.model';

extensions/sequelize/src/__tests__/fixtures/models/scoped-task.model.ts

@@ -0,0 +1,36 @@
+import {Entity, model, property} from '@loopback/repository';
+
+/**
+ * Simplified Entity used for testing settings "scope" functionality
+ */
+@model({
+  settings: {
+    scope: {
+      limit: 1,
+    },
+  },
+})
+export class ScopedTask extends Entity {
+  @property({
+    type: 'number',
+    id: true,
+    generated: true,
+  })
+  id?: number;
+
+  @property({
+    type: 'string',
+    required: true,
+  })
+  title: string;
+
+  constructor(data?: Partial<ScopedTask>) {
+    super(data);
+  }
+}
+
+export interface ScopedTaskRelations {
+  // describe navigational properties here
+}
+
+export type ScopedTaskWithRelations = ScopedTask & ScopedTaskRelations;

extensions/sequelize/src/__tests__/fixtures/repositories/index.ts

@@ -6,6 +6,7 @@ export * from './doctor.repository';
 export * from './patient.repository';
 export * from './product.repository';
 export * from './programming-language.repository';
+export * from './scoped-task.repository';
 export * from './task.repository';
 export * from './todo-list.repository';
 export * from './todo.repository';

extensions/sequelize/src/__tests__/fixtures/repositories/scoped-task.repository.ts

@@ -0,0 +1,24 @@
+import {inject} from '@loopback/core';
+import {SequelizeCrudRepository} from '../../../sequelize';
+import {PrimaryDataSource} from '../datasources/primary.datasource';
+import {ScopedTask, ScopedTaskRelations} from '../models/index';
+
+/**
+ * Simplified repository used for testing Model settings "scope" functionality
+ */
+export class ScopedTaskRepository extends SequelizeCrudRepository<
+  ScopedTask,
+  typeof ScopedTask.prototype.id,
+  ScopedTaskRelations
+> {
+  constructor(@inject('datasources.primary') dataSource: PrimaryDataSource) {
+    super(ScopedTask, dataSource);
+  }
+
+  protected getDefaultFnRegistry() {
+    return {
+      ...super.getDefaultFnRegistry(),
+      customAlias: () => Math.random(),
+    };
+  }
+}

extensions/sequelize/src/__tests__/integration/repository.integration.ts

@@ -26,6 +26,7 @@ import {
   TaskRepository,
   UserRepository,
 } from '../fixtures/repositories';
+import {ScopedTaskRepository} from '../fixtures/repositories/scoped-task.repository';
 
 type Entities =
   | 'users'
@@ -42,6 +43,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
   let app: SequelizeSandboxApplication;
   let userRepo: UserRepository;
   let taskRepo: TaskRepository;
+  let scopedTaskRepo: ScopedTaskRepository;
   let developerRepo: DeveloperRepository;
   let languagesRepo: ProgrammingLanguageRepository;
   let client: Client;
@@ -74,6 +76,29 @@ describe('Sequelize CRUD Repository (integration)', () => {
       }
     });
 
+    describe('Model settings Support', () => {
+      beforeEach(async () => {
+        await client.get('/scoped-tasks/sync-sequelize-model').send();
+      });
+      it('supports setting a default "scope" in the Model settings', async () => {
+        await Promise.all([
+          scopedTaskRepo.create({title: 'Task 1'}),
+          scopedTaskRepo.create({title: 'Task 2'}),
+          scopedTaskRepo.create({title: 'Task 3'}),
+        ]);
+
+        const tasksDefaultLimit = await scopedTaskRepo.find();
+
+        expect(tasksDefaultLimit.length).to.be.eql(1);
+
+        const tasksCustomLimit = await scopedTaskRepo.find({
+          limit: 3,
+        });
+
+        expect(tasksCustomLimit.length).to.be.eql(3);
+      });
+    });
+
     describe('defaultFn Support', () => {
       beforeEach(async () => {
         await client.get('/tasks/sync-sequelize-model').send();
@@ -919,6 +944,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
         'book.model',
         'category.model',
         'product.model',
+        'scoped-task.model',
         'task.model',
       ],
       repositories: [
@@ -934,6 +960,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
         'book.repository',
         'category.repository',
         'product.repository',
+        'scoped-task.repository',
         'task.repository',
       ],
       controllers: [
@@ -956,6 +983,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
         'product.controller',
         'test.controller.base',
         'task.controller',
+        'scoped-task.controller',
       ],
     };
 
@@ -993,6 +1021,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
     developerRepo = await app.getRepository(DeveloperRepository);
     languagesRepo = await app.getRepository(ProgrammingLanguageRepository);
     taskRepo = await app.getRepository(TaskRepository);
+    scopedTaskRepo = await app.getRepository(ScopedTaskRepository);
     client = createRestAppClient(app as RestApplication);
   }
 

extensions/sequelize/src/sequelize/sequelize.repository.base.ts

@@ -682,6 +682,8 @@ export class SequelizeCrudRepository<
         timestamps: false,
         tableName: this.getTableName(entityClass),
         freezeTableName: true,
+        // Set up optional default scope: https://sequelize.org/docs/v6/other-topics/scopes/#definition
+        defaultScope: entityClass.definition.settings.scope,
       },
     );