bug(fix) flow excessive fields (ENG-545)

Author: epankou

src/sequelize/managers/flow-manager.js

@@ -37,28 +37,19 @@ class FlowManager extends BaseManager {
     }, {transaction: transaction})
   }
 
-  async findAllExcludeFields(where, transaction) {
+  async findAllWithAttributes(where, attributes, transaction) {
     return Flow.findAll({
       where: where,
-      attributes: {
-        exclude: [
-          'created_at',
-          'updated_at',
-          'updatedById',
-          'userId'
-        ]}}, {transaction: transaction})
+      attributes: attributes},
+      {transaction: transaction})
   }
 
-  async findOneExcludeFields(where, transaction) {
+  async findOneWithAttributes(where, attributes, transaction) {
     return Flow.findOne({
       where: where,
-      attributes: {
-        exclude: [
-          'created_at',
-          'updated_at',
-          'updatedById',
-          'userId'
-        ]}}, {transaction: transaction})
+      attributes: attributes
+      },
+      {transaction: transaction})
     }
 }
 

src/services/flow-service.js

@@ -89,14 +89,16 @@ const getUserFlows = async function (user, isCLI, transaction) {
     userId: user.id
   };
 
-  const flows = await FlowManager.findAllExcludeFields(flow, transaction);
+  const attributes = {exclude: ["created_at", "updated_at"]};
+  const flows = await FlowManager.findAllWithAttributes(flow, attributes, transaction);
   return {
     flows: flows
   }
 };
 
 const getAllFlows = async function (isCLI, transaction) {
-  const flows = await FlowManager.findAll({}, transaction);
+  const attributes = {exclude: ['created_at', 'updated_at']};
+  const flows = await FlowManager.findAllWithAttributes({}, attributes, transaction);
   return {
     flows: flows
   }
@@ -107,7 +109,9 @@ const getFlow = async function (flowId, user, isCLI, transaction) {
     ? {id: flowId}
     : {id: flowId, userId: user.id};
 
-  const flow = await FlowManager.findOneExcludeFields(where, transaction);
+  const attributes = {exclude: ["created_at", "updated_at"]};
+
+  const flow = await FlowManager.findOneWithAttributes(where, attributes, transaction);
 
   if (!flow) {
     throw new Errors.NotFoundError(AppHelper.formatMessage(ErrorMessages.INVALID_FLOW_ID, flowId))

test/src/services/flow-service.test.js

@@ -279,7 +279,7 @@ describe('Flow Service', () => {
 
     beforeEach(() => {
       $sandbox.stub(Validator, 'validate').returns($validatorResponse);
-      $sandbox.stub(FlowManager, 'findOneExcludeFields').returns($findExcludedFlowResponse);
+      $sandbox.stub(FlowManager, 'findOneWithAttributes').returns($findExcludedFlowResponse);
       $sandbox.stub(FlowManager, 'findOne').returns($findFlowResponse);
       $sandbox.stub(AppHelper, 'deleteUndefinedFields').returns($deleteUndefinedFieldsResponse);
       $sandbox.stub(FlowManager, 'update').returns($updateFlowResponse);
@@ -301,24 +301,25 @@ describe('Flow Service', () => {
     });
 
     context('when Validator#validate() succeeds', () => {
-      it('calls FlowManager#findOneExcludeFields() with correct args', async () => {
+      it('calls FlowManager#findOneWithAttributes() with correct args', async () => {
         await $subject;
 
         const where = isCLI
           ? {id: flowId}
           : {id: flowId, userId: user.id};
-        expect(FlowManager.findOneExcludeFields).to.have.been.calledWith(where, transaction);
+        const attributes = {exclude: ["created_at", "updated_at"]};
+        expect(FlowManager.findOneWithAttributes).to.have.been.calledWith(where, attributes, transaction);
       });
 
-      context('when FlowManager#findOneExcludeFields() fails', () => {
+      context('when FlowManager#findOneWithAttributes() fails', () => {
         def('findExcludedFlowResponse', () => Promise.reject(error));
 
         it(`fails with ${error}`, () => {
           return expect($subject).to.be.rejectedWith(error);
         })
       });
 
-      context('when FlowManager#findOneExcludeFields() succeeds', () => {
+      context('when FlowManager#findOneWithAttributes() succeeds', () => {
         it('calls FlowManager#findOne() with correct args', async () => {
           await $subject;
 
@@ -433,23 +434,24 @@ describe('Flow Service', () => {
     def('findExcludedFlowResponse', () => Promise.resolve());
 
     beforeEach(() => {
-      $sandbox.stub(FlowManager, 'findAllExcludeFields').returns($findExcludedFlowResponse);
+      $sandbox.stub(FlowManager, 'findAllWithAttributes').returns($findExcludedFlowResponse);
     });
 
-    it('calls FlowManager#findAllExcludeFields() with correct args', async () => {
+    it('calls FlowManager#findAllWithAttributes() with correct args', async () => {
       await $subject;
-      expect(FlowManager.findAllExcludeFields).to.have.been.calledWith(flow, transaction);
+      const attributes = {exclude: ["created_at", "updated_at"]};
+      expect(FlowManager.findAllWithAttributes).to.have.been.calledWith(flow, attributes, transaction);
     });
 
-    context('when FlowManager#findAllExcludeFields() fails', () => {
+    context('when FlowManager#findAllWithAttributes() fails', () => {
       def('findExcludedFlowResponse', () => Promise.reject(error));
 
       it(`fails with ${error}`, () => {
         return expect($subject).to.be.rejectedWith(error);
       })
     });
 
-    context('when FlowManager#findAllExcludeFields() succeeds', () => {
+    context('when FlowManager#findAllWithAttributes() succeeds', () => {
       it('fulfills the promise', () => {
         return expect($subject).to.eventually.have.property('flows');
       })
@@ -465,23 +467,24 @@ describe('Flow Service', () => {
     def('findAllFlowsResponse', () => Promise.resolve());
 
     beforeEach(() => {
-      $sandbox.stub(FlowManager, 'findAll').returns($findAllFlowsResponse);
+      $sandbox.stub(FlowManager, 'findAllWithAttributes').returns($findAllFlowsResponse);
     });
 
-    it('calls FlowManager#findAll() with correct args', async () => {
+    it('calls FlowManager#findAllWithAttributes() with correct args', async () => {
       await $subject;
-      expect(FlowManager.findAll).to.have.been.calledWith({}, transaction);
+      const attributes = {exclude: ['created_at', 'updated_at']};
+      expect(FlowManager.findAllWithAttributes).to.have.been.calledWith({}, attributes, transaction);
     });
 
-    context('when FlowManager#findAll() fails', () => {
+    context('when FlowManager#findAllWithAttributes() fails', () => {
       def('findAllFlowsResponse', () => Promise.reject(error));
 
       it(`fails with ${error}`, () => {
         return expect($subject).to.be.rejectedWith(error);
       })
     });
 
-    context('when FlowManager#findAll() succeeds', () => {
+    context('when FlowManager#findAllWithAttributes() succeeds', () => {
       it('fulfills the promise', () => {
         return expect($subject).to.eventually.have.property('flows');
       })
@@ -502,26 +505,27 @@ describe('Flow Service', () => {
     def('findFlowResponse', () => Promise.resolve({}));
 
     beforeEach(() => {
-      $sandbox.stub(FlowManager, 'findOneExcludeFields').returns($findFlowResponse);
+      $sandbox.stub(FlowManager, 'findOneWithAttributes').returns($findFlowResponse);
     });
 
-    it('calls FlowManager#findOneExcludeFields() with correct args', async () => {
+    it('calls FlowManager#findOneWithAttributes() with correct args', async () => {
       await $subject;
       const where = isCLI
         ? {id: flowId}
         : {id: flowId, userId: user.id};
-      expect(FlowManager.findOneExcludeFields).to.have.been.calledWith(where, transaction);
+      const attributes = {exclude: ["created_at", "updated_at"]};
+      expect(FlowManager.findOneWithAttributes).to.have.been.calledWith(where, attributes, transaction);
     });
 
-    context('when FlowManager#findOneExcludeFields() fails', () => {
+    context('when FlowManager#findOneWithAttributes() fails', () => {
       def('findFlowResponse', () => Promise.reject(error));
 
       it(`fails with ${error}`, () => {
         return expect($subject).to.be.rejectedWith(error);
       })
     });
 
-    context('when FlowManager#findOneExcludeFields() succeeds', () => {
+    context('when FlowManager#findOneWithAttributes() succeeds', () => {
       it('fulfills the promise', () => {
         return expect($subject).to.eventually.deep.equal({});
       })