test(sequelize): update tests to replicate hidden property bug

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

Author: KalleV

extensions/sequelize/src/__tests__/fixtures/controllers/user-todo-list.controller.ts

@@ -58,7 +58,7 @@ export class UserTodoListController {
           schema: getModelSchemaRef(TodoList, {
             title: 'NewTodoListInUser',
             exclude: ['id'],
-            optional: ['user'],
+            optional: ['userId'],
           }),
         },
       },

extensions/sequelize/src/__tests__/fixtures/models/todo-list.model.ts

@@ -1,5 +1,12 @@
-import {Entity, hasMany, model, property} from '@loopback/repository';
+import {
+  Entity,
+  hasMany,
+  model,
+  property,
+  belongsTo,
+} from '@loopback/repository';
 import {Todo} from './todo.model';
+import {User} from './user.model';
 
 @model()
 export class TodoList extends Entity {
@@ -21,10 +28,17 @@ export class TodoList extends Entity {
   })
   todos: Todo[];
 
-  @property({
-    type: 'number',
-  })
-  user?: number;
+  @belongsTo(
+    () => User,
+    {
+      keyTo: 'id',
+      keyFrom: 'userId',
+    },
+    {
+      type: 'number',
+    },
+  )
+  userId?: number;
 
   constructor(data?: Partial<TodoList>) {
     super(data);

extensions/sequelize/src/__tests__/fixtures/models/user.model.ts

@@ -66,7 +66,7 @@ export class User extends Entity {
   })
   dob?: Date;
 
-  @hasOne(() => TodoList, {keyTo: 'user'})
+  @hasOne(() => TodoList, {keyTo: 'userId'})
   todoList: TodoList;
 
   constructor(data?: Partial<User>) {

extensions/sequelize/src/__tests__/fixtures/repositories/todo-list.repository.ts

@@ -1,9 +1,14 @@
 import {Getter, inject} from '@loopback/core';
-import {HasManyRepositoryFactory, repository} from '@loopback/repository';
+import {
+  HasManyRepositoryFactory,
+  repository,
+  type BelongsToAccessor,
+} from '@loopback/repository';
 import {SequelizeCrudRepository} from '../../../sequelize';
 import {PrimaryDataSource} from '../datasources/primary.datasource';
-import {Todo, TodoList, TodoListRelations} from '../models/index';
+import {Todo, TodoList, TodoListRelations, User} from '../models/index';
 import {TodoRepository} from './todo.repository';
+import {UserRepository} from './user.repository';
 
 export class TodoListRepository extends SequelizeCrudRepository<
   TodoList,
@@ -15,16 +20,23 @@ export class TodoListRepository extends SequelizeCrudRepository<
     typeof TodoList.prototype.id
   >;
 
+  public readonly user: BelongsToAccessor<User, typeof TodoList.prototype.id>;
+
   constructor(
     @inject('datasources.primary') dataSource: PrimaryDataSource,
     @repository.getter('TodoRepository')
     protected todoRepositoryGetter: Getter<TodoRepository>,
+    @repository.getter('UserRepository')
+    protected userRepositoryGetter: Getter<UserRepository>,
   ) {
     super(TodoList, dataSource);
     this.todos = this.createHasManyRepositoryFactoryFor(
       'todos',
       todoRepositoryGetter,
     );
     this.registerInclusionResolver('todos', this.todos.inclusionResolver);
+
+    this.user = this.createBelongsToAccessorFor('user', userRepositoryGetter);
+    this.registerInclusionResolver('user', this.user.inclusionResolver);
   }
 }

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

@@ -829,7 +829,7 @@ describe('Sequelize CRUD Repository (integration)', () => {
 
       const user = getDummyUser();
       const userRes = await client.post('/users').send(user);
-      const todoList = getDummyTodoList({user: userRes.body.id});
+      const todoList = getDummyTodoList({userId: userRes.body.id});
       const todoListRes = await client.post('/todo-lists').send(todoList);
 
       const filter = {include: ['todoList']};
@@ -863,11 +863,32 @@ describe('Sequelize CRUD Repository (integration)', () => {
         {
           ...todoListRes.body,
           todos: [todoRes.body],
-          user: null,
+          userId: null,
         },
       ]);
     });
 
+    it('hides hidden properties in related entities', async () => {
+      await migrateSchema(['todos', 'todo-lists', 'users']);
+
+      const userRes = await client.post('/users').send(getDummyUser());
+
+      await client.post('/todo-lists').send(
+        getDummyTodoList({
+          title: 'Todo list one',
+          userId: userRes.body.id,
+        }),
+      );
+
+      const filter = {include: ['user']};
+      const relationRes = await client.get(`/todo-lists`).query({
+        filter: JSON.stringify(filter),
+      });
+
+      expect(relationRes.body.length).to.be.equal(1);
+      expect(relationRes.body.at(0).user).not.to.have.property('password');
+    });
+
     it('supports `order` filter by associations', async () => {
       await migrateSchema(['todos', 'todo-lists']);
 
@@ -898,12 +919,12 @@ describe('Sequelize CRUD Repository (integration)', () => {
         {
           ...todoListRes1.body,
           todos: [todoRes1.body],
-          user: null,
+          userId: null,
         },
         {
           ...todoListRes2.body,
           todos: [todoRes2.body],
-          user: null,
+          userId: null,
         },
       ]);
 
@@ -915,12 +936,12 @@ describe('Sequelize CRUD Repository (integration)', () => {
         {
           ...todoListRes2.body,
           todos: [todoRes2.body],
-          user: null,
+          userId: null,
         },
         {
           ...todoListRes1.body,
           todos: [todoRes1.body],
-          user: null,
+          userId: null,
         },
       ]);
 
@@ -932,12 +953,12 @@ describe('Sequelize CRUD Repository (integration)', () => {
         {
           ...todoListRes1.body,
           todos: [todoRes1.body],
-          user: null,
+          userId: null,
         },
         {
           ...todoListRes2.body,
           todos: [todoRes2.body],
-          user: null,
+          userId: null,
         },
       ]);
     });
@@ -1013,13 +1034,13 @@ describe('Sequelize CRUD Repository (integration)', () => {
       const todoOne = await client.post('/todo-lists').send(
         getDummyTodoList({
           title: 'Todo list one',
-          user: userRes.body.id,
+          userId: userRes.body.id,
         }),
       );
       const todoListRes = await client.post('/todo-lists').send(
         getDummyTodoList({
           title: 'Another todo list',
-          user: userRes.body.id,
+          userId: userRes.body.id,
         }),
       );