fix(repository): remove imposing behaviour of fields (#143)

which was setting deleted to true for each soft-delete query
 it is not required to run conditions

GH-142

Author: shubhamp-sf

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

@@ -179,6 +179,21 @@ describe('SoftCrudRepositoryMixin', () => {
       });
       expect(deletedCustomers).to.have.length(0);
     });
+
+    it('should find non soft deleted entries when deleted fields are not included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(3);
+    });
+
+    it('should find non soft deleted entries when deleted fields are included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: true},
+      });
+      expect(customers).to.have.length(3);
+    });
+
     it('should find non soft deleted entries with or operator', async () => {
       const customers = await repo.find({
         where: {
@@ -202,6 +217,14 @@ describe('SoftCrudRepositoryMixin', () => {
       const customers = await repo.findAll();
       expect(customers).to.have.length(4);
     });
+
+    it('should find all entries when deleted fields are not included', async () => {
+      await setupTestData();
+      const customers = await repo.findAll({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(4);
+    });
   });
 
   describe('findOne', () => {
@@ -276,6 +299,17 @@ describe('SoftCrudRepositoryMixin', () => {
       expect(customer).to.have.property('email').equal('[email protected]');
     });
 
+    it('should find one soft deleted entry even when `deleted` field is not included', async () => {
+      const customer = await repo.findOne({
+        where: {
+          id: 4,
+        },
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+
+      expect(customer?.id).to.have.be.eql(4);
+    });
+
     it('shound find none soft deleted entry using or operator', async () => {
       const customer = await repo.findOne({
         where: {
@@ -303,6 +337,7 @@ describe('SoftCrudRepositoryMixin', () => {
           email: '[email protected]',
         },
       });
+
       expect(customer).to.have.property('email').equal('[email protected]');
     });
   });
@@ -368,7 +403,7 @@ describe('SoftCrudRepositoryMixin', () => {
         expect(e.message).to.be.equal('EntityNotFound');
       }
     });
-    it('should not return soft deleted entry by id, without using deleted in fields filter', async () => {
+    it('should not return soft deleted entry by id when using fields filter without including deleted column', async () => {
       try {
         await repo.findById(3, {
           fields: {
@@ -398,7 +433,11 @@ describe('SoftCrudRepositoryMixin', () => {
           email: true,
         },
       });
-      expect(customer).to.not.have.property('deleted');
+      const customer2 = await repo.findById(4, {
+        fields: ['id', 'email'],
+      });
+      expect(customer.deleted).to.be.undefined();
+      expect(customer2.deleted).to.be.undefined();
     });
     it('should return requested fields matched with fields filter', async () => {
       const customer = await repo.findById(4, {
@@ -410,17 +449,38 @@ describe('SoftCrudRepositoryMixin', () => {
       });
       expect(customer).to.have.property('deleted');
     });
+
+    it('should return non soft deleted entry even if deleted column is not included in fields', async () => {
+      const customer = await repo.findById(4, {
+        fields: {
+          deleted: false,
+          deletedBy: false,
+          deletedOn: false,
+        },
+      });
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.undefined();
+    });
+
     it('should return requested fields only when not using deleted in fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email'],
       });
-      expect(customer).to.not.have.property('deleted');
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.deleted).to.be.undefined();
     });
+
     it('should return requested fields matched with fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email', 'deleted'],
       });
-      expect(customer).to.have.property('deleted');
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.false();
+      expect(customer.deletedBy).to.be.undefined();
     });
   });
 
@@ -684,6 +744,7 @@ describe('SoftCrudRepositoryMixin', () => {
   describe('delete', () => {
     beforeEach(setupTestData);
     afterEach(clearTestData);
+
     it('should soft delete entries', async () => {
       const entity = await repo.findById(1);
       await repo.delete(entity);

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

@@ -169,6 +169,21 @@ describe('DefaultTransactionSoftCrudRepository', () => {
       });
       expect(deletedCustomers).to.have.length(0);
     });
+
+    it('should find non soft deleted entries when deleted fields are not included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(3);
+    });
+
+    it('should find non soft deleted entries when deleted fields are included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: true},
+      });
+      expect(customers).to.have.length(3);
+    });
+
     it('should find non soft deleted entries with or operator', async () => {
       const customers = await repo.find({
         where: {
@@ -192,6 +207,14 @@ describe('DefaultTransactionSoftCrudRepository', () => {
       const customers = await repo.findAll();
       expect(customers).to.have.length(4);
     });
+
+    it('should find all entries when deleted fields are not included', async () => {
+      await setupTestData();
+      const customers = await repo.findAll({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(4);
+    });
   });
 
   describe('findOne', () => {
@@ -266,6 +289,17 @@ describe('DefaultTransactionSoftCrudRepository', () => {
       expect(customer).to.have.property('email').equal('[email protected]');
     });
 
+    it('should find one soft deleted entry even when `deleted` field is not included', async () => {
+      const customer = await repo.findOne({
+        where: {
+          id: 4,
+        },
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+
+      expect(customer?.id).to.have.be.eql(4);
+    });
+
     it('shound find none soft deleted entry using or operator', async () => {
       const customer = await repo.findOne({
         where: {
@@ -293,6 +327,7 @@ describe('DefaultTransactionSoftCrudRepository', () => {
           email: '[email protected]',
         },
       });
+
       expect(customer).to.have.property('email').equal('[email protected]');
     });
   });
@@ -358,7 +393,7 @@ describe('DefaultTransactionSoftCrudRepository', () => {
         expect(e.message).to.be.equal('EntityNotFound');
       }
     });
-    it('should not return soft deleted entry by id, without using deleted in fields filter', async () => {
+    it('should not return soft deleted entry by id when using fields filter without including deleted column', async () => {
       try {
         await repo.findById(3, {
           fields: {
@@ -388,7 +423,11 @@ describe('DefaultTransactionSoftCrudRepository', () => {
           email: true,
         },
       });
-      expect(customer).to.not.have.property('deleted');
+      const customer2 = await repo.findById(4, {
+        fields: ['id', 'email'],
+      });
+      expect(customer.deleted).to.be.undefined();
+      expect(customer2.deleted).to.be.undefined();
     });
     it('should return requested fields matched with fields filter', async () => {
       const customer = await repo.findById(4, {
@@ -400,17 +439,38 @@ describe('DefaultTransactionSoftCrudRepository', () => {
       });
       expect(customer).to.have.property('deleted');
     });
+
+    it('should return non soft deleted entry even if deleted column is not included in fields', async () => {
+      const customer = await repo.findById(4, {
+        fields: {
+          deleted: false,
+          deletedBy: false,
+          deletedOn: false,
+        },
+      });
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.undefined();
+    });
+
     it('should return requested fields only when not using deleted in fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email'],
       });
-      expect(customer).to.not.have.property('deleted');
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.deleted).to.be.undefined();
     });
+
     it('should return requested fields matched with fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email', 'deleted'],
       });
-      expect(customer).to.have.property('deleted');
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.false();
+      expect(customer.deletedBy).to.be.undefined();
     });
   });
 

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

@@ -163,6 +163,21 @@ describe('SoftCrudRepository', () => {
       });
       expect(deletedCustomers).to.have.length(0);
     });
+
+    it('should find non soft deleted entries when deleted fields are not included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(3);
+    });
+
+    it('should find non soft deleted entries when deleted fields are included', async () => {
+      const customers = await repo.find({
+        fields: {deleted: true},
+      });
+      expect(customers).to.have.length(3);
+    });
+
     it('should find non soft deleted entries with or operator', async () => {
       const customers = await repo.find({
         where: {
@@ -186,6 +201,14 @@ describe('SoftCrudRepository', () => {
       const customers = await repo.findAll();
       expect(customers).to.have.length(4);
     });
+
+    it('should find all entries when deleted fields are not included', async () => {
+      await setupTestData();
+      const customers = await repo.findAll({
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+      expect(customers).to.have.length(4);
+    });
   });
 
   describe('findOne', () => {
@@ -260,6 +283,17 @@ describe('SoftCrudRepository', () => {
       expect(customer).to.have.property('email').equal('[email protected]');
     });
 
+    it('should find one soft deleted entry even when `deleted` field is not included', async () => {
+      const customer = await repo.findOne({
+        where: {
+          id: 4,
+        },
+        fields: {deleted: false, deletedBy: false, deletedOn: false},
+      });
+
+      expect(customer?.id).to.have.be.eql(4);
+    });
+
     it('shound find none soft deleted entry using or operator', async () => {
       const customer = await repo.findOne({
         where: {
@@ -353,7 +387,7 @@ 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 () => {
+    it('should not return soft deleted entry by id when using fields filter without including deleted column', async () => {
       try {
         await repo.findById(3, {
           fields: {
@@ -383,7 +417,11 @@ describe('SoftCrudRepository', () => {
           email: true,
         },
       });
-      expect(customer).to.not.have.property('deleted');
+      const customer2 = await repo.findById(4, {
+        fields: ['id', 'email'],
+      });
+      expect(customer.deleted).to.be.undefined();
+      expect(customer2.deleted).to.be.undefined();
     });
     it('should return requested fields matched with fields filter', async () => {
       const customer = await repo.findById(4, {
@@ -395,17 +433,38 @@ describe('SoftCrudRepository', () => {
       });
       expect(customer).to.have.property('deleted');
     });
+
+    it('should return non soft deleted entry even if deleted column is not included in fields', async () => {
+      const customer = await repo.findById(4, {
+        fields: {
+          deleted: false,
+          deletedBy: false,
+          deletedOn: false,
+        },
+      });
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.undefined();
+    });
+
     it('should return requested fields only when not using deleted in fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email'],
       });
-      expect(customer).to.not.have.property('deleted');
+
+      expect(customer.id).to.be.eql(4);
+      expect(customer.deleted).to.be.undefined();
     });
+
     it('should return requested fields matched with fields filter array', async () => {
       const customer = await repo.findById(4, {
         fields: ['id', 'email', 'deleted'],
       });
-      expect(customer).to.have.property('deleted');
+      expect(customer.id).to.be.eql(4);
+      expect(customer.email).to.be.eql('[email protected]');
+      expect(customer.deleted).to.be.false();
+      expect(customer.deletedBy).to.be.undefined();
     });
   });