fix(repository): add deleted property in fields filter (#92)

GH-91

Author: prernagp

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit 
+npx --no-install commitlint --edit

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  "configurations": [
+    {
+  "type": "node",
+  "request": "launch",
+  "name": "Run Mocha tests",
+  "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+  "runtimeArgs": [
+    "-r",
+    "${workspaceRoot}/node_modules/source-map-support/register"
+  ],
+  "cwd": "${workspaceRoot}",
+  "autoAttachChildProcesses": true,
+  "args": [
+    "--config",
+    "${workspaceRoot}/.mocharc.json",
+    "${workspaceRoot}/dist/__tests__/**/*.js",
+    "-t",
+    "0"
+  ]
+}
+  ]
+}

package-lock.json

@@ -288,6 +288,38 @@ describe('SoftCrudRepository', () => {
         expect(e.message).to.be.equal('EntityNotFound');
       }
     });
+    it('should not return soft deleted entry by id, without using deleted in fields filter', async () => {
+      try {
+        await repo.findById(3, {
+          fields: {
+            id: true,
+            email: true,
+          },
+        });
+        fail();
+      } catch (e) {
+        expect(e.message).to.be.equal('EntityNotFound');
+      }
+    });
+    it('should return requested fields only when not using deleted in fields filter', async () => {
+      const customer = await repo.findById(4, {
+        fields: {
+          id: true,
+          email: true,
+        },
+      });
+      expect(customer).to.not.have.property('deleted');
+    });
+    it('should return requested fields matched with fields filter', async () => {
+      const customer = await repo.findById(4, {
+        fields: {
+          id: true,
+          email: true,
+          deleted: true,
+        },
+      });
+      expect(customer).to.have.property('deleted');
+    });
   });
 
   describe('findByIdIncludeSoftDelete', () => {

src/__tests__/unit/repository/soft-crud.repository.unit.ts

@@ -12,7 +12,7 @@ import {
 } from '@loopback/repository';
 import {Count} from '@loopback/repository/src/common-types';
 import {HttpErrors} from '@loopback/rest';
-import {Options} from 'loopback-datasource-juggler';
+import {AnyObject, Options} from 'loopback-datasource-juggler';
 import {IAuthUser} from 'loopback4-authentication';
 
 import {ErrorKeys} from '../error-keys';
@@ -175,8 +175,19 @@ export abstract class SoftCrudRepository<
         [pk]: id,
       } as Condition<T>;
     }
-    const entity = await super.findById(id, filter, options);
+    const finalFilter: Filter<T> = {};
+    Object.assign(filter, finalFilter);
+    if (finalFilter.fields) {
+      finalFilter.fields = {
+        ...finalFilter.fields,
+        deleted: true,
+      };
+    }
+    const entity = await super.findById(id, finalFilter, options);
     if (entity && !entity.deleted) {
+      if (filter.fields && !(filter.fields as AnyObject).deleted) {
+        delete entity.deleted;
+      }
       return entity;
     } else {
       throw new HttpErrors.NotFound(ErrorKeys.EntityNotFound);