Add tests to verify usage of provided headers

Ensures that headers make it through to the resulting HTTP request.

Author: kieo-ch

test/services/company-profile/service.spec.ts

@@ -231,4 +231,21 @@ describe("company-profile", () => {
         expect(resource.links.filingHistory).to.be.undefined;
         expect(resource.hasSuperSecurePscs).to.be.undefined;
     });
+
+    it("uses provided headers", async () => {
+        const mockResponseBody : CompanyProfileResource = fullCompanyProfileMock;
+        const headers = { "X-Request-Id": "random-uuid" };
+
+        const mockGetResponse = {
+            status: 200,
+            body: mockResponseBody
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetResponse);
+        const companyProfile: CompanyProfileService = new CompanyProfileService(requestClient);
+        await companyProfile.getCompanyProfile("NUMBER-NOT-IMPORTANT", headers);
+
+        expect(mockRequest.calledOnce).to.be.true;
+        expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);
+    });
 });

test/services/company-psc/service.spec.ts

@@ -157,4 +157,10 @@ describe("company-psc", () => {
         await companyPsc.getCompanyPsc("123", 10);
         expect(mockRequest.calledWith("/company/123/persons-with-significant-control?start_index=10&items_per_page=25")).to.be.true;
     });
+
+    it("uses provided headers", async () => {
+        const headers = { "X-Request-Id": "random-uuid" };
+        await companyPsc.getCompanyPsc("123", 10, 20, headers);
+        expect(mockRequest.calledWith("/company/123/persons-with-significant-control?start_index=10&items_per_page=20", headers)).to.be.true;
+    });
 });

test/services/psc-verification-link/service.spec.ts

@@ -51,6 +51,16 @@ describe("PSC Verification Link", () => {
             expect(data.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(data.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpPost").resolves(mockPscVerificationCreatedResponse[201]);
+
+            const headers = { "X-Request-Id": "random-uuid" };
+            await pscService.postPscVerification(TRANSACTION_ID, PSC_VERIFICATION_CREATED, headers);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[2]).to.deep.equal(headers);
+        });
     });
 
     describe("GET endpoint", () => {
@@ -92,6 +102,16 @@ describe("PSC Verification Link", () => {
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockPscVerificationIndResponse[200]);
+
+            const headers = { "X-Request-Id": "random-uuid" };
+            await pscService.getPscVerification(TRANSACTION_ID, PSC_NOTIFICATION_ID, headers);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);
+        });
     });
 
     describe("PATCH endpoint", () => {
@@ -135,6 +155,17 @@ describe("PSC Verification Link", () => {
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpPatch").resolves(mockPscVerificationPatchIndResponse[200]);
+
+            const testHeaders = { "X-Request-Id": "random-uuid" };
+            const existingHeaders = { "Content-Type": "application/merge-patch+json" }; // These are inserted by patchPscVerification
+            await pscService.patchPscVerification(TRANSACTION_ID, FILING_ID, PSC_VERIFICATION_IND, testHeaders);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[2]).to.deep.equal({ ...existingHeaders, ...testHeaders });
+        });
     });
 
     describe("Validation status GET endpoint", () => {
@@ -192,6 +223,16 @@ describe("PSC Verification Link", () => {
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetValidationStatusResponse[200]);
+
+            const headers = { "X-Request-Id": "random-uuid" };
+            await pscService.getValidationStatus(TRANSACTION_ID, PSC_NOTIFICATION_ID, headers);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);
+        });
     });
 
     describe("checkPlannedMaintenance endpoint", () => {
@@ -223,5 +264,15 @@ describe("PSC Verification Link", () => {
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockPlannedMaintenanceResponse[200]);
+
+            const headers = { "X-Request-Id": "random-uuid" };
+            await pscService.checkPlannedMaintenance(headers);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);
+        });
     });
 });

test/services/psc/service.spec.ts

@@ -66,5 +66,15 @@ describe("PSC details", () => {
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
         });
+
+        it("uses provided headers", async () => {
+            const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockIndividualResponse[200]);
+            const headers = { "X-Request-Id": "random-uuid" };
+
+            await pscService.getPscIndividual(COMPANY_NUMBER, PSC_NOTIFICATION_ID, headers);
+
+            expect(mockRequest.calledOnce).to.be.true;
+            expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);
+        });
     });
 });