Generate Proxy Headers lookup form/version Id when provided submissio…

…nId (#1478) * Generate Proxy Headers lookup form/version Id when provided submissionId Signed-off-by: Jason Sherman <[email protected]> * up the test coverage (and fix a bug!) Signed-off-by: Jason Sherman <[email protected]> --------- Signed-off-by: Jason Sherman <[email protected]>
bcgov · Aug 19, 2024 · cb022d7 · cb022d7
1 parent cdf4036
commit cb022d7
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 12 deletions.
diff --git a/app/src/forms/proxy/service.js b/app/src/forms/proxy/service.js
@@ -1,7 +1,7 @@
 const { encryptionService } = require('../../components/encryptionService');
 const jwtService = require('../../components/jwtService');
 const ProxyServiceError = require('./error');
-const { ExternalAPI } = require('../../forms/common/models');
+const { ExternalAPI, SubmissionMetadata } = require('../../forms/common/models');
 
 const headerValue = (headers, key) => {
   if (headers && key) {
@@ -19,15 +19,38 @@ const trimLeadingSlashes = (str) => str.replace(/^\/+|\$/g, '');
 const trimTrailingSlashes = (str) => str.replace(/\/+$/g, '');
 
 const service = {
+  _getIds: async (payload) => {
+    let formId = payload['formId'];
+    let versionId = payload['versionId'];
+    let submissionId = payload['submissionId'];
+    // when we are provided with a submission id (ex. submitting a draft submission)
+    // we need to fetch the related form and version id (if not provided)
+    if (submissionId) {
+      const meta = await SubmissionMetadata.query().where('submissionId', submissionId).first();
+      if (meta) {
+        formId = meta.formId;
+        versionId = meta.formVersionId;
+        submissionId = meta.submissionId;
+      }
+    }
+    return {
+      formId: formId,
+      versionId: versionId,
+      submissionId: submissionId,
+    };
+  },
+
   generateProxyHeaders: async (payload, currentUser, token) => {
     if (!payload || !currentUser || !currentUser.idp) {
       throw new ProxyServiceError('Cannot generate proxy headers with missing or incomplete parameters');
     }
 
+    const { formId, versionId, submissionId } = await service._getIds(payload);
+
     const headerData = {
-      formId: payload['formId'],
-      versionId: payload['versionId'],
-      submissionId: payload['submissionId'],
+      formId: formId,
+      versionId: versionId,
+      submissionId: submissionId,
       userId: currentUser.idpUserId,
       username: currentUser.username,
       firstName: currentUser.firstName,

diff --git a/app/tests/unit/forms/proxy/controller.spec.js b/app/tests/unit/forms/proxy/controller.spec.js
@@ -4,6 +4,7 @@ const { getMockReq, getMockRes } = require('@jest-mock/express');
 const controller = require('../../../../src/forms/proxy/controller');
 const service = require('../../../../src/forms/proxy/service');
 const jwtService = require('../../../../src/components/jwtService');
+
 const { NotFoundError } = require('objection');
 
 const bearerToken = Math.random().toString(36).substring(2);
@@ -29,6 +30,7 @@ describe('generateProxyHeaders', () => {
   };
 
   it('should generate headers', async () => {
+    service._getIds = jest.fn().mockReturnValue({ formId: '1234', versionId: '5678', submissionId: null });
     service.generateProxyHeaders = jest.fn().mockReturnValue({});
 
     await controller.generateProxyHeaders(req, {}, jest.fn());

diff --git a/app/tests/unit/forms/proxy/service.spec.js b/app/tests/unit/forms/proxy/service.spec.js
@@ -6,9 +6,11 @@ const { encryptionService, ENCRYPTION_ALGORITHMS } = require('../../../../src/co
 const service = require('../../../../src/forms/proxy/service');
 const { ExternalAPI } = require('../../../../src/forms/common/models');
 
+jest.mock('../../../../src/forms/common/models/views/submissionMetadata', () => MockModel);
+
 const goodPayload = {
   formId: '123',
-  submissionId: '456',
+  submissionId: null,
   versionId: '789',
 };
 
@@ -60,9 +62,42 @@ afterEach(() => {
 });
 
 describe('Proxy Service', () => {
+  describe('_getIds', () => {
+    beforeEach(() => {
+      MockModel.mockReset();
+    });
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+    it('should return all ids', async () => {
+      const payload = { formId: null, versionId: null, submissionId: '1' };
+      const meta = { formId: '2', formVersionId: '3', submissionId: '1' }; // meta query result
+      const ids = { formId: '2', versionId: '3', submissionId: '1' }; // _getIds result
+      MockModel.mockResolvedValue(meta);
+      const result = await service._getIds(payload);
+      await expect(result).toStrictEqual(ids);
+      expect(MockModel.query).toBeCalledTimes(1); // submission id means we query
+      expect(MockModel.first).toBeCalledTimes(1);
+    });
+    it('should return form and version id', async () => {
+      const payload = { formId: '2', versionId: '3', submissionId: null };
+      const ids = { formId: '2', versionId: '3', submissionId: null }; // _getIds result
+      const result = await service._getIds(payload);
+      await expect(result).toStrictEqual(ids);
+      expect(MockModel.query).toBeCalledTimes(0); // no submission id, no query
+    });
+    it('should return form and version id when submission id not found', async () => {
+      const payload = { formId: null, versionId: null, submissionId: '1' };
+      const meta = null; // meta query result
+      const ids = { formId: null, versionId: null, submissionId: '1' }; // _getIds result
+      MockModel.mockResolvedValue(meta);
+      const result = await service._getIds(payload);
+      await expect(result).toStrictEqual(ids);
+      expect(MockModel.query).toBeCalledTimes(1); // submission id means we query
+      expect(MockModel.first).toBeCalledTimes(1);
+    });
+  });
   describe('generateProxyHeaders', () => {
-    beforeEach(() => {});
-
     it('should throw error with no payload', async () => {
       await expect(service.generateProxyHeaders(undefined, goodCurrentUser, token)).rejects.toThrow();
     });
@@ -85,14 +120,33 @@ describe('Proxy Service', () => {
       const decrypted = encryptionService.decryptProxy(result['X-CHEFS-PROXY-DATA']);
       expect(JSON.parse(decrypted)).toMatchObject(goodProxyHeaderInfo);
     });
+    it('should find formId and versionId when given submissionId', async () => {
+      const submissionPayload = { submissionId: '456' };
+      const idsPaylad = { ...goodPayload, ...submissionPayload };
+      service._getIds = jest.fn().mockResolvedValueOnce(idsPaylad);
+      const submissionProxyHeaderInfo = {
+        ...idsPaylad,
+        ...goodCurrentUser,
+        userId: goodCurrentUser.idpUserId,
+        token: token,
+      };
+      delete submissionProxyHeaderInfo.idpUserId;
+
+      const result = await service.generateProxyHeaders(submissionPayload, goodCurrentUser, token);
+      expect(result).toBeTruthy();
+      expect(result['X-CHEFS-PROXY-DATA']).toBeTruthy();
+      // check the encryption...
+      const decrypted = encryptionService.decryptProxy(result['X-CHEFS-PROXY-DATA']);
+      expect(JSON.parse(decrypted)).toMatchObject(submissionProxyHeaderInfo);
+    });
   });
   describe('readProxyHeaders', () => {
-    beforeEach(() => {});
-
     it('should throw error with no headers', async () => {
       await expect(service.readProxyHeaders(undefined)).rejects.toThrow();
     });
-
+    it('should throw error with bad headers', async () => {
+      await expect(service.readProxyHeaders('string-not-object')).rejects.toThrow();
+    });
     it('should throw error with wrong header name', async () => {
       await expect(service.readProxyHeaders({ 'X-CHEFS-WRONG_HEADER_NAME': 'headers' })).rejects.toThrow();
     });
@@ -108,6 +162,8 @@ describe('Proxy Service', () => {
     });
 
     it('should return decrypted header data', async () => {
+      service._getIds = jest.fn().mockResolvedValueOnce({ ...goodPayload, submissionId: null });
+
       const headers = await service.generateProxyHeaders(goodPayload, goodCurrentUser, token);
       const decrypted = await service.readProxyHeaders(headers);
       expect(decrypted).toBeTruthy();
@@ -137,6 +193,12 @@ describe('Proxy Service', () => {
       await expect(service.getExternalAPI(headers, goodProxyHeaderInfo)).rejects.toThrow();
     });
 
+    it('should throw error with bad header', async () => {
+      // set the external api name...
+      const headers = 'string-not-object';
+      await expect(service.getExternalAPI(headers, goodProxyHeaderInfo)).rejects.toThrow();
+    });
+
     it('should throw error with no proxy header info', async () => {
       // set the external api name...
       const headers = { 'X-CHEFS-EXTERNAL-API-NAME': 'testapi' };
@@ -194,8 +256,6 @@ describe('Proxy Service', () => {
     });
   });
   describe('createExternalAPIHeaders', () => {
-    beforeEach(() => {});
-
     it('should throw error with no headers', async () => {
       const externalAPI = undefined;
       const proxyHeaderInfo = goodProxyHeaderInfo;