[#ICC-68] Update submitMessage content introducing ThirdPartyData

CreateMessage/__tests__/types.test.ts

@@ -4,6 +4,7 @@ import { readableReport } from "@pagopa/ts-commons/lib/reporters";
 import { ApiNewMessageWithContentOf } from "../types";
 import { PaymentData } from "@pagopa/io-functions-commons/dist/generated/definitions/PaymentData";
 import { json } from "express";
+import { ThirdPartyData } from "../../generated/definitions/ThirdPartyData";
 
 import { pipe } from "fp-ts/lib/function";
 import * as E from "fp-ts/lib/Either";
@@ -50,6 +51,51 @@ describe("ApiNewMessageWithContentOf", () => {
     );
   });
 
+  it("should decode Third Party Data", () => {
+    const aSubject = "my specific subject";
+    const aThirdPartyData = {
+      id: "ID"
+    };
+    const aMessageWithSuchSubject = {
+      content: { ...aMessageContent, subject: aSubject }
+    };
+
+    const aMessageWithThirdParty = {
+      ...aMessageWithSuchSubject,
+      content: {
+        ...aMessageContent,
+        subject: aSubject,
+        third_party_data: aThirdPartyData
+      }
+    };
+
+    const pattern = t.interface({ third_party_data: ThirdPartyData });
+
+    const codec = ApiNewMessageWithContentOf(pattern);
+
+    // positive scenario: we expect a match
+    pipe(
+      codec.decode(aMessageWithThirdParty),
+      E.fold(
+        e => fail(`Should have decoded the value: ${readableReport(e)}`),
+        e => {
+          expect(e.content.subject).toBe(aSubject);
+        }
+      )
+    );
+
+    // negative scenario: we expect a no-match
+    pipe(
+      codec.decode(aMessageWithSuchSubject),
+      E.fold(
+        _ => {
+          expect(true).toBe(true);
+        },
+        e => fail(`Should have not decoded the value: ${toString(e)}`)
+      )
+    );
+  });
+
   it("should decode a specific payment data", () => {
     const aPaymentData = { amount: 2, notice_number: "011111111111111111" };
     const aMessageWithSuchPaymentData = {

CreateMessage/handler.ts

@@ -82,6 +82,7 @@ import {
 } from "../utils/events/message";
 import { commonCreateMessageMiddlewares } from "../utils/message_middlewares";
 import { LegalData } from "../generated/definitions/LegalData";
+import { ThirdPartyData } from "../generated/definitions/ThirdPartyData";
 import {
   ApiNewMessageWithAdvancedFeatures,
   ApiNewMessageWithContentOf,
@@ -506,10 +507,16 @@ export function CreateMessage(
       AzureAllowBodyPayloadMiddleware(
         ApiNewMessageWithAdvancedFeatures,
         new Set([UserGroup.ApiMessageWriteAdvanced])
+      ),
+      // Allow only users in the ApiThirdPartyMessageWrite group to send messages with ThirdPartyData
+      AzureAllowBodyPayloadMiddleware(
+        ApiNewMessageWithContentOf(
+          t.interface({ third_party_data: ThirdPartyData })
+        ),
+        new Set([UserGroup.ApiThirdPartyMessageWrite])
       )
     ] as const)
   );
-
   return wrapRequestHandler(
     middlewaresWrap(
       // eslint-disable-next-line max-params

CreateMessage/types.ts

@@ -28,18 +28,18 @@ export const ApiNewMessageWithAdvancedFeatures = t.intersection([
   })
 ]);
 
+type PartialMessageContent = Partial<typeof ApiNewMessage._A["content"]>;
+
 /**
  * Codec that matches a Message with a specific content pattern
  *
  * @param contentPattern a coded that matches a content pattern
  * @returns a codec that specialize ApiNewMessage
  */
 export type ApiNewMessageWithContentOf<
-  T extends Partial<typeof ApiNewMessage._O["content"]>
+  T extends PartialMessageContent
 > = ApiNewMessage & { readonly content: T };
-export const ApiNewMessageWithContentOf = <
-  T extends Partial<typeof ApiNewMessage._O["content"]>
->(
+export const ApiNewMessageWithContentOf = <T extends PartialMessageContent>(
   contentPattern: t.Type<T, Partial<typeof ApiNewMessage._O["content"]>>
 ): t.Type<ApiNewMessage & { readonly content: T }, typeof ApiNewMessage._O> =>
   t.intersection([

__integrations__/index.test.ts

@@ -96,6 +96,10 @@ const aValidLegalMessageContent = {
   }
 };
 
+const aValidThirdPartyMessageContent = {
+  id: "ID"
+};
+
 // Must correspond to an existing serviceId within "services" colletion
 const aSubscriptionKey = "aSubscriptionKey";
 
@@ -197,6 +201,26 @@ describe("Create Message |> Middleware errors", () => {
     expect(response.status).toEqual(403);
   });
 
+  it("should return 403 when creating a third party message without right permission", async () => {
+    const nodeFetch = getNodeFetch({
+      "x-user-groups": "ApiMessageWrite"
+    });
+
+    const body = {
+      message: {
+        fiscal_code: anAutoFiscalCode,
+        content: {
+          ...aMessageContent,
+          third_party_data: aValidThirdPartyMessageContent
+        }
+      }
+    };
+
+    const response = await postCreateMessage(nodeFetch)(body);
+
+    expect(response.status).toEqual(403);
+  });
+
   it("should return 403 when creating an advanced message without right permission", async () => {
     const nodeFetch = getNodeFetch({
       "x-user-groups": "ApiMessageWrite"
@@ -341,6 +365,66 @@ describe("Create Message", () => {
   );
 });
 
+describe("Create Third Party Message", () => {
+  it.each`
+    profileType         | fiscalCode                       | serviceId
+    ${"LEGACY Profile"} | ${aLegacyInboxEnabledFiscalCode} | ${anEnabledServiceId}
+    ${"AUTO Profile"}   | ${anAutoFiscalCode}              | ${anEnabledServiceId}
+    ${"MANUAL Profile"} | ${aManualFiscalCode}             | ${anEnabledServiceId}
+  `(
+    "$profileType |> should return the message in PROCESSED status when service is allowed to send",
+    async ({ fiscalCode, serviceId }) => {
+      const body = {
+        message: {
+          fiscal_code: fiscalCode,
+          content: {
+            ...aMessageContent,
+            third_party_data: aValidThirdPartyMessageContent
+          }
+        }
+      };
+
+      const nodeFetch = getNodeFetch({
+        "x-subscription-id": serviceId,
+        "x-user-groups":
+          customHeaders["x-user-groups"] + ",ApiThirdPartyMessageWrite"
+      });
+
+      const result = await postCreateMessage(nodeFetch)(body);
+
+      expect(result.status).toEqual(201);
+
+      const messageId = ((await result.json()) as CreatedMessage).id;
+      expect(messageId).not.toBeUndefined();
+
+      // Wait the process to complete
+      await delay(WAIT_MS);
+
+      const resultGet = await getSentMessage(nodeFetch)(fiscalCode, messageId);
+
+      expect(resultGet.status).toEqual(200);
+      const detail = (await resultGet.json()) as ExternalMessageResponseWithContent;
+
+      expect(detail).toEqual(
+        expect.objectContaining({
+          message: expect.objectContaining({
+            ...body.message,
+            feature_level_type: FeatureLevelTypeEnum.STANDARD,
+            content: {
+              ...body.message.content,
+              third_party_data: {
+                ...body.message.content.third_party_data,
+                has_attachments: false
+              }
+            }
+          }),
+          status: MessageStatusValueEnum.PROCESSED
+        })
+      );
+    }
+  );
+});
+
 describe("Create Advanced Message", () => {
   it.each`
     profileType         | fiscalCode                       | serviceId

__integrations__/package.json

@@ -23,7 +23,7 @@
   "dependencies": {
     "@azure/cosmos": "^3.15.1",
     "@azure/storage-queue": "^12.7.0",
-    "@pagopa/io-functions-commons": "^24.1.2",
+    "@pagopa/io-functions-commons": "^24.5.0",
     "@types/jest": "^27.0.2",
     "@types/node": "^13.11.0",
     "azure-storage": "^2.10.5",

__integrations__/yarn.lock

@@ -609,10 +609,10 @@
   resolved "https://registry.yarnpkg.com/@opentelemetry/api/-/api-1.0.3.tgz#13a12ae9e05c2a782f7b5e84c3cbfda4225eaf80"
   integrity sha512-puWxACExDe9nxbBB3lOymQFrLYml2dVOrd7USiVRnSbgXE+KwBu+HxFvxrzfqsiSda9IWsXJG1ef7C1O2/GmKQ==
 
-"@pagopa/io-functions-commons@^24.1.2":
-  version "24.1.2"
-  resolved "https://registry.yarnpkg.com/@pagopa/io-functions-commons/-/io-functions-commons-24.1.2.tgz#2197eb7c71e92a54c1ba1a547ee143ad843dd528"
-  integrity sha512-8SoeklN5oMGhgzsg9dNHEtDMkZvsbg4aKzmUX1LGyGcO/6fBecmvl6I6ww738JzvYcaJ6ymT6s356jbSBSZkXQ==
+"@pagopa/io-functions-commons@^24.5.0":
+  version "24.5.0"
+  resolved "https://registry.yarnpkg.com/@pagopa/io-functions-commons/-/io-functions-commons-24.5.0.tgz#07b5c10a54d5fc0b196b6cdd7b3c4a7368f57f28"
+  integrity sha512-+LYDH9ZF7b/H7yriiY+aIV/3gsgnKJdF8bHifWYJ44ESIda8GSyqxTTkPr4Hn4hs9JPFiyt5Zgfs8h2NhHJjxQ==
   dependencies:
     "@azure/cosmos" "^3.15.1"
     "@pagopa/ts-commons" "^10.3.0"

openapi/index.yaml

@@ -1027,6 +1027,31 @@ definitions:
         type: string
     required:
       - auth_code
+  ThirdPartyData:
+    type: object
+    description: >-
+      Payload containing all information needed to retrieve and visualize third
+      party message details
+    properties:
+      id:
+        type: string
+        description: >-
+          Unique id for retrieving third party enriched information about the
+          message
+      original_sender:
+        type: string
+        description: Either a ServiceId or a simple string representing the sender name
+        minLength: 1
+      original_receipt_date:
+        $ref: '#/definitions/Timestamp'
+      has_attachments:
+        type: boolean
+        default: false
+      summary:
+        type: string
+        minLength: 1
+    required:
+      - id
   OrganizationFiscalCode:
     type: string
     description: Organization fiscal code.
@@ -1172,6 +1197,8 @@ definitions:
             $ref: '#/definitions/LegalData'
           eu_covid_cert:
             $ref: '#/definitions/EUCovidCert'
+          third_party_data:
+            $ref: '#/definitions/ThirdPartyData'
           due_date:
             $ref: '#/definitions/Timestamp'
   NewMessageContent:
@@ -1187,6 +1214,8 @@ definitions:
             $ref: '#/definitions/PrescriptionData'
           eu_covid_cert:
             $ref: '#/definitions/EUCovidCert'
+          third_party_data:
+            $ref: '#/definitions/ThirdPartyData'
           legal_data:
             $ref: '#/definitions/LegalData'
   NewMessage:

openapi/index.yaml.template

@@ -780,6 +780,8 @@ definitions:
     $ref: "../node_modules/@pagopa/io-functions-commons/openapi/definitions.yaml#/CreatedMessageWithContent"
   EUCovidCert:
     $ref: "../node_modules/@pagopa/io-functions-commons/openapi/definitions.yaml#/EUCovidCert"
+  ThirdPartyData: 
+    $ref: "../node_modules/@pagopa/io-functions-commons/openapi/definitions.yaml#/ThirdPartyData"
   OrganizationFiscalCode:
     $ref: "../node_modules/@pagopa/io-functions-commons/openapi/definitions.yaml#/OrganizationFiscalCode"
   FiscalCode:

package.json

@@ -61,7 +61,7 @@
   "dependencies": {
     "@azure/cosmos": "^3.15.1",
     "@pagopa/express-azure-functions": "^2.0.0",
-    "@pagopa/io-functions-commons": "^24.1.2",
+    "@pagopa/io-functions-commons": "^24.5.0",
     "@pagopa/ts-commons": "^10.2.0",
     "applicationinsights": "^1.7.4",
     "azure-storage": "^2.10.4",

yarn.lock

@@ -743,10 +743,10 @@
   resolved "https://registry.yarnpkg.com/@pagopa/express-azure-functions/-/express-azure-functions-2.0.0.tgz#eb52a0b997d931c1509372e2a9bea22a8ca85c17"
   integrity sha512-IFZqtk0e2sfkMZIxYqPORzxcKRkbIrVJesR6eMLNwzh1rA4bl2uh9ZHk1m55LNq4ZmaxREDu+1JcGlIaZQgKNQ==
 
-"@pagopa/io-functions-commons@^24.1.2":
-  version "24.1.2"
-  resolved "https://registry.yarnpkg.com/@pagopa/io-functions-commons/-/io-functions-commons-24.1.2.tgz#2197eb7c71e92a54c1ba1a547ee143ad843dd528"
-  integrity sha512-8SoeklN5oMGhgzsg9dNHEtDMkZvsbg4aKzmUX1LGyGcO/6fBecmvl6I6ww738JzvYcaJ6ymT6s356jbSBSZkXQ==
+"@pagopa/io-functions-commons@^24.5.0":
+  version "24.5.0"
+  resolved "https://registry.yarnpkg.com/@pagopa/io-functions-commons/-/io-functions-commons-24.5.0.tgz#07b5c10a54d5fc0b196b6cdd7b3c4a7368f57f28"
+  integrity sha512-+LYDH9ZF7b/H7yriiY+aIV/3gsgnKJdF8bHifWYJ44ESIda8GSyqxTTkPr4Hn4hs9JPFiyt5Zgfs8h2NhHJjxQ==
   dependencies:
     "@azure/cosmos" "^3.15.1"
     "@pagopa/ts-commons" "^10.3.0"