feat(notifications): add notification api and update banner (#986)

* setup api

* setup hooks

* hook up banner

* small fix

* resource allowance

* Update api.ts

* arn change

* quick fix

* Update getSystemNotifs.ts

* no toString

* feat: merge hooks into one file

* Create useGetSystemNotifs.test.ts

* fix: infinite re-render

* fix tests

lib/config/deployment-config.test.ts

@@ -21,6 +21,8 @@ describe("DeploymentConfig", () => {
     domainCertificateArn: "domainCertificateArn",
     domainName: "domainName",
     emailAddressLookupSecretName: "emailAddressLookupSecretName", // pragma: allowlist secret
+    notificationSecretName: "notificationSecretName", // pragma: allowlist secret
+    notificationSecretArn: "notificationSecretArn", // pragma: allowlist secret
     googleAnalyticsDisable: "true",
     googleAnalyticsGTag: "googleAnalyticsGTag",
     idmAuthzApiEndpoint: "idmAuthzApiEndpoint",
@@ -81,6 +83,8 @@ describe("DeploymentConfig", () => {
       domainCertificateArn: "domainCertificateArn",
       domainName: "stage-domainName", // Overridden by stage secret
       emailAddressLookupSecretName: "emailAddressLookupSecretName", // pragma: allowlist secret
+      notificationSecretName: "notificationSecretName", // pragma: allowlist secret
+      notificationSecretArn: "notificationSecretArn", // pragma: allowlist secret
       googleAnalyticsDisable: false, // Converted to boolean and overridden by stage secret
       googleAnalyticsGTag: "googleAnalyticsGTag",
       idmAuthzApiEndpoint: "idmAuthzApiEndpoint",
@@ -145,6 +149,8 @@ describe("DeploymentConfig", () => {
       domainCertificateArn: "domainCertificateArn",
       domainName: "domainName",
       emailAddressLookupSecretName: "emailAddressLookupSecretName", // pragma: allowlist secret
+      notificationSecretName: "notificationSecretName", // pragma: allowlist secret
+      notificationSecretArn: "notificationSecretArn", // pragma: allowlist secret
       googleAnalyticsDisable: true,
       googleAnalyticsGTag: "googleAnalyticsGTag",
       idmAuthzApiEndpoint: "idmAuthzApiEndpoint",

lib/config/deployment-config.ts

@@ -13,6 +13,8 @@ export type InjectedConfigProperties = {
   domainCertificateArn: string;
   domainName: string;
   emailAddressLookupSecretName: string;
+  notificationSecretName: string;
+  notificationSecretArn: string;
   googleAnalyticsDisable: boolean;
   googleAnalyticsGTag: string;
   iamPath: string;
@@ -117,6 +119,8 @@ export class DeploymentConfig {
       typeof config.domainCertificateArn == "string" &&
       typeof config.domainName === "string" &&
       typeof config.emailAddressLookupSecretName === "string" && // pragma: allowlist secret
+      typeof config.notificationSecretName === "string" && // pragma: allowlist secret
+      typeof config.notificationSecretArn === "string" && // pragma: allowlist secret
       typeof config.googleAnalyticsDisable == "boolean" &&
       typeof config.googleAnalyticsGTag === "string" &&
       typeof config.iamPermissionsBoundary === "string" &&

lib/lambda/getSystemNotifs.test.ts

@@ -0,0 +1,50 @@
+import { describe, it, expect, vi, beforeEach } from "vitest";
+import { getSystemNotifs } from "./getSystemNotifs";
+import * as util from "shared-utils";
+
+vi.mock("shared-utils", () => ({
+  getExport: vi.fn(),
+  getSecret: vi.fn(),
+}));
+
+describe("notif handler", () => {
+  beforeEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it("returns 200 and notifs if secret exists", async () => {
+    vi.stubEnv("notificationSecretArn", "test_secret");
+    vi.spyOn(util, "getSecret").mockImplementation(async () => "[]");
+    const result = await getSystemNotifs();
+    expect(result.statusCode).toBe(200);
+    expect(result.body).toBe("[]");
+  });
+
+  it("returns 200 and empty array if no notifs", async () => {
+    vi.stubEnv("notificationSecretArn", "test_secret");
+    vi.spyOn(util, "getSecret").mockImplementation(async () => null as unknown as string);
+    const result = await getSystemNotifs();
+    expect(result.statusCode).toBe(200);
+    expect(result.body).toBe("[]");
+  });
+
+  it("returns 502 with specific error", async () => {
+    vi.stubEnv("notificationSecretArn", "error");
+    vi.spyOn(util, "getSecret").mockImplementation(async () => {
+      throw new Error("test error");
+    });
+    const result = await getSystemNotifs();
+    expect(result.statusCode).toBe(502);
+    expect(JSON.parse(result.body).error).toBe("test error");
+  });
+
+  it("returns 502 with generic error", async () => {
+    vi.stubEnv("notificationSecretArn", undefined);
+    vi.spyOn(util, "getSecret").mockImplementation(async () => {
+      throw new Error();
+    });
+    const result = await getSystemNotifs();
+    expect(result.statusCode).toBe(502);
+    expect(JSON.parse(result.body).error).toBe("Internal server error");
+  });
+});

lib/lambda/getSystemNotifs.ts

@@ -0,0 +1,23 @@
+import { getSecret } from "shared-utils";
+import { response } from "libs/handler-lib";
+
+export const getSystemNotifs = async () => {
+  try {
+    const notifs = await getSecret(process.env.notificationSecretArn!);
+
+    return response({
+      statusCode: 200,
+      body: JSON.parse(notifs) || [],
+    });
+  } catch (error: any) {
+    console.error("Error:", error);
+    return response({
+      statusCode: 502,
+      body: {
+        error: error.message ? error.message : "Internal server error",
+      },
+    });
+  }
+};
+
+export const handler = getSystemNotifs;

lib/packages/shared-types/index.ts

@@ -9,6 +9,7 @@ export * from "./guides";
 export * from "./inputs";
 export * from "./issue";
 export * from "./lambda-events";
+export * from "./notification";
 export * as opensearch from "./opensearch";
 export * from "./states";
 export * from "./statusHelper";

lib/packages/shared-types/notification.ts

@@ -0,0 +1,9 @@
+export interface BannerNotification {
+  notifId: string;
+  header: string;
+  body: string;
+  buttonText?: string;
+  buttonLink?: string;
+  pubDate: string;
+  expDate?: string;
+}

lib/stacks/api.ts

@@ -25,6 +25,8 @@ interface ApiStackProps extends cdk.NestedStackProps {
   brokerString: DeploymentConfigProperties["brokerString"];
   dbInfoSecretName: DeploymentConfigProperties["dbInfoSecretName"];
   legacyS3AccessRoleArn: DeploymentConfigProperties["legacyS3AccessRoleArn"];
+  notificationSecretName: DeploymentConfigProperties["notificationSecretName"];
+  notificationSecretArn: DeploymentConfigProperties["notificationSecretArn"];
 }
 
 export class Api extends cdk.NestedStack {
@@ -55,6 +57,8 @@ export class Api extends cdk.NestedStack {
       alertsTopic,
       attachmentsBucket,
       dbInfoSecretName,
+      notificationSecretName,
+      notificationSecretArn,
     } = props;
 
     const topicName = `${topicNamespace}aws.onemac.migration.cdc`;
@@ -113,6 +117,13 @@ export class Api extends cdk.NestedStack {
                 `arn:aws:secretsmanager:${this.region}:${this.account}:secret:${dbInfoSecretName}-*`,
               ],
             }),
+            new cdk.aws_iam.PolicyStatement({
+              effect: cdk.aws_iam.Effect.ALLOW,
+              actions: ["secretsmanager:DescribeSecret", "secretsmanager:GetSecretValue"],
+              resources: [
+                `arn:aws:secretsmanager:${this.region}:${this.account}:secret:${notificationSecretName}-*`,
+              ],
+            }),
           ],
         }),
       },
@@ -282,6 +293,14 @@ export class Api extends cdk.NestedStack {
           indexNamespace,
         },
       },
+      {
+        id: "getSystemNotifs",
+        entry: join(__dirname, "../lambda/getSystemNotifs.ts"),
+        environment: {
+          notificationSecretName,
+          notificationSecretArn,
+        },
+      },
     ];
 
     const lambdas = lambdaDefinitions.reduce(
@@ -439,6 +458,7 @@ export class Api extends cdk.NestedStack {
         lambda: lambdas.getAllForms,
         method: "GET",
       },
+      getSystemNotifs: { path: "systemNotifs", lambda: lambdas.getSystemNotifs, method: "GET" },
     };
 
     const addApiResource = (

lib/stacks/parent.ts

@@ -81,6 +81,8 @@ export class ParentStack extends cdk.Stack {
       openSearchDomainEndpoint: dataStack.openSearchDomainEndpoint,
       alertsTopic: alertsStack.topic,
       attachmentsBucket: uploadsStack.attachmentsBucket,
+      notificationSecretName: props.notificationSecretName,
+      notificationSecretArn: props.notificationSecretArn,
     });
 
     const authStack = new Stacks.Auth(this, "auth", {

mocks/handlers/api/index.ts

@@ -3,9 +3,11 @@ import { itemHandlers } from "./items";
 import { packageActionHandlers } from "./packageActions";
 import { searchHandlers } from "./search";
 import { submissionHandlers } from "./submissions";
+import { notificationHandlers } from "./notifications";
 import { typeHandlers } from "./types";
 
 export const apiHandlers = [
+  ...notificationHandlers,
   ...cpocHandlers,
   ...itemHandlers,
   ...packageActionHandlers,

mocks/handlers/api/notifications.ts

@@ -0,0 +1,20 @@
+import { http, HttpResponse } from "msw";
+import { BannerNotification } from "shared-types";
+
+export type NotifRequestBody = BannerNotification[];
+
+const defaultNotificationHandler = http.get<any, NotifRequestBody>(/\/systemNotifs/, async () => {
+  return HttpResponse.json(
+    [
+      {
+        notifId: "testId",
+        body: "testBody",
+        header: "testHeader",
+        pubDate: new Date().toISOString(),
+      },
+    ],
+    { status: 200 },
+  );
+});
+
+export const notificationHandlers = [defaultNotificationHandler];

react-app/src/api/index.ts

@@ -5,6 +5,7 @@ export * from "./useGetUser";
 export * from "./getAttachmentUrl";
 export * from "./useGetPackageActions";
 export * from "./useGetCPOCs";
+export * from "./useGetSystemNotifs";
 export * from "./useGetTypes";
 export * from "./amplifyConfig";
 export * from "./itemExists";

react-app/src/api/useGetSystemNotifs.test.ts

@@ -0,0 +1,64 @@
+import { beforeAll, afterAll, test, expect, vi, describe } from "vitest";
+import { renderHook } from "@testing-library/react";
+import { mockUseGetUser } from "mocks";
+
+import * as api from "@/api";
+import * as query from "@tanstack/react-query";
+
+import { OneMacUser } from ".";
+
+vi.mock("@/api/useGetUser", () => ({
+  useGetUser: vi.fn(),
+}));
+
+vi.mock("@tanstack/react-query", async (imp) => ({
+  ...(await imp()),
+  useQuery: vi.fn(),
+}));
+
+const testNotifs = [
+  {
+    notifId: "testId",
+    body: "testBody",
+    header: "testHeader",
+    pubDate: new Date().toISOString(),
+  },
+];
+
+describe("useGetSystemNotif", () => {
+  beforeAll(() => {
+    vi.spyOn(api, "useGetUser").mockImplementation(() => {
+      const response = mockUseGetUser();
+      return response as query.UseQueryResult<OneMacUser, unknown>;
+    });
+    vi.spyOn(Storage.prototype, "getItem").mockImplementation(() => "[]");
+    vi.spyOn(Storage.prototype, "setItem").mockImplementation(() => undefined);
+    vi.spyOn(query, "useQuery").mockImplementation(
+      () =>
+        ({
+          data: testNotifs,
+        }) as query.UseQueryResult<unknown, unknown>,
+    );
+  });
+
+  afterAll(() => {
+    vi.resetAllMocks();
+  });
+
+  test("API call", async () => {
+    const notifs = await api.getSystemNotifs();
+    expect(notifs).toBeTruthy();
+    expect(notifs.length).toEqual(1);
+  });
+
+  test("returns test notification array", () => {
+    // const testHook = api.useGetSystemNotifs();
+    const {
+      result: { current: testHook },
+    } = renderHook(() => api.useGetSystemNotifs());
+
+    // expect(testHook.notifications[0].notifId).toBe(testNotifs[0].notifId);
+    expect(testHook.allNotifications[0].notifId).toBe(testNotifs[0].notifId);
+    expect(testHook.dismissed).toStrictEqual([]);
+  });
+});

react-app/src/api/useGetSystemNotifs.ts

@@ -0,0 +1,49 @@
+import { API } from "aws-amplify";
+import { useState, useEffect } from "react";
+import { useGetUser } from "@/api";
+import { useQuery } from "@tanstack/react-query";
+import { BannerNotification, ReactQueryApiError } from "shared-types";
+
+export const getSystemNotifs = async (): Promise<BannerNotification[]> => {
+  return await API.get("os", "/systemNotifs", {});
+};
+
+export const useGetSystemNotifs = () => {
+  const userQuery = useGetUser();
+  const [dismissed, setDismissed] = useState<string[]>([]);
+
+  useEffect(() => {
+    const dismissedNotifs = localStorage.getItem(`notifs.${userQuery?.data?.user?.username}`);
+    const parsed: string[] = JSON.parse(dismissedNotifs) ?? [];
+    setDismissed(parsed);
+  }, [userQuery?.data?.user?.username]);
+
+  const result = useQuery<BannerNotification[], ReactQueryApiError>(["systemBannerNotifs"], () =>
+    getSystemNotifs(),
+  );
+
+  const notDismissed = result.data?.filter((i) => !dismissed.includes(i.notifId)) ?? []; //check dismissed
+  const currentNotifs = notDismissed.filter(
+    (i) => i.expDate && new Date(i.expDate).getTime() > new Date().getTime(),
+  ); //check expired
+
+  const clearNotif = (id?: string) => {
+    const toBeRemoved = id ?? currentNotifs?.[0]?.notifId ?? "";
+    const cleared = [...dismissed, toBeRemoved].filter((v, i, a) => a.indexOf(v) === i);
+
+    setDismissed(cleared);
+    localStorage.setItem(`notifs.${userQuery?.data?.user?.username}`, JSON.stringify(cleared));
+  };
+
+  const resetNotifs = () => {
+    setDismissed([]);
+    localStorage.setItem(`notifs.${userQuery?.data?.user?.username}`, JSON.stringify([]));
+  };
+  return {
+    notifications: currentNotifs,
+    dismissed: dismissed,
+    allNotifications: result.data ?? [],
+    clearNotif: clearNotif,
+    resetNotifs: resetNotifs,
+  };
+};