feat: [IOCOM-793] Rename the sagas in the features/messages/saga fo…

…lder (#5403) ## Short description This PR renames all the sagas in the `features/messages/saga` folder. ## List of changes proposed in this pull request - renamed the sagas using the `handle` prefix - created `watchMessagesSaga` to listen to all messages actions and updated startup saga - updated tests ## How to test Tests should be solved correctly --------- Co-authored-by: Andrea <[email protected]>
pagopa · Jan 17, 2024 · b33bafb · b33bafb
1 parent a320053
commit b33bafb
Show file tree

Hide file tree

Showing 25 changed files with 665 additions and 805 deletions.
diff --git a/ts/api/__mocks__/backend.ts b/ts/api/__mocks__/backend.ts
@@ -1,9 +1,10 @@
 /**
  * Mocked version of the BackendClient.
  */
-
-const mockedGetSession = jest.fn();
-
-export const BackendClient = () => ({
-  getSession: mockedGetSession
-});
+export const BackendClient = {
+  getMessage: jest.fn(),
+  getMessages: jest.fn(),
+  getSession: jest.fn(),
+  getThirdPartyMessagePrecondition: jest.fn(),
+  upsertMessageStatusAttributes: jest.fn()
+};
diff --git a/.../__test__/watchLoadMessageDetails.test.ts → ...__test__/handleLoadMessageDetails.test.ts b/.../__test__/watchLoadMessageDetails.test.ts → ...__test__/handleLoadMessageDetails.test.ts
@@ -9,26 +9,28 @@ import {
   paymentValidInvalidAfterDueDate,
   successLoadMessageDetails
 } from "../../__mocks__/message";
-import { testTryLoadMessageDetails } from "../watchLoadMessageDetails";
 import { withRefreshApiCall } from "../../../fastLogin/saga/utils";
-
-const tryLoadMessageDetails = testTryLoadMessageDetails!;
+import { handleLoadMessageDetails } from "../handleLoadMessageDetails";
+import { BackendClient } from "../../../../api/__mocks__/backend";
 
 const id = paymentValidInvalidAfterDueDate.id as UIMessageId;
 
-describe("tryReloadAllMessages", () => {
+describe("handleLoadMessageDetails", () => {
   const getMessagesPayload = { id };
 
   describe("when the response is successful", () => {
     it(`should put ${getType(
       action.success
     )} with the parsed messages and pagination data`, () => {
-      const getMessage = jest.fn();
-      testSaga(tryLoadMessageDetails(getMessage), action.request({ id }))
+      testSaga(
+        handleLoadMessageDetails,
+        BackendClient.getMessage,
+        action.request({ id })
+      )
         .next()
         .call(
           withRefreshApiCall,
-          getMessage(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           action.request({ id })
         )
         // .call(getMessage, getMessagesPayload)
@@ -41,12 +43,15 @@ describe("tryReloadAllMessages", () => {
 
   describe("when the response is an Error", () => {
     it(`should put ${getType(action.failure)} with the error message`, () => {
-      const getMessage = jest.fn();
-      testSaga(tryLoadMessageDetails(getMessage), action.request({ id }))
+      testSaga(
+        handleLoadMessageDetails,
+        BackendClient.getMessage,
+        action.request({ id })
+      )
         .next()
         .call(
           withRefreshApiCall,
-          getMessage(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           action.request({ id })
         )
         .next(E.right({ status: 500, value: { title: "Backend error" } }))
@@ -58,12 +63,13 @@ describe("tryReloadAllMessages", () => {
 
   describe("when the handler throws", () => {
     it(`should catch it and put ${getType(action.failure)}`, () => {
-      const getMessage = jest.fn().mockImplementation(() => {
-        throw new Error("I made a boo-boo, sir!");
-      });
-
-      testSaga(tryLoadMessageDetails(getMessage), action.request({ id }))
+      testSaga(
+        handleLoadMessageDetails,
+        BackendClient.getMessage,
+        action.request({ id })
+      )
         .next()
+        .throw(new Error("I made a boo-boo, sir!"))
         .put(
           action.failure({
             id,

diff --git a/..._test__/watchLoadNextPageMessages.test.ts → ...test__/handleLoadNextPageMessages.test.ts b/..._test__/watchLoadNextPageMessages.test.ts → ...test__/handleLoadNextPageMessages.test.ts
@@ -2,21 +2,17 @@ import * as E from "fp-ts/lib/Either";
 import { testSaga } from "redux-saga-test-plan";
 import { getType } from "typesafe-actions";
 
-import {
-  loadNextPageMessages as action,
-  loadNextPageMessages
-} from "../../store/actions";
+import { loadNextPageMessages as action } from "../../store/actions";
 import {
   apiPayload,
   defaultRequestPayload,
   successLoadNextPageMessagesPayload
 } from "../../__mocks__/messages";
-import { testTryLoadNextPageMessages } from "../watchLoadNextPageMessages";
 import { withRefreshApiCall } from "../../../fastLogin/saga/utils";
+import { handleLoadNextPageMessages } from "../handleLoadNextPageMessages";
+import { BackendClient } from "../../../../api/__mocks__/backend";
 
-const tryLoadNextPageMessages = testTryLoadNextPageMessages!;
-
-describe("tryLoadNextPageMessages", () => {
+describe("handleLoadNextPageMessages", () => {
   const getMessagesPayload = {
     enrich_result_data: true,
     page_size: defaultRequestPayload.pageSize,
@@ -28,16 +24,16 @@ describe("tryLoadNextPageMessages", () => {
     it(`should put ${getType(
       action.success
     )} with the parsed messages and pagination data`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryLoadNextPageMessages(getMessages),
+        handleLoadNextPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
-          loadNextPageMessages.request(defaultRequestPayload)
+          BackendClient.getMessages(getMessagesPayload),
+          action.request(defaultRequestPayload)
         )
         .next(E.right({ status: 200, value: apiPayload }))
         .put(action.success(successLoadNextPageMessagesPayload))
@@ -48,16 +44,16 @@ describe("tryLoadNextPageMessages", () => {
 
   describe("when the response is an Error", () => {
     it(`should put ${getType(action.failure)} with the error message`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryLoadNextPageMessages(getMessages),
+        handleLoadNextPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
-          loadNextPageMessages.request(defaultRequestPayload)
+          BackendClient.getMessages(getMessagesPayload),
+          action.request(defaultRequestPayload)
         )
         .next(E.right({ status: 500, value: { title: "Backend error" } }))
         .put(
@@ -73,14 +69,13 @@ describe("tryLoadNextPageMessages", () => {
 
   describe("when the handler throws", () => {
     it(`should catch it and put ${getType(action.failure)}`, () => {
-      const getMessages = () => {
-        throw new Error("I made a boo-boo, sir!");
-      };
       testSaga(
-        tryLoadNextPageMessages(getMessages),
+        handleLoadNextPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
+        .throw(new Error("I made a boo-boo, sir!"))
         .put(
           action.failure({
             error: new Error("I made a boo-boo, sir!"),

diff --git a/...t__/watchLoadPreviousPageMessages.test.ts → ...__/handleLoadPreviousPageMessages.test.ts b/...t__/watchLoadPreviousPageMessages.test.ts → ...__/handleLoadPreviousPageMessages.test.ts
@@ -11,12 +11,11 @@ import {
   defaultRequestPayload,
   successLoadPreviousPageMessagesPayload
 } from "../../__mocks__/messages";
-import { testTryLoadPreviousPageMessages } from "../watchLoadPreviousPageMessages";
 import { withRefreshApiCall } from "../../../fastLogin/saga/utils";
+import { handleLoadPreviousPageMessages } from "../handleLoadPreviousPageMessages";
+import { BackendClient } from "../../../../api/__mocks__/backend";
 
-const tryLoadPreviousPageMessages = testTryLoadPreviousPageMessages!;
-
-describe("tryLoadPreviousPageMessages", () => {
+describe("handleLoadPreviousPageMessages", () => {
   const getMessagesPayload = {
     enrich_result_data: true,
     page_size: 8,
@@ -28,15 +27,15 @@ describe("tryLoadPreviousPageMessages", () => {
     it(`should put ${getType(
       action.success
     )} with the parsed messages and pagination data`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryLoadPreviousPageMessages(getMessages),
+        handleLoadPreviousPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           loadPreviousPageMessages.request(defaultRequestPayload)
         )
         .next(E.right({ status: 200, value: apiPayload }))
@@ -48,15 +47,15 @@ describe("tryLoadPreviousPageMessages", () => {
 
   describe("when the response is an Error", () => {
     it(`should put ${getType(action.failure)} with the error message`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryLoadPreviousPageMessages(getMessages),
+        handleLoadPreviousPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           loadPreviousPageMessages.request(defaultRequestPayload)
         )
         .next(E.right({ status: 500, value: { title: "Backend error" } }))
@@ -73,14 +72,13 @@ describe("tryLoadPreviousPageMessages", () => {
 
   describe("when the handler throws", () => {
     it(`should catch it and put ${getType(action.failure)}`, () => {
-      const getMessages = () => {
-        throw new Error("I made a boo-boo, sir!");
-      };
       testSaga(
-        tryLoadPreviousPageMessages(getMessages),
+        handleLoadPreviousPageMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
+        .throw(new Error("I made a boo-boo, sir!"))
         .put(
           action.failure({
             error: new Error("I made a boo-boo, sir!"),

diff --git a/...__test__/watchMessagePrecondition.test.ts → ..._test__/handleMessagePrecondition.test.ts b/...__test__/watchMessagePrecondition.test.ts → ..._test__/handleMessagePrecondition.test.ts
@@ -3,12 +3,13 @@ import { testSaga } from "redux-saga-test-plan";
 import { getType } from "typesafe-actions";
 import { getMessagePrecondition } from "../../store/actions";
 import { UIMessageId } from "../../types";
-import { testWorkerMessagePrecondition } from "../watchMessagePrecondition";
+import { testMessagePreconditionWorker } from "../handleMessagePrecondition";
 import { ThirdPartyMessagePrecondition } from "../../../../../definitions/backend/ThirdPartyMessagePrecondition";
 import { TagEnum as TagEnumPN } from "../../../../../definitions/backend/MessageCategoryPN";
 import { withRefreshApiCall } from "../../../fastLogin/saga/utils";
+import { BackendClient } from "../../../../api/__mocks__/backend";
 
-const workerMessagePrecondition = testWorkerMessagePrecondition!;
+const messagePreconditionWorker = testMessagePreconditionWorker!;
 
 const action = {
   id: "MSG001" as UIMessageId,
@@ -19,21 +20,19 @@ const mockResponseSuccess: ThirdPartyMessagePrecondition = {
   markdown: "-"
 };
 
-describe("workerMessagePrecondition", () => {
+describe("messagePreconditionWorker", () => {
   it(`should put ${getType(
     getMessagePrecondition.success
   )} when the response is successful`, () => {
-    const getThirdPartyMessagePrecondition = jest.fn();
-
     testSaga(
-      workerMessagePrecondition,
-      getThirdPartyMessagePrecondition,
+      messagePreconditionWorker,
+      BackendClient.getThirdPartyMessagePrecondition,
       getMessagePrecondition.request(action)
     )
       .next()
       .call(
         withRefreshApiCall,
-        getThirdPartyMessagePrecondition(action),
+        BackendClient.getThirdPartyMessagePrecondition(action),
         getMessagePrecondition.request(action)
       )
       .next(E.right({ status: 200, value: mockResponseSuccess }))
@@ -45,17 +44,15 @@ describe("workerMessagePrecondition", () => {
   it(`should put ${getType(
     getMessagePrecondition.failure
   )} when the response is an error`, () => {
-    const getThirdPartyMessagePrecondition = jest.fn();
-
     testSaga(
-      workerMessagePrecondition,
-      getThirdPartyMessagePrecondition,
+      messagePreconditionWorker,
+      BackendClient.getThirdPartyMessagePrecondition,
       getMessagePrecondition.request(action)
     )
       .next()
       .call(
         withRefreshApiCall,
-        getThirdPartyMessagePrecondition(action),
+        BackendClient.getThirdPartyMessagePrecondition(action),
         getMessagePrecondition.request(action)
       )
       .next(E.right({ status: 500, value: `response status ${500}` }))
@@ -67,11 +64,9 @@ describe("workerMessagePrecondition", () => {
   it(`should put ${getType(
     getMessagePrecondition.failure
   )} when the handler throws an exception`, () => {
-    const getThirdPartyMessagePrecondition = jest.fn();
-
     testSaga(
-      workerMessagePrecondition,
-      getThirdPartyMessagePrecondition,
+      messagePreconditionWorker,
+      BackendClient.getThirdPartyMessagePrecondition,
       getMessagePrecondition.request(action)
     )
       .next()

diff --git a/...a/__test__/watchReloadAllMessages.test.ts → .../__test__/handleReloadAllMessages.test.ts b/...a/__test__/watchReloadAllMessages.test.ts → .../__test__/handleReloadAllMessages.test.ts
@@ -9,12 +9,11 @@ import {
   defaultRequestPayload,
   successReloadMessagesPayload
 } from "../../__mocks__/messages";
-import { testTryLoadPreviousPageMessages } from "../watchReloadAllMessages";
 import { withRefreshApiCall } from "../../../fastLogin/saga/utils";
+import { handleReloadAllMessages } from "../handleReloadAllMessages";
+import { BackendClient } from "../../../../api/__mocks__/backend";
 
-const tryReloadAllMessages = testTryLoadPreviousPageMessages!;
-
-describe("tryReloadAllMessages", () => {
+describe("handleReloadAllMessages", () => {
   const getMessagesPayload = {
     enrich_result_data: true,
     page_size: defaultRequestPayload.pageSize,
@@ -25,15 +24,15 @@ describe("tryReloadAllMessages", () => {
     it(`should put ${getType(
       action.success
     )} with the parsed messages and pagination data`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryReloadAllMessages(getMessages),
+        handleReloadAllMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           action.request(defaultRequestPayload)
         )
         .next(E.right({ status: 200, value: apiPayload }))
@@ -45,15 +44,15 @@ describe("tryReloadAllMessages", () => {
 
   describe("when the response is an Error", () => {
     it(`should put ${getType(action.failure)} with the error message`, () => {
-      const getMessages = jest.fn();
       testSaga(
-        tryReloadAllMessages(getMessages),
+        handleReloadAllMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
         .call(
           withRefreshApiCall,
-          getMessages(getMessagesPayload),
+          BackendClient.getMessages(getMessagesPayload),
           action.request(defaultRequestPayload)
         )
         .next(
@@ -70,14 +69,13 @@ describe("tryReloadAllMessages", () => {
 
   describe("when the handler throws", () => {
     it(`should catch it and put ${getType(action.failure)}`, () => {
-      const getMessages = () => {
-        throw new Error(defaultRequestError.error.message);
-      };
       testSaga(
-        tryReloadAllMessages(getMessages),
+        handleReloadAllMessages,
+        BackendClient.getMessages,
         action.request(defaultRequestPayload)
       )
         .next()
+        .throw(new Error(defaultRequestError.error.message))
         .put(
           action.failure({
             error: new Error(defaultRequestError.error.message),