@databiosphere/findable-ui 21.2.0 → 21.4.0

package/tests/dataDictionary_utils.test.ts

@@ -0,0 +1,153 @@
+import {
+  annotateColumnConfig,
+  annotateDefaultCategoryConfig,
+  annotateEntityCategoryConfig,
+  annotateEntityConfig,
+} from "../src/components/DataDictionary/common/utils";
+import { SiteConfig } from "../src/config/entities";
+
+describe("Data Dictionary", () => {
+  it("annotates entity", () => {
+    const key = "entity";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for entity",
+      label: "entity",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          key,
+          list: {
+            columns: [{ id: "col150" }, { id: "col1" }],
+          },
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateEntityConfig(siteConfig, annotationsByKey);
+
+    // Confirm entity is annotated.
+    const entity = siteConfig.entities[0];
+    expect(entity.annotation).toEqual(annotation);
+  });
+
+  it("annotates entity category config", () => {
+    const key = "filter0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for filter 0",
+      label: "filter 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          categoryGroupConfig: {
+            categoryGroups: [
+              {
+                categoryConfigs: [
+                  {
+                    key,
+                    label: "filter 0",
+                  },
+                ],
+              },
+            ],
+          },
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateEntityCategoryConfig(siteConfig, annotationsByKey);
+
+    // Confirm filter is annotated.
+    const categoryConfig =
+      siteConfig.entities[0].categoryGroupConfig?.categoryGroups[0]
+        .categoryConfigs[0];
+    expect(categoryConfig?.annotation).toEqual(annotation);
+  });
+
+  it("annotates default category config", () => {
+    const key = "filter0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for filter 0",
+      label: "filter 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      categoryGroupConfig: {
+        categoryGroups: [
+          {
+            categoryConfigs: [
+              {
+                key,
+                label: "filter 0",
+              },
+            ],
+          },
+        ],
+      },
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateDefaultCategoryConfig(siteConfig, annotationsByKey);
+
+    // Confirm filter is annotated.
+    const categoryConfig =
+      siteConfig.categoryGroupConfig?.categoryGroups[0].categoryConfigs[0];
+    expect(categoryConfig?.annotation).toEqual(annotation);
+  });
+
+  it("annotates column", () => {
+    const key = "col0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for column 0",
+      label: "column 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          list: {
+            columns: [{ id: key }, { id: "col1" }],
+          },
+          name: "entity",
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateColumnConfig(siteConfig, annotationsByKey);
+
+    // Confirm column 0 is annotated and column 1 is not.
+    const columns = siteConfig.entities[0].list.columns ?? [];
+    expect((columns[0]?.meta as any)?.annotation).toEqual(annotation);
+    expect((columns[1]?.meta as any)?.annotation).toBeUndefined();
+  });
+});

package/tests/provider.test.tsx

