test(sequelize): update tests to cover hasMany relation

Signed-off-by: KalleV <[email protected]>
loopbackio · Dec 30, 2024 · 42d08fc · 42d08fc
1 parent 14d9413
commit 42d08fc
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 28 deletions.
diff --git a/extensions/sequelize/src/__tests__/fixtures/models/patient.model.ts b/extensions/sequelize/src/__tests__/fixtures/models/patient.model.ts
@@ -15,6 +15,12 @@ export class Patient extends Entity {
   })
   name: string;
 
+  @property({
+    type: 'string',
+    hidden: true,
+  })
+  password?: string;
+
   constructor(data?: Partial<Patient>) {
     super(data);
   }

diff --git a/extensions/sequelize/src/__tests__/integration/repository.integration.ts b/extensions/sequelize/src/__tests__/integration/repository.integration.ts
@@ -868,27 +868,6 @@ describe('Sequelize CRUD Repository (integration)', () => {
       ]);
     });
 
-    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']);
 
@@ -1026,6 +1005,27 @@ describe('Sequelize CRUD Repository (integration)', () => {
       );
     });
 
+    it('hides hidden properties in related entities included with @belongsTo relation', 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 @belongsTo using keyfrom and keyto', async () => {
       await migrateSchema(['users', 'todos', 'todo-lists']);
 
@@ -1078,13 +1078,13 @@ describe('Sequelize CRUD Repository (integration)', () => {
 
       const doctorRes = await client.post('/doctors').send(getDummyDoctor());
       const patientRes = await client
-        .post(`/doctors/${1}/patients`)
+        .post(`/doctors/${doctorRes.body.id}/patients`)
         .send(getDummyPatient());
 
       const filter = {include: ['patients']};
-      const relationRes = await client.get(
-        `/doctors?filter=${encodeURIComponent(JSON.stringify(filter))}`,
-      );
+      const relationRes = await client
+        .get(`/doctors`)
+        .query({filter: JSON.stringify(filter)});
 
       /**
        * Manually Remove through table data as sqlite3 doesn't support `attributes: []` using sequelize
@@ -1099,6 +1099,29 @@ describe('Sequelize CRUD Repository (integration)', () => {
       ]);
     });
 
+    it('hides hidden props for nested entities included with @hasMany relation', async () => {
+      await migrateSchema(['doctors']);
+
+      const doctorRes = await client.post('/doctors').send(getDummyDoctor());
+
+      await client.post(`/doctors/${doctorRes.body.id}/patients`).send(
+        getDummyPatient({
+          password: 'secret',
+        }),
+      );
+
+      const filter = {include: ['patients']};
+      const relationRes = await client
+        .get(`/doctors`)
+        .query({filter: JSON.stringify(filter)});
+
+      expect(relationRes.body.length).to.be.equal(1);
+      expect(relationRes.body.at(0)).to.have.property('patients');
+      expect(relationRes.body.at(0).patients.at(0)).to.not.have.property(
+        'password',
+      );
+    });
+
     it('supports @referencesMany', async () => {
       await migrateSchema(['developers']);
 

diff --git a/extensions/sequelize/src/sequelize/sequelize.repository.base.ts b/extensions/sequelize/src/sequelize/sequelize.repository.base.ts
@@ -1092,6 +1092,11 @@ export class SequelizeCrudRepository<
       }
     }
 
+    /**
+     * Transform related entities queried through relations into their corresponding Loopback models.
+     * This ensures hidden properties defined in the nested Loopback models are excluded from the response.
+     * @see https://loopback.io/doc/en/lb4/Model.html#hidden-properties
+     */
     function transformRelatedEntitiesToLoopbackModels(
       entities: T[],
       entityClass: typeof Entity,
@@ -1135,9 +1140,6 @@ export class SequelizeCrudRepository<
       });
     }
 
-    // Ensure models queried through relations are transformed into Loopback models so that the
-    // hidden properties are removed from the response during the "toJSON" transformation.
-    // See: https://loopback.io/doc/en/lb4/Model.html#hidden-properties
     transformRelatedEntitiesToLoopbackModels(
       parentEntityInstances,
       parentEntityClass,