feat: added the isFiscalCodeWhitelisted() endpoint to check if the fiscal code is whitelisted

Refs: #1209 SIW-2188

Author: christianatzeni

.changeset/quick-radios-brush.md

@@ -0,0 +1,5 @@
+---
+"@pagopa/io-backend": minor
+---
+
+Added GET /whitelisted-fiscal-code/{fiscalCode} IO Wallet endpoint to check if the fiscal code is whitelisted

api_io_wallet.yaml

@@ -152,6 +152,22 @@ paths:
           $ref: "#/components/responses/Unexpected"
         "503":
           $ref: "#/components/responses/ServiceUnavailable"
+  
+  /whitelisted-fiscal-code:
+    get:
+      operationId: isFiscalCodeWhitelisted
+      summary: Used to check if the fiscal code is in the whitelist
+      responses:
+        "200":
+          description: Returned when no issues were found in either case (fiscal code whitelisted, or not)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/WhitelistedFiscalCodeData"
+        "500":
+          $ref: "#/components/responses/Unexpected"
+        "503":
+          $ref: "#/components/responses/ServiceUnavailable"
 
 components:
   securitySchemes:
@@ -287,6 +303,26 @@ components:
         - id
         - is_revoked
 
+    WhitelistedFiscalCodeData:
+      type: object
+      required:
+        - whitelisted
+        - fiscalCode
+      properties:
+        whitelisted:
+          type: boolean
+          description: |-
+            Boolean value that specifies whether the tax code is whitelisted or not.
+        whitelistedAt:
+          type: string
+          description: |-
+            Date, expressed in ISO 8601 format, when the fiscal code was added to the whitelist.
+            Only present if the fiscal code is whitelisted.
+        fiscalCode:
+          type: string
+          description: |-
+            The fiscal code, the same one passed in input.
+
     RevocationReason:
       type: string
       enum:

package.json

@@ -62,7 +62,7 @@
     "generate:proxy:api-session": "rimraf generated/session && gen-api-models --api-spec api_session.yaml --out-dir generated/session",
     "generate:lollipop-definitions": "rimraf generated/lollipop && gen-api-models --api-spec openapi/lollipop_definitions.yaml --out-dir generated/lollipop",
     "generate:lollipop-first-sign": "rimraf generated/lollipop-first-consumer && gen-api-models --api-spec openapi/consumed/lollipop_first_consumer.yaml --out-dir generated/lollipop-first-consumer --request-types --response-decoders --client",
-    "generate:api:io-wallet": "rimraf generated/io-wallet-api && gen-api-models --api-spec https://raw.githubusercontent.com/pagopa/io-wallet/io-wallet-user-func@3.0.4/apps/io-wallet-user-func/openapi.yaml --no-strict --out-dir generated/io-wallet-api --request-types --response-decoders --client",
+    "generate:api:io-wallet": "rimraf generated/io-wallet-api && gen-api-models --api-spec https://raw.githubusercontent.com/pagopa/io-wallet/io-wallet-user-func@3.2.2/apps/io-wallet-user-func/openapi.yaml --no-strict --out-dir generated/io-wallet-api --request-types --response-decoders --client",
     "generate:proxy:io-wallet-models": "rimraf generated/io-wallet && gen-api-models --api-spec api_io_wallet.yaml --out-dir generated/io-wallet",
     "dist:modules": "modclean -r -n default:safe && yarn install --production",
     "predeploy": "npm-run-all generate build dist:modules",

src/controllers/ioWalletController.ts

@@ -30,6 +30,7 @@ import { NonceDetailView } from "../../generated/io-wallet/NonceDetailView";
 import { SetWalletInstanceStatusBody } from "../../generated/io-wallet/SetWalletInstanceStatusBody";
 import { WalletAttestationView } from "../../generated/io-wallet/WalletAttestationView";
 import { WalletInstanceData } from "../../generated/io-wallet/WalletInstanceData";
+import { WhitelistedFiscalCodeData } from "../../generated/io-wallet/WhitelistedFiscalCodeData";
 import { FF_IO_WALLET_TRIAL_ENABLED } from "../config";
 import IoWalletService from "../services/ioWalletService";
 import { withUserFromRequest } from "../types/user";
@@ -233,6 +234,21 @@ export default class IoWalletController {
       )
     );
 
+  /**
+   * Check if a fiscal code is whitelisted or not.
+   */
+  public readonly isFiscalCodeWhitelisted = (
+    req: express.Request
+  ): Promise<
+    | IResponseSuccessJson<WhitelistedFiscalCodeData>
+    | IResponseErrorInternal
+    | IResponseErrorServiceUnavailable
+    | IResponseErrorValidation
+  > =>
+    withUserFromRequest(req, async (user) =>
+      this.ioWalletService.isFiscalCodeWhitelisted(user.fiscal_code)
+    );
+
   private readonly ensureFiscalCodeIsAllowed = (fiscalCode: FiscalCode) =>
     FF_IO_WALLET_TRIAL_ENABLED
       ? pipe(

src/routes/ioWalletRoutes.ts

@@ -71,4 +71,13 @@ export const registerIoWalletAPIRoutes = (
       ioWalletController
     )
   );
+
+  app.get(
+    `${basePath}/whitelisted-fiscal-code`,
+    bearerSessionTokenAuth,
+    toExpressHandler(
+      ioWalletController.isFiscalCodeWhitelisted,
+      ioWalletController
+    )
+  );
 };

src/services/__tests__/ioWalletService.test.ts