@@ -0,0 +1,191 @@
+import { jest } from "@jest/globals";
+import { act, render, screen } from "@testing-library/react";
+import React from "react";
+import { LoginGuardContext } from "../src/providers/loginGuard/context";
+
+jest.unstable_mockModule("../src/hooks/useConfig", () => ({
+  useConfig: jest.fn(),
+}));
+
+jest.unstable_mockModule("../src/providers/authentication/auth/hook", () => ({
+  useAuth: jest.fn(),
+}));
+
+jest.unstable_mockModule(
+  "../src/hooks/authentication/config/useAuthenticationConfig",
+  () => ({
+    useAuthenticationConfig: jest.fn(),
+  })
+);
+
+const TEST_ID_LOGIN_DIALOG = "login-dialog";
+const TEXT_DIALOG_CLOSED = "closed";
+const TEXT_DIALOG_OPEN = "open";
+jest.unstable_mockModule(
+  "../src/components/common/LoginDialog/loginDialog",
+  () => ({
+    LoginDialog: ({ open }: { open: boolean }): JSX.Element => (
+      <div data-testid={TEST_ID_LOGIN_DIALOG}>
+        {open ? TEXT_DIALOG_OPEN : TEXT_DIALOG_CLOSED}
+      </div>
+    ),
+  })
+);
+
+const { useConfig } = await import("../src/hooks/useConfig");
+const { useAuth } = await import("../src/providers/authentication/auth/hook");
+const { useAuthenticationConfig } = await import(
+  "../src/hooks/authentication/config/useAuthenticationConfig"
+);
+
+const { LoginGuardProvider } = await import(
+  "../src/providers/loginGuard/provider"
+);
+
+const TEXT_BUTTON_EXPORT = "export";
+
+describe("LoginGuardProvider", () => {
+  beforeEach(() => {
+    // Mock hooks used by login guard.
+    (useConfig as jest.Mock).mockReturnValue({
+      config: {
+        exportsRequireAuth: true,
+      },
+    });
+    (useAuth as jest.Mock).mockReturnValue({
+      authState: {
+        isAuthenticated: false,
+      },
+    });
+    (useAuthenticationConfig as jest.Mock).mockReturnValue({});
+  });
+
+  it("should render children and login dialog closed", () => {
+    render(
+      <LoginGuardProvider>
+        <div data-testid="child">child component</div>
+      </LoginGuardProvider>
+    );
+
+    expect(screen.getByTestId("child")).toBeTruthy();
+    expect(screen.getByTestId(TEST_ID_LOGIN_DIALOG).textContent).toBe(
+      TEXT_DIALOG_CLOSED
+    );
+  });
+
+  it("calls callback immediately if user is authenticated", () => {
+    const callback = jest.fn();
+
+    // Simulate user authentication.
+    (useAuth as jest.Mock).mockReturnValue({
+      authState: { isAuthenticated: true },
+    });
+
+    render(
+      <LoginGuardProvider>
+        <LoginGuardContext.Consumer>
+          {({ requireLogin }) => (
+            <button onClick={() => requireLogin(callback)}>
+              {TEXT_BUTTON_EXPORT}
+            </button>
+          )}
+        </LoginGuardContext.Consumer>
+      </LoginGuardProvider>
+    );
+
+    // Click button requiring login.
+    act(() => {
+      screen.getByText(TEXT_BUTTON_EXPORT).click();
+    });
+
+    // User is authenticated; callback should be fired immediately.
+    expect(callback).toHaveBeenCalled();
+
+    // Login dialog should not be open.
+    expect(screen.getByTestId(TEST_ID_LOGIN_DIALOG).textContent).toBe(
+      TEXT_DIALOG_CLOSED
+    );
+  });
+
+  it("calls callback immediately if exportsRequireAuth is false", () => {
+    const callback = jest.fn();
+
+    // Simulate exportsRequireAuth being false.
+    (useConfig as jest.Mock).mockReturnValue({
+      config: {
+        exportsRequireAuth: false,
+      },
+    });
+
+    render(
+      <LoginGuardProvider>
+        <LoginGuardContext.Consumer>
+          {({ requireLogin }) => (
+            <button onClick={() => requireLogin(callback)}>
+              {TEXT_BUTTON_EXPORT}
+            </button>
+          )}
+        </LoginGuardContext.Consumer>
+      </LoginGuardProvider>
+    );
+
+    // Click button requiring login.
+    act(() => {
+      screen.getByText(TEXT_BUTTON_EXPORT).click();
+    });
+
+    // exportsRequireAuth is false; callback should be fired immediately.
+    expect(callback).toHaveBeenCalled();
+
+    // Login dialog should not be open.
+    expect(screen.getByTestId(TEST_ID_LOGIN_DIALOG).textContent).toBe(
+      TEXT_DIALOG_CLOSED
+    );
+  });
+
+  it("should call callback after user authenticates", async () => {
+    const callback = jest.fn();
+
+    const { rerender } = render(
+      <LoginGuardProvider>
+        <LoginGuardContext.Consumer>
+          {({ requireLogin }) => (
+            <button onClick={() => requireLogin(callback)}>
+              {TEXT_BUTTON_EXPORT}
+            </button>
+          )}
+        </LoginGuardContext.Consumer>
+      </LoginGuardProvider>
+    );
+
+    // Click button requiring login.
+    act(() => {
+      screen.getByText(TEXT_BUTTON_EXPORT).click();
+    });
+
+    // User is not authenticated; callback should not have been called.
+    expect(callback).not.toHaveBeenCalled();
+
+    // User is not authenticated; login dialog should be open.
+    expect(screen.getByTestId(TEST_ID_LOGIN_DIALOG).textContent).toBe(
+      TEXT_DIALOG_OPEN
+    );
+
+    // Simulate user authentication.
+    await act(async () => {
+      (useAuth as jest.Mock).mockReturnValue({
+        authState: { isAuthenticated: true },
+      });
+    });
+
+    // Rerender to trigger useEffect.
+    rerender(
+      <LoginGuardProvider>
+        <div />
+      </LoginGuardProvider>
+    );
+
+    // Callback should be called (in useEffect called on re-render).
+    expect(callback).toHaveBeenCalled();
+  });
+});

package/types/data-explorer-ui.d.ts

@@ -18,6 +18,7 @@ import type {} from "@mui/material/Typography";
 import type {} from "@tanstack/react-table";
 import { RowData } from "@tanstack/react-table";
 import { DataLayer } from "../src/common/analytics/entities";
+import { DataDictionaryAnnotation } from "../src/common/entities";
 import {
   CustomFeatureInitialTableState,
   CustomFeatureInstance,
@@ -268,6 +269,7 @@ declare module "@tanstack/react-table" {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars -- TData and TValue are unused variables.
   interface ColumnMeta<TData extends RowData, TValue> {
     align?: TableCellProps["align"];
+    annotation?: DataDictionaryAnnotation;
     columnPinned?: boolean;
     header?: string;
     width?: GridTrackSize;