PROD-2211 moves some property-specific endpoints from OSS -> plus (#5096

)
ethyca · Jul 30, 2024 · 139d0a6 · 139d0a6
1 parent 1ff4d8c
commit 139d0a6
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 634 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,6 +27,7 @@ The types of changes are:
 - Serve GVL languages as they are requested [#5112](https://github.com/ethyca/fides/pull/5112)
 - Changed text on system integrations tab to direct to new integration management [#5097](https://github.com/ethyca/fides/pull/5097)
 - Updates to consent experience styling [#5085](https://github.com/ethyca/fides/pull/5085)
+- Moves some endpoints for property-specific messaging from OSS -> plus [#5069](https://github.com/ethyca/fides/pull/5069)
 
 ### Developer Experience
 - Add `.syncignore` to reduce file sync size with new volumes [#5104](https://github.com/ethyca/fides/pull/5104)

diff --git a/clients/admin-ui/cypress/e2e/messaging.cy.ts b/clients/admin-ui/cypress/e2e/messaging.cy.ts
@@ -8,7 +8,7 @@ describe("Messaging", () => {
     cy.login();
     stubPlus(true);
 
-    cy.intercept("/api/v1/messaging/templates/summary?*", {
+    cy.intercept("/api/v1/plus/messaging/templates/summary?*", {
       fixture: "messaging/summary.json",
     }).as("getEmailTemplatesSummary");
 
@@ -20,13 +20,13 @@ describe("Messaging", () => {
       fixture: "properties/properties.json",
     }).as("getProperties");
 
-    cy.intercept("PATCH", "/api/v1/messaging/templates/*", {}).as(
+    cy.intercept("PATCH", "/api/v1/plus/messaging/templates/*", {}).as(
       "patchTemplate"
     );
 
     cy.intercept(
       "POST",
-      "/api/v1/messaging/templates/privacy_request_complete_access",
+      "/api/v1/plus/messaging/templates/privacy_request_complete_access",
       {}
     ).as("postTemplate");
   });

diff --git a/clients/admin-ui/src/features/messaging-templates/messaging-templates.slice.plus.ts b/clients/admin-ui/src/features/messaging-templates/messaging-templates.slice.plus.ts
@@ -0,0 +1,68 @@
+import { baseApi } from "common/api.slice";
+
+import {
+  MessagingTemplateCreate,
+  MessagingTemplatePatch,
+  MessagingTemplateResponse,
+  MessagingTemplateUpdate,
+} from "~/features/messaging-templates/messaging-templates.slice";
+import { Page_MessagingTemplateWithPropertiesSummary_ } from "~/types/api";
+
+const messagingTemplatesPlusApi = baseApi.injectEndpoints({
+  endpoints: (build) => ({
+    getSummaryMessagingTemplates: build.query<
+      Page_MessagingTemplateWithPropertiesSummary_,
+      any
+    >({
+      query: (params) => ({
+        method: "GET",
+        url: `plus/messaging/templates/summary`,
+        params,
+      }),
+      providesTags: () => ["Property-Specific Messaging Templates"],
+    }),
+    // Full update existing template
+    putMessagingTemplateById: build.mutation<
+      MessagingTemplateResponse,
+      MessagingTemplateUpdate
+    >({
+      query: ({ templateId, template }) => ({
+        url: `plus/messaging/templates/${templateId}`,
+        method: "PUT",
+        body: template,
+      }),
+      invalidatesTags: () => ["Property-Specific Messaging Templates"],
+    }),
+    // Partial update existing template, e.g. enable it
+    patchMessagingTemplateById: build.mutation<
+      MessagingTemplateResponse,
+      MessagingTemplatePatch
+    >({
+      query: ({ templateId, template }) => ({
+        url: `plus/messaging/templates/${templateId}`,
+        method: "PATCH",
+        body: template,
+      }),
+      invalidatesTags: () => ["Property-Specific Messaging Templates"],
+    }),
+    // endpoint for creating new messaging template- POST by type
+    createMessagingTemplateByType: build.mutation<
+      MessagingTemplateResponse,
+      MessagingTemplateCreate
+    >({
+      query: ({ templateType, template }) => ({
+        url: `plus/messaging/templates/${templateType}`,
+        method: "POST",
+        body: template,
+      }),
+      invalidatesTags: () => ["Property-Specific Messaging Templates"],
+    }),
+  }),
+});
+
+export const {
+  useGetSummaryMessagingTemplatesQuery,
+  usePutMessagingTemplateByIdMutation,
+  useCreateMessagingTemplateByTypeMutation,
+  usePatchMessagingTemplateByIdMutation,
+} = messagingTemplatesPlusApi;
diff --git a/clients/admin-ui/src/features/messaging-templates/messaging-templates.slice.ts b/clients/admin-ui/src/features/messaging-templates/messaging-templates.slice.ts
@@ -1,8 +1,5 @@
 import { baseApi } from "~/features/common/api.slice";
-import {
-  MinimalProperty,
-  Page_MessagingTemplateWithPropertiesSummary_,
-} from "~/types/api";
+import { MinimalProperty } from "~/types/api";
 import { BulkUpdateFailed } from "~/types/api/models/BulkUpdateFailed";
 
 export type MessagingTemplate = {
@@ -70,17 +67,6 @@ const messagingTemplatesApi = baseApi.injectEndpoints({
       query: () => ({ url: `messaging/templates` }),
       providesTags: () => ["Messaging Templates"],
     }),
-    getSummaryMessagingTemplates: build.query<
-      Page_MessagingTemplateWithPropertiesSummary_,
-      any
-    >({
-      query: (params) => ({
-        method: "GET",
-        url: `messaging/templates/summary`,
-        params,
-      }),
-      providesTags: () => ["Property-Specific Messaging Templates"],
-    }),
     updateMessagingTemplates: build.mutation<
       BulkPutMessagingTemplateResponse,
       MessagingTemplate[]
@@ -90,7 +76,7 @@ const messagingTemplatesApi = baseApi.injectEndpoints({
         method: "PUT",
         body: templates,
       }),
-      invalidatesTags: () => ["Property-Specific Messaging Templates"],
+      invalidatesTags: () => ["Messaging Templates"],
     }),
     // Render data from existing template- GET by id
     getMessagingTemplateById: build.query<MessagingTemplateResponse, string>({
@@ -99,30 +85,6 @@ const messagingTemplatesApi = baseApi.injectEndpoints({
       }),
       providesTags: () => ["Property-Specific Messaging Templates"],
     }),
-    // Update existing template
-    putMessagingTemplateById: build.mutation<
-      MessagingTemplateResponse,
-      MessagingTemplateUpdate
-    >({
-      query: ({ templateId, template }) => ({
-        url: `/messaging/templates/${templateId}`,
-        method: "PUT",
-        body: template,
-      }),
-      invalidatesTags: () => ["Property-Specific Messaging Templates"],
-    }),
-    // Update existing template
-    patchMessagingTemplateById: build.mutation<
-      MessagingTemplateResponse,
-      MessagingTemplatePatch
-    >({
-      query: ({ templateId, template }) => ({
-        url: `/messaging/templates/${templateId}`,
-        method: "PATCH",
-        body: template,
-      }),
-      invalidatesTags: () => ["Property-Specific Messaging Templates"],
-    }),
     // endpoint for rendering data for default template- GET by type
     getMessagingTemplateDefault: build.query<
       MessagingTemplateDefaultResponse,
@@ -132,18 +94,6 @@ const messagingTemplatesApi = baseApi.injectEndpoints({
         url: `/messaging/templates/default/${templateType}`,
       }),
     }),
-    // endpoint for creating new messaging template- POST by type
-    createMessagingTemplateByType: build.mutation<
-      MessagingTemplateResponse,
-      MessagingTemplateCreate
-    >({
-      query: ({ templateType, template }) => ({
-        url: `/messaging/templates/${templateType}`,
-        method: "POST",
-        body: template,
-      }),
-      invalidatesTags: () => ["Property-Specific Messaging Templates"],
-    }),
     // delete template by id
     deleteMessagingTemplateById: build.mutation<void, string>({
       query: (templateId: string) => ({
@@ -158,11 +108,7 @@ const messagingTemplatesApi = baseApi.injectEndpoints({
 export const {
   useGetMessagingTemplatesQuery,
   useUpdateMessagingTemplatesMutation,
-  useGetSummaryMessagingTemplatesQuery,
   useGetMessagingTemplateByIdQuery,
-  usePutMessagingTemplateByIdMutation,
   useGetMessagingTemplateDefaultQuery,
-  useCreateMessagingTemplateByTypeMutation,
   useDeleteMessagingTemplateByIdMutation,
-  usePatchMessagingTemplateByIdMutation,
 } = messagingTemplatesApi;
diff --git a/clients/admin-ui/src/features/messaging-templates/useMessagingTemplateToggle.tsx b/clients/admin-ui/src/features/messaging-templates/useMessagingTemplateToggle.tsx
@@ -3,7 +3,7 @@ import { useToast } from "fidesui";
 import { useCallback } from "react";
 
 import { errorToastParams, successToastParams } from "~/features/common/toast";
-import { usePatchMessagingTemplateByIdMutation } from "~/features/messaging-templates/messaging-templates.slice";
+import { usePatchMessagingTemplateByIdMutation } from "~/features/messaging-templates/messaging-templates.slice.plus";
 import { isErrorResult } from "~/types/errors";
 
 const useMessagingTemplateToggle = () => {

diff --git a/clients/admin-ui/src/pages/messaging/[id].tsx b/clients/admin-ui/src/pages/messaging/[id].tsx
@@ -18,8 +18,8 @@ import {
   MessagingTemplateCreateOrUpdate,
   useDeleteMessagingTemplateByIdMutation,
   useGetMessagingTemplateByIdQuery,
-  usePutMessagingTemplateByIdMutation,
 } from "~/features/messaging-templates/messaging-templates.slice";
+import { usePutMessagingTemplateByIdMutation } from "~/features/messaging-templates/messaging-templates.slice.plus";
 import PropertySpecificMessagingTemplateForm, {
   FormValues,
 } from "~/features/messaging-templates/PropertySpecificMessagingTemplateForm";

diff --git a/clients/admin-ui/src/pages/messaging/add-template.tsx b/clients/admin-ui/src/pages/messaging/add-template.tsx
@@ -8,9 +8,9 @@ import Layout from "~/features/common/Layout";
 import { errorToastParams, successToastParams } from "~/features/common/toast";
 import {
   MessagingTemplateCreateOrUpdate,
-  useCreateMessagingTemplateByTypeMutation,
   useGetMessagingTemplateDefaultQuery,
 } from "~/features/messaging-templates/messaging-templates.slice";
+import { useCreateMessagingTemplateByTypeMutation } from "~/features/messaging-templates/messaging-templates.slice.plus";
 import PropertySpecificMessagingTemplateForm, {
   FormValues,
 } from "~/features/messaging-templates/PropertySpecificMessagingTemplateForm";

diff --git a/clients/admin-ui/src/pages/messaging/index.tsx b/clients/admin-ui/src/pages/messaging/index.tsx
@@ -35,7 +35,7 @@ import { PaginationBar } from "~/features/common/table/v2/PaginationBar";
 import AddMessagingTemplateModal from "~/features/messaging-templates/AddMessagingTemplateModal";
 import { CustomizableMessagingTemplatesEnum } from "~/features/messaging-templates/CustomizableMessagingTemplatesEnum";
 import CustomizableMessagingTemplatesLabelEnum from "~/features/messaging-templates/CustomizableMessagingTemplatesLabelEnum";
-import { useGetSummaryMessagingTemplatesQuery } from "~/features/messaging-templates/messaging-templates.slice";
+import { useGetSummaryMessagingTemplatesQuery } from "~/features/messaging-templates/messaging-templates.slice.plus";
 import useMessagingTemplateToggle from "~/features/messaging-templates/useMessagingTemplateToggle";
 import { useGetConfigurationSettingsQuery } from "~/features/privacy-requests";
 import { useGetAllPropertiesQuery } from "~/features/properties";