PIN-5555 eservice delegateClientAccess

collections/bff/catalog/Create a new EService.bru

@@ -21,7 +21,9 @@ body:json {
     "description": "This is a test from BFF",
     "technology": "SOAP",
     "mode": "DELIVER",
-    "isSignalHubEnabled": true
+    "isSignalHubEnabled": true,
+    "isDelegable": true,
+    "isClientAccessDelegable": true
   }
 }
 

collections/bff/catalog/Update EService general information.bru

@@ -25,7 +25,9 @@ body:json {
     "description": "test eservice updated from BFF",
     "technology": "SOAP",
     "mode": "RECEIVE",
-    "isSignalHubEnabled": false
+    "isSignalHubEnabled": false,
+    "isDelegable": false,
+    "isClientAccessDelegable": false
   }
 }
 

packages/api-clients/open-api/apiGatewayApi.yml

@@ -2619,6 +2619,10 @@ components:
             type: string
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     EServiceAttributes:
       description: the attributes set associated to the EService
       properties:

packages/api-clients/open-api/bffApi.yml

@@ -12973,6 +12973,10 @@ components:
           $ref: "#/components/schemas/EServiceMode"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     EServiceSeed:
       type: object
       additionalProperties: false
@@ -12992,6 +12996,10 @@ components:
           $ref: "#/components/schemas/EServiceMode"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     UpdateEServiceDescriptorQuotas:
       required:
         - voucherLifespan
@@ -13239,6 +13247,10 @@ components:
           $ref: "#/components/schemas/Mail"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     ProducerEServiceDetails:
       type: object
       additionalProperties: false
@@ -13267,6 +13279,10 @@ components:
             $ref: "#/components/schemas/EServiceRiskAnalysis"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     EServiceMode:
       type: string
       description: Risk Analysis Mode
@@ -13394,6 +13410,10 @@ components:
           $ref: "#/components/schemas/Mail"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     EServiceDoc:
       type: object
       additionalProperties: false

packages/api-clients/open-api/catalogApi.yml

@@ -1128,6 +1128,10 @@ components:
           $ref: "#/components/schemas/DescriptorSeedForEServiceCreation"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     UpdateEServiceSeed:
       type: object
       additionalProperties: false
@@ -1151,6 +1155,10 @@ components:
           $ref: "#/components/schemas/EServiceMode"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     DescriptorSeedForEServiceCreation:
       required:
         - audience
@@ -1459,6 +1467,10 @@ components:
           $ref: "#/components/schemas/EServiceMode"
         isSignalHubEnabled:
           type: boolean
+        isDelegable:
+          type: boolean
+        isClientAccessDelegable:
+          type: boolean
     EServiceMode:
       type: string
       description: Risk Analysis Mode

packages/api-gateway/src/services/catalogService.ts

@@ -255,5 +255,7 @@ export async function enhanceEservice(
     serverUrls: latestNonDraftDescriptor.serverUrls,
     producer: producerOrganization,
     isSignalHubEnabled: eservice.isSignalHubEnabled,
+    isDelegable: eservice.isDelegable,
+    isClientAccessDelegable: eservice.isClientAccessDelegable,
   };
 }

packages/backend-for-frontend/src/api/catalogApiConverter.ts

@@ -119,6 +119,8 @@ export function toBffCatalogDescriptorEService(
       toBffCatalogApiEserviceRiskAnalysis
     ),
     isSignalHubEnabled: eservice.isSignalHubEnabled,
+    isDelegable: eservice.isDelegable,
+    isClientAccessDelegable: eservice.isClientAccessDelegable,
   };
 }
 
@@ -265,6 +267,8 @@ export function toBffCatalogApiProducerDescriptorEService(
     ),
     descriptors: notDraftDecriptors,
     isSignalHubEnabled: eservice.isSignalHubEnabled,
+    isDelegable: eservice.isDelegable,
+    isClientAccessDelegable: eservice.isClientAccessDelegable,
   };
 }
 

packages/backend-for-frontend/src/model/types.ts

@@ -208,5 +208,7 @@ export const ConfigurationEservice = z.object({
   descriptor: ConfigurationDescriptor,
   riskAnalysis: z.array(ConfigurationRiskAnalysis),
   isSignalHubEnabled: z.boolean().optional(),
+  isDelegable: z.boolean().optional(),
+  isClientAccessDelegable: z.boolean().optional(),
 });
 export type ConfigurationEservice = z.infer<typeof ConfigurationEservice>;

packages/backend-for-frontend/src/services/catalogService.ts

