feat(repository): add new method to provide user identifier for deletedbyid

BREAKING CHANGE:
change approach for custom identifier for deletedbyid

gh-0

Author: Samarpan Bhattacharya

.mocharc.json

@@ -1,4 +1,5 @@
 {
   "recursive": true,
+  "reporter": ["dot"],
   "require": "source-map-support/register"
 }

README.md

@@ -193,12 +193,12 @@ export class ItemRepository extends SoftCrudRepositoryMixin<
 
 ### deletedBy
 
-Whenever any entry is deleted using deleteById, delete and deleteAll repository methods, it also sets deletedBy column with a value with user id whoever is logged in currently. Hence it uses a Getter function of IAuthUser type. However, if you want to use some other attribute of user model other than id, you can do it by overriding deletedByIdKey. Here is an example.
+Whenever any entry is deleted using deleteById, delete and deleteAll repository methods, it also sets deletedBy column with a value with user id whoever is logged in currently. Hence it uses a Getter function of IUser type. However, if you want to use some other attribute of user model other than id, you can do it by overriding deletedByIdKey. Here is an example.
 
 ```ts
 import {Getter, inject} from '@loopback/core';
 import {SoftCrudRepository, IUser} from 'loopback4-soft-delete';
-import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
+import {AuthenticationBindings} from 'loopback4-authentication';
 
 import {PgdbDataSource} from '../datasources';
 import {User, UserRelations} from '../models';
@@ -211,10 +211,32 @@ export class UserRepository extends SoftCrudRepository<
   constructor(
     @inject('datasources.pgdb') dataSource: PgdbDataSource,
     @inject.getter(AuthenticationBindings.CURRENT_USER, {optional: true})
-    protected readonly getCurrentUser: Getter<(IAuthUser & IUser) | undefined>,
-    protected readonly deletedByIdKey: string = 'userTenantId',
+    protected readonly getCurrentUser: Getter<User | undefined>,
   ) {
-    super(User, dataSource, getCurrentUser, deletedByIdKey);
+    super(User, dataSource, getCurrentUser);
+  }
+}
+```
+
+Model class for custom identifier case. Notice the `getIdentifier() method` and `IUser` interface implemented.
+
+```ts
+@model()
+class User extends SoftDeleteEntity implements IUser {
+  @property({
+    id: true,
+  })
+  id: string;
+
+  @property()
+  username: string;
+
+  getIdentifier() {
+    return this.username;
+  }
+
+  constructor(data?: Partial<User>) {
+    super(data);
   }
 }
 ```

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

@@ -12,6 +12,7 @@ import {
   Entity,
   EntityNotFoundError,
   juggler,
+  Model,
   model,
   property,
 } from '@loopback/repository';
@@ -43,6 +44,40 @@ class Customer2 extends SoftDeleteEntity {
   email: string;
 }
 
+@model()
+class User extends Model implements IUser {
+  @property({
+    id: true,
+  })
+  id: string;
+
+  @property()
+  username: string;
+
+  constructor(data?: Partial<User>) {
+    super(data);
+  }
+}
+
+@model()
+class UserWithCustomId extends Model implements IUser {
+  @property({
+    id: true,
+  })
+  id: string;
+
+  @property()
+  username: string;
+
+  getIdentifier() {
+    return this.username;
+  }
+
+  constructor(data?: Partial<UserWithCustomId>) {
+    super(data);
+  }
+}
+
 class CustomerCrudRepo extends SoftCrudRepositoryMixin<
   Customer,
   typeof Customer.prototype.id,
@@ -76,7 +111,6 @@ class Customer2CrudRepo extends SoftCrudRepositoryMixin<
     },
     dataSource: juggler.DataSource,
     readonly getCurrentUser: Getter<IUser | undefined>,
-    readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource, getCurrentUser);
   }
@@ -85,22 +119,24 @@ class Customer2CrudRepo extends SoftCrudRepositoryMixin<
 describe('SoftCrudRepositoryMixin', () => {
   let repo: CustomerCrudRepo;
   let repoWithCustomDeletedByKey: Customer2CrudRepo;
-  const userData = {
+  const userData: User = new User({
     id: '1',
     username: 'test',
-  };
+  });
+
+  const userData2: UserWithCustomId = new UserWithCustomId({
+    id: '2',
+    username: 'test2',
+  });
 
   before(() => {
     const ds: juggler.DataSource = new juggler.DataSource({
       name: 'db',
       connector: 'memory',
     });
     repo = new CustomerCrudRepo(Customer, ds, () => Promise.resolve(userData));
-    repoWithCustomDeletedByKey = new Customer2CrudRepo(
-      Customer2,
-      ds,
-      () => Promise.resolve(userData),
-      'username',
+    repoWithCustomDeletedByKey = new Customer2CrudRepo(Customer2, ds, () =>
+      Promise.resolve(userData2),
     );
   });
 
@@ -587,7 +623,7 @@ describe('SoftCrudRepositoryMixin', () => {
         await repoWithCustomDeletedByKey.findByIdIncludeSoftDelete(1);
       expect(afterDeleteIncludeSoftDeleted)
         .to.have.property('deletedBy')
-        .equal(userData.username);
+        .equal(userData2.username);
     });
   });
 
@@ -639,7 +675,7 @@ describe('SoftCrudRepositoryMixin', () => {
         await repoWithCustomDeletedByKey.findByIdIncludeSoftDelete(1);
       expect(afterDeleteIncludeSoftDeleted)
         .to.have.property('deletedBy')
-        .equal(userData.username);
+        .equal(userData2.username);
     });
   });
 