@@ -16,6 +16,8 @@ const mockGetWalletInstanceStatus = jest.fn();
 const mockGetCurrentWalletInstanceStatus = jest.fn();
 const mockSetWalletInstanceStatus = jest.fn();
 const mockDeleteWalletInstances = jest.fn();
+const mockIsFiscalCodeWhitelisted = jest.fn();
+const mockCreateWalletAttestationV2 = jest.fn();
 
 mockGetNonce.mockImplementation(() =>
   t.success({
@@ -67,16 +69,30 @@ mockSetWalletInstanceStatus.mockImplementation(() =>
   })
 );
 
+mockIsFiscalCodeWhitelisted.mockImplementation(() =>
+  t.success({
+    status: 200,
+  })
+);
+
+mockCreateWalletAttestationV2.mockImplementation(() =>
+  t.success({
+    status: 201,
+  })
+);
+
 const api = {
   getEntityConfiguration: mockGetEntityConfiguration,
   getNonce: mockGetNonce,
   createWalletInstance: mockCreateWalletInstance,
   createWalletAttestation: mockCreateWalletAttestation,
+  createWalletAttestationV2: mockCreateWalletAttestationV2,
   healthCheck: mockHealthCheck,
   getWalletInstanceStatus: mockGetWalletInstanceStatus,
   setWalletInstanceStatus: mockSetWalletInstanceStatus,
   deleteWalletInstances: mockDeleteWalletInstances,
   getCurrentWalletInstanceStatus: mockGetCurrentWalletInstanceStatus,
+  isFiscalCodeWhitelisted: mockIsFiscalCodeWhitelisted,
 };
 
 const mockCreateSubscription = jest.fn();
@@ -772,6 +788,118 @@ describe("IoWalletService#getCurrentWalletInstanceStatus", () => {
   });
 });
 
+describe("IoWalletService#isFiscalCodeWhitelisted", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("should make the correct api call", async () => {
+    const service = new IoWalletService(api, trialSystemApi);
+
+    await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(mockIsFiscalCodeWhitelisted).toHaveBeenCalledWith({
+      fiscalCode: aFiscalCode,
+    });
+  });
+
+  it("should handle a success response", async () => {
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseSuccessJson",
+    });
+  });
+
+  it("should handle an internal error when the API client returns 500", async () => {
+    const aGenericProblem = {};
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() =>
+      t.success({ status: 500, value: aGenericProblem })
+    );
+
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorInternal",
+    });
+  });
+
+  it("should handle an internal error when the API client returns 400", async () => {
+    const aGenericProblem = {};
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() =>
+      t.success({ status: 400, value: aGenericProblem })
+    );
+
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorInternal",
+    });
+  });
+
+  it("should handle an internal error when the API client returns 422", async () => {
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() =>
+      t.success({ status: 422 })
+    );
+
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorInternal",
+    });
+  });
+
+  it("should handle a service unavailable error when the API client returns 503", async () => {
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() =>
+      t.success({ status: 503 })
+    );
+
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorServiceUnavailable",
+    });
+  });
+
+  it("should handle an internal error when the API client returns a code not specified in spec", async () => {
+    const aGenericProblem = {};
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() =>
+      t.success({ status: 599, value: aGenericProblem })
+    );
+
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorInternal",
+    });
+  });
+
+  it("should return an error if the api call throws an error", async () => {
+    mockIsFiscalCodeWhitelisted.mockImplementationOnce(() => {
+      throw new Error();
+    });
+    const service = new IoWalletService(api, trialSystemApi);
+
+    const res = await service.isFiscalCodeWhitelisted(aFiscalCode);
+
+    expect(res).toMatchObject({
+      kind: "IResponseErrorInternal",
+    });
+  });
+});
+
 describe("IoWalletService#getSubscription", () => {
   beforeEach(() => {
     jest.clearAllMocks();

src/services/ioWalletService.ts

@@ -23,6 +23,7 @@ import * as O from "fp-ts/Option";
 import { pipe } from "fp-ts/lib/function";
 import { Grant_typeEnum } from "generated/io-wallet-api/CreateWalletAttestationBody";
 import { NonceDetailView } from "generated/io-wallet-api/NonceDetailView";
+import { WhitelistedFiscalCodeData } from "generated/io-wallet-api/WhitelistedFiscalCodeData";
 
 import { SetWalletInstanceStatusWithFiscalCodeData } from "../../generated/io-wallet-api/SetWalletInstanceStatusWithFiscalCodeData";
 import { WalletAttestationView } from "../../generated/io-wallet-api/WalletAttestationView";
@@ -366,4 +367,39 @@ export default class IoWalletService {
         }
       });
     });
+
+  /**
+   * Check if the fiscal code is whitelisted or not.
+   */
+  public readonly isFiscalCodeWhitelisted = (
+    fiscalCode: FiscalCode
+  ): Promise<
+    | IResponseErrorInternal
+    | IResponseSuccessJson<WhitelistedFiscalCodeData>
+    | IResponseErrorServiceUnavailable
+  > =>
+    withCatchAsInternalError(async () => {
+      const validated = await this.ioWalletApiClient.isFiscalCodeWhitelisted({
+        fiscalCode
+      });
+      return withValidatedOrInternalError(validated, (response) => {
+        switch (response.status) {
+          case 200:
+            return ResponseSuccessJson(response.value);
+          case 400:
+          case 422:
+          case 500:
+            return ResponseErrorInternal(
+              `Internal server error | ${response.value}`
+            );
+          case 503:
+            return ResponseErrorServiceTemporarilyUnavailable(
+              serviceUnavailableDetail,
+              "10"
+            );
+          default:
+            return ResponseErrorStatusNotDefinedInSpec(response);
+        }
+      });
+    });
 }