@@ -326,6 +326,8 @@ export function catalogServiceBuilder(
           toBffCatalogApiEserviceRiskAnalysis
         ),
         isSignalHubEnabled: eservice.isSignalHubEnabled,
+        isDelegable: eservice.isDelegable,
+        isClientAccessDelegable: eservice.isClientAccessDelegable,
       };
     },
     updateEServiceDescription: async (
@@ -1131,6 +1133,8 @@ export function catalogServiceBuilder(
             importedEservice.descriptor.agreementApprovalPolicy,
         },
         isSignalHubEnabled: importedEservice.isSignalHubEnabled,
+        isDelegable: importedEservice.isDelegable,
+        isClientAccessDelegable: importedEservice.isClientAccessDelegable,
       };
 
       const pollEServiceById = createPollingByCondition(() =>

packages/backend-for-frontend/src/utilities/fileUtils.ts

@@ -81,6 +81,8 @@ export function buildJsonConfig(
     technology: eservice.technology,
     mode: eservice.mode,
     isSignalHubEnabled: eservice.isSignalHubEnabled,
+    isDelegable: eservice.isDelegable,
+    isClientAccessDelegable: eservice.isClientAccessDelegable,
     descriptor: {
       interface: descriptor.interface && {
         prettyName: descriptor.interface.prettyName,

packages/catalog-process/src/model/domain/apiConverter.ts

@@ -196,4 +196,6 @@ export const eServiceToApiEService = (
   })),
   descriptors: eservice.descriptors.map(descriptorToApiDescriptor),
   isSignalHubEnabled: eservice.isSignalHubEnabled,
+  isDelegable: eservice.isDelegable,
+  isClientAccessDelegable: eservice.isClientAccessDelegable,
 });

packages/catalog-process/src/services/catalogService.ts

@@ -37,7 +37,7 @@ import {
   eserviceMode,
 } from "pagopa-interop-models";
 import { catalogApi } from "pagopa-interop-api-clients";
-import { match } from "ts-pattern";
+import { match, P } from "ts-pattern";
 import {
   apiAgreementApprovalPolicyToAgreementApprovalPolicy,
   apiEServiceModeToEServiceMode,
@@ -437,6 +437,12 @@ export function catalogServiceBuilder(
         createdAt: creationDate,
         riskAnalysis: [],
         isSignalHubEnabled: seed.isSignalHubEnabled,
+        isDelegable: seed.isDelegable,
+        isClientAccessDelegable: match(seed.isDelegable)
+          .with(P.nullish, () => undefined)
+          .with(false, () => false)
+          .with(true, () => seed.isClientAccessDelegable)
+          .exhaustive(),
       };
 
       const eserviceCreationEvent = toCreateEventEServiceAdded(
@@ -558,6 +564,12 @@ export function catalogServiceBuilder(
             }))
           : eservice.data.descriptors,
         isSignalHubEnabled: eserviceSeed.isSignalHubEnabled,