@@ -673,7 +709,7 @@ describe('SoftCrudRepositoryMixin', () => {
       const afterDeleteAll = await repoWithCustomDeletedByKey.findAll();
       expect(afterDeleteAll).to.have.length(4);
       afterDeleteAll.forEach((rec) => {
-        expect(rec).to.have.property('deletedBy').equal(userData.username);
+        expect(rec).to.have.property('deletedBy').equal(userData2.username);
       });
     });
   });

src/__tests__/unit/repository/default-transaction-soft-crud.repository.base.ts

@@ -10,6 +10,7 @@ import {
   Entity,
   EntityNotFoundError,
   juggler,
+  Model,
   model,
   property,
 } from '@loopback/repository';
@@ -41,6 +42,40 @@ class Customer2 extends SoftDeleteEntity {
   email: string;
 }
 
+@model()
+class User extends Model implements IUser {
+  @property({
+    id: true,
+  })
+  id: string;
+
+  @property()
+  username: string;
+
+  constructor(data?: Partial<User>) {
+    super(data);
+  }
+}
+
+@model()
+class UserWithCustomId extends Model implements IUser {
+  @property({
+    id: true,
+  })
+  id: string;
+
+  @property()
+  username: string;
+
+  getIdentifier() {
+    return this.username;
+  }
+
+  constructor(data?: Partial<UserWithCustomId>) {
+    super(data);
+  }
+}
+
 class CustomerCrudRepo extends DefaultTransactionSoftCrudRepository<
   Customer,
   number
@@ -66,7 +101,6 @@ class Customer2CrudRepo extends DefaultTransactionSoftCrudRepository<
     },
     dataSource: juggler.DataSource,
     protected readonly getCurrentUser?: Getter<IUser | undefined>,
-    protected readonly deletedByIdKey: string = 'id',
   ) {
     super(entityClass, dataSource, getCurrentUser);
   }
@@ -75,22 +109,24 @@ class Customer2CrudRepo extends DefaultTransactionSoftCrudRepository<
 describe('DefaultTransactionSoftCrudRepository', () => {
   let repo: CustomerCrudRepo;
   let repoWithCustomDeletedByKey: Customer2CrudRepo;
-  const userData = {
+  const userData: User = new User({
     id: '1',
     username: 'test',
-  };
+  });
+
+  const userData2: UserWithCustomId = new UserWithCustomId({
+    id: '2',
+    username: 'test2',
+  });
 
   before(() => {
     const ds: juggler.DataSource = new juggler.DataSource({
       name: 'db',
       connector: 'memory',
     });
     repo = new CustomerCrudRepo(Customer, ds, () => Promise.resolve(userData));
-    repoWithCustomDeletedByKey = new Customer2CrudRepo(
-      Customer2,
-      ds,
-      () => Promise.resolve(userData),
-      'username',
+    repoWithCustomDeletedByKey = new Customer2CrudRepo(Customer2, ds, () =>
+      Promise.resolve(userData2),
     );
   });
 
@@ -577,7 +613,7 @@ describe('DefaultTransactionSoftCrudRepository', () => {
         await repoWithCustomDeletedByKey.findByIdIncludeSoftDelete(1);
       expect(afterDeleteIncludeSoftDeleted)
         .to.have.property('deletedBy')
-        .equal(userData.username);
+        .equal(userData2.username);
     });
   });
 
@@ -630,7 +666,7 @@ describe('DefaultTransactionSoftCrudRepository', () => {
         await repoWithCustomDeletedByKey.findByIdIncludeSoftDelete(1);
       expect(afterDeleteIncludeSoftDeleted)
         .to.have.property('deletedBy')
-        .equal(userData.username);
+        .equal(userData2.username);
     });
   });
 
@@ -664,7 +700,7 @@ describe('DefaultTransactionSoftCrudRepository', () => {
       const afterDeleteAll = await repoWithCustomDeletedByKey.findAll();
       expect(afterDeleteAll).to.have.length(4);
       afterDeleteAll.forEach((rec) => {
-        expect(rec).to.have.property('deletedBy').equal(userData.username);
+        expect(rec).to.have.property('deletedBy').equal(userData2.username);
       });
     });
   });