Merge pull request #800 from companieshouse/feature/psc-verification-web-persist-request-id

IDVA3-3300 Add optional headers parameter to psc-verification-web api calls

Author: kieo-ch

src/services/company-profile/service.ts

@@ -1,4 +1,4 @@
-import { IHttpClient } from "../../http";
+import { Headers, IHttpClient } from "../../http";
 import {
     CompanyProfile, CompanyProfileResource, RegisteredOfficeAddressResource, AccountsResource,
     NextAccountsResource, ConfirmationStatementResource, LinksResource, ForeignCompanyDetailsResource, ServiceAddressResource
@@ -16,8 +16,8 @@ export default class CompanyProfileService {
     *
     * @param number the company number to look up
     */
-    public async getCompanyProfile (number: string): Promise<Resource<CompanyProfile>> {
-        const resp = await this.client.httpGet(`/company/${number}`);
+    public async getCompanyProfile (number: string, headers?: Headers): Promise<Resource<CompanyProfile>> {
+        const resp = await this.client.httpGet(`/company/${number}`, headers);
 
         const resource: Resource<CompanyProfile> = {
             httpStatusCode: resp.status

src/services/company-psc/service.ts

@@ -1,4 +1,4 @@
-import { IHttpClient } from "../../http";
+import { Headers, IHttpClient } from "../../http";
 import { CompanyPersonsWithSignificantControlResource, CompanyPersonsWithSignificantControl } from "./types";
 import Resource from "../resource";
 import Mapping from "../../mapping/mapping";
@@ -14,8 +14,8 @@ export default class CompanyPscService {
    *
    * @param number the company number to look up
    */
-    public async getCompanyPsc (number: string, startIndex: number = 0, itemsPerPage: number = 25): Promise<Resource<CompanyPersonsWithSignificantControl>> {
-        const resp = await this.client.httpGet(`/company/${number}/persons-with-significant-control?start_index=${startIndex}&items_per_page=${itemsPerPage}`);
+    public async getCompanyPsc (number: string, startIndex: number = 0, itemsPerPage: number = 25, headers?: Headers): Promise<Resource<CompanyPersonsWithSignificantControl>> {
+        const resp = await this.client.httpGet(`/company/${number}/persons-with-significant-control?start_index=${startIndex}&items_per_page=${itemsPerPage}`, headers);
 
         const resource: Resource<CompanyPersonsWithSignificantControl> = {
             httpStatusCode: resp.status

src/services/psc-verification-link/service.ts

@@ -1,6 +1,6 @@
 import { PlannedMaintenance, PscVerification, PscVerificationData, ValidationStatusResponse, ValidationStatusResponseResource } from "./types"
 
-import { HttpResponse, IHttpClient } from "../../http";
+import { Headers, HttpResponse, IHttpClient } from "../../http";
 import Resource, { ApiErrorResponse, ApiResponse } from "../resource";
 import Mapping from "../../mapping/mapping";
 import { PersonWithSignificantControlResource } from "../psc/types";
@@ -22,10 +22,10 @@ export default class PscVerificationService {
      * - A `Resource<PscVerification>` object containing the created PSC verification details.
      * - An `ApiErrorResponse` object if an error occurs during the request.
      */
-    public async postPscVerification (transactionId: string, pscVerification: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse> {
+    public async postPscVerification (transactionId: string, pscVerification: PscVerificationData, headers?: Headers): Promise<Resource<PscVerification> | ApiErrorResponse> {
         const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification`;
         const pscVerificationResource = Mapping.snakeCaseKeys(pscVerification);
-        const response = await this.client.httpPost(resourceUri, pscVerificationResource);
+        const response = await this.client.httpPost(resourceUri, pscVerificationResource, headers);
 
         if (response.error) {
             return this.handleErrorResponse(response);
@@ -43,9 +43,9 @@ export default class PscVerificationService {
      * - A `Resource<PscVerification>` object containing the PSC verification details.
      * - An `ApiErrorResponse` object if an error occurs during the request.
      */
-    public async getPscVerification (transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse> {
+    public async getPscVerification (transactionId: string, pscVerificationId: string, headers?: Headers): Promise<Resource<PscVerification> | ApiErrorResponse> {
         const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${pscVerificationId}`;
-        const response = await this.client.httpGet(resourceUri);
+        const response = await this.client.httpGet(resourceUri, headers);
 
         if (response.error) {
             return this.handleErrorResponse(response);
@@ -64,8 +64,11 @@ export default class PscVerificationService {
      * - A `Resource<PscVerification>` object containing the updated PSC verification details.
      * - An `ApiErrorResponse` object if an error occurs during the request.
      */
-    public async patchPscVerification (transactionId: string, pscVerificationId: string, pscVerificationPatch: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse> {
-        const additionalHeaders = { "Content-Type": "application/merge-patch+json" };
+    public async patchPscVerification (transactionId: string, pscVerificationId: string, pscVerificationPatch: PscVerificationData, headers?: Headers): Promise<Resource<PscVerification> | ApiErrorResponse> {
+        const additionalHeaders = {
+            ...headers,
+            "Content-Type": "application/merge-patch+json"
+        };
         const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${pscVerificationId}`;
         const pscVerificationPatchResource = Mapping.snakeCaseKeys(pscVerificationPatch);
         const response = await this.client.httpPatch(resourceUri, pscVerificationPatchResource, additionalHeaders);
@@ -91,9 +94,9 @@ export default class PscVerificationService {
      * using the `handleErrorResponse` method. Otherwise, the response body is mapped to camelCase keys
      * and returned as part of the resource.
      */
-    public async getValidationStatus (transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse> {
+    public async getValidationStatus (transactionId: string, pscVerificationId: string, headers?: Headers): Promise<Resource<PscVerification> | ApiErrorResponse> {
         const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${pscVerificationId}/validation_status`;
-        const response = await this.client.httpGet(resourceUri);
+        const response = await this.client.httpGet(resourceUri, headers);
 
         if (response.error) {
             return this.handleErrorResponse(response);
@@ -115,9 +118,9 @@ export default class PscVerificationService {
      * - An `ApiResponse<PlannedMaintenance>` object containing maintenance details.
      * - An `ApiErrorResponse` object if an error occurs during the request.
      */
-    public async checkPlannedMaintenance (): Promise<ApiResponse<PlannedMaintenance> | ApiErrorResponse> {
+    public async checkPlannedMaintenance (headers?: Headers): Promise<ApiResponse<PlannedMaintenance> | ApiErrorResponse> {
         const maintenanceUri = `/persons-with-significant-control-verification/maintenance`;
-        const response = await this.client.httpGet(maintenanceUri);
+        const response = await this.client.httpGet(maintenanceUri, headers);
 
         if (response.error) {
             return this.handleErrorResponse(response);

src/services/psc/service.ts

@@ -1,4 +1,4 @@
-import { IHttpClient } from "../../http";
+import { Headers, IHttpClient } from "../../http";
 import Mapping from "../../mapping/mapping";
 import Resource, { ApiErrorResponse } from "../resource";
 import { PersonWithSignificantControl, PersonWithSignificantControlResource } from "./types";
@@ -15,9 +15,9 @@ export default class PscService {
    * @param companyNumber the Company Number to look up
    * @param pscNotificationId the PSC Notification ID to retrieve
    */
-    public async getPscIndividual (companyNumber: string, pscNotificationId: string): Promise<Resource<PersonWithSignificantControl> | ApiErrorResponse> {
+    public async getPscIndividual (companyNumber: string, pscNotificationId: string, headers?: Headers): Promise<Resource<PersonWithSignificantControl> | ApiErrorResponse> {
         const resourceUri = `/company/${companyNumber}/persons-with-significant-control/individual/${pscNotificationId}/verification-state`;
-        const response = await this.client.httpGet(resourceUri);
+        const response = await this.client.httpGet(resourceUri, headers);
 
         if (response.error) {
             return {

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);
+        });
     });
 });