+        isDelegable: eserviceSeed.isDelegable,
+        isClientAccessDelegable: match(eserviceSeed.isDelegable)
+          .with(P.nullish, () => undefined)
+          .with(false, () => false)
+          .with(true, () => eserviceSeed.isClientAccessDelegable)
+          .exhaustive(),
       };
 
       const event = toCreateEventEServiceUpdated(

packages/catalog-process/test/createEService.test.ts

@@ -14,6 +14,7 @@ import {
   generateId,
 } from "pagopa-interop-models";
 import { expect, describe, it, beforeAll, vi, afterAll } from "vitest";
+import { match } from "ts-pattern";
 import {
   eServiceDuplicate,
   inconsistentDailyCalls,
@@ -41,6 +42,107 @@ describe("create eservice", () => {
   });
   it("should write on event-store for the creation of an eservice", async () => {
     const isSignalHubEnabled = randomArrayItem([false, true, undefined]);
+    const isDelegable = randomArrayItem([false, true, undefined]);
+    const isClientAccessDelegable = match(isDelegable)
+      .with(undefined, () => undefined)
+      .with(true, () => randomArrayItem([false, true, undefined]))
+      .with(false, () => false)
+      .exhaustive();
+
+    const eservice = await catalogService.createEService(
+      {
+        name: mockEService.name,
+        description: mockEService.description,
+        technology: "REST",
+        mode: "DELIVER",
+        descriptor: buildDescriptorSeedForEserviceCreation(mockDescriptor),
+        isSignalHubEnabled,
+        isDelegable,
+        isClientAccessDelegable,
+      },
+      {
+        authData: getMockAuthData(mockEService.producerId),
+        correlationId: generateId(),
+        serviceName: "",
+        logger: genericLogger,
+      }
+    );
+
+    expect(eservice).toBeDefined();
+
+    const eserviceCreationEvent = await readEventByStreamIdAndVersion(
+      eservice.id,
+      0,
+      "catalog",
+      postgresDB
+    );
+    const descriptorCreationEvent = await readLastEserviceEvent(eservice.id);
+
+    expect(eserviceCreationEvent).toMatchObject({
+      stream_id: eservice.id,
+      version: "0",
+      type: "EServiceAdded",
+      event_version: 2,
+    });
+    expect(descriptorCreationEvent).toMatchObject({
+      stream_id: eservice.id,
+      version: "1",
+      type: "EServiceDescriptorAdded",
+      event_version: 2,
+    });
+
+    const eserviceCreationPayload = decodeProtobufPayload({
+      messageType: EServiceAddedV2,
+      payload: eserviceCreationEvent.data,
+    });
+    const descriptorCreationPayload = decodeProtobufPayload({
+      messageType: EServiceDescriptorAddedV2,
+      payload: descriptorCreationEvent.data,
+    });
+
+    const expectedEservice: EService = {
+      ...mockEService,
+      createdAt: new Date(),
+      id: eservice.id,
+      descriptors: [],
+      isSignalHubEnabled,
+      isDelegable,
+      isClientAccessDelegable,
+    };
+    const expectedEserviceWithDescriptor: EService = {
+      ...mockEService,
+      createdAt: new Date(),
+      id: eservice.id,
+      isSignalHubEnabled,
+      isDelegable,
+      isClientAccessDelegable,
+      descriptors: [
+        {
+          ...mockDescriptor,
+          id: eservice.descriptors[0].id,
+          createdAt: new Date(),
+          serverUrls: [],
+        },
+      ],
+    };
+
+    expect(eserviceCreationPayload.eservice).toEqual(
+      toEServiceV2(expectedEservice)
+    );
+    expect(descriptorCreationPayload.eservice).toEqual(
+      toEServiceV2(expectedEserviceWithDescriptor)
+    );
+  });
+
+  it("should create an eservice correctly handling isClientAccessDelegable when isDelegable is not true", async () => {
+    const isSignalHubEnabled = randomArrayItem([false, true, undefined]);
+    const isDelegable: false | undefined = randomArrayItem([false, undefined]);
+    const isClientAccessDelegable = randomArrayItem([false, true, undefined]);
+    const expectedIsClientAccessDelegable = match(isDelegable)
+      .with(false, () => false)
+      .with(undefined, () => undefined)
+      .exhaustive();
+
     const eservice = await catalogService.createEService(
       {
         name: mockEService.name,
@@ -49,6 +151,8 @@ describe("create eservice", () => {
         mode: "DELIVER",
         descriptor: buildDescriptorSeedForEserviceCreation(mockDescriptor),
         isSignalHubEnabled,
+        isDelegable,
+        isClientAccessDelegable,
       },
       {
         authData: getMockAuthData(mockEService.producerId),
@@ -96,12 +200,16 @@ describe("create eservice", () => {
       id: eservice.id,
       descriptors: [],
       isSignalHubEnabled,
+      isDelegable,
+      isClientAccessDelegable: expectedIsClientAccessDelegable,
     };
     const expectedEserviceWithDescriptor: EService = {
       ...mockEService,
       createdAt: new Date(),
       id: eservice.id,
       isSignalHubEnabled,
+      isDelegable,
+      isClientAccessDelegable: expectedIsClientAccessDelegable,
       descriptors: [
         {
           ...mockDescriptor,

packages/catalog-process/test/getEserviceById.test.ts

@@ -33,6 +33,9 @@ describe("get eservice by id", () => {
       id: generateId(),
       name: "eservice 001",
       descriptors: [descriptor1],
+      isSignalHubEnabled: true,
+      isDelegable: true,
+      isClientAccessDelegable: true,
     };
     await addOneEService(eservice1);
     const authData: AuthData = {

packages/catalog-process/test/getEservices.test.ts

@@ -60,6 +60,9 @@ describe("get eservices", () => {
       name: "eservice 001 test",
       descriptors: [descriptor1],
       producerId: organizationId1,
+      isSignalHubEnabled: true,
+      isDelegable: true,
+      isClientAccessDelegable: true,
     };
     await addOneEService(eservice1);