@databiosphere/findable-ui 19.0.0 → 20.0.0

package/src/providers/authentication.tsx

@@ -1,181 +0,0 @@
-import Router, { useRouter } from "next/router";
-import React, { createContext, ReactNode, useCallback } from "react";
-import { useIdleTimer } from "react-idle-timer";
-import { LOGIN_STATUS_NOT_STARTED } from "../hooks/useAuthentication/common/constants";
-import {
-  AUTHENTICATION_STATUS,
-  LoginStatus,
-} from "../hooks/useAuthentication/common/entities";
-import { useAuthenticationComplete } from "../hooks/useAuthentication/useAuthenticationComplete";
-import { useAuthenticationStatus } from "../hooks/useAuthentication/useAuthenticationStatus";
-import {
-  useFetchGoogleProfile,
-  UserProfile,
-} from "../hooks/useAuthentication/useFetchGoogleProfile";
-import {
-  TerraNIHResponse,
-  useFetchTerraNIHProfile,
-} from "../hooks/useAuthentication/useFetchTerraNIHProfile";
-import {
-  TerraResponse,
-  useFetchTerraProfile,
-} from "../hooks/useAuthentication/useFetchTerraProfile";
-import {
-  TerraTermsOfServiceResponse,
-  useFetchTerraTermsOfService,
-} from "../hooks/useAuthentication/useFetchTerraTermsOfService";
-import { useTokenClient } from "../hooks/useAuthentication/useTokenClient";
-import { useConfig } from "../hooks/useConfig";
-import { INACTIVITY_PARAM } from "../hooks/useSessionTimeout";
-
-// Template constants
-export const ROUTE_LOGIN = "/login";
-
-type AuthenticateUserFn = () => void;
-type RequestAuthenticationFn = () => void;
-
-/**
- * Model of authentication context.
- */
-export interface AuthContextProps {
-  authenticateUser: AuthenticateUserFn;
-  authenticationStatus: AUTHENTICATION_STATUS;
-  isAuthenticated: boolean;
-  isEnabled: boolean;
-  requestAuthentication: RequestAuthenticationFn;
-  terraNIHProfileLoginStatus: LoginStatus<TerraNIHResponse>;
-  terraProfileLoginStatus: LoginStatus<TerraResponse>;
-  terraTOSLoginStatus: LoginStatus<TerraTermsOfServiceResponse>;
-  token?: string;
-  userProfile?: UserProfile;
-}
-
-/**
- * Auth context for storing and using auth-related state.
- */
-export const AuthContext = createContext<AuthContextProps>({
-  // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
-  authenticateUser: () => {},
-  authenticationStatus: AUTHENTICATION_STATUS.INCOMPLETE,
-  isAuthenticated: false,
-  isEnabled: false,
-  // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
-  requestAuthentication: () => {},
-  terraNIHProfileLoginStatus:
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraNIHResponse>,
-  terraProfileLoginStatus:
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraResponse>,
-  terraTOSLoginStatus:
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraTermsOfServiceResponse>,
-  token: undefined,
-  userProfile: undefined,
-});
-
-interface Props {
-  children: ReactNode | ReactNode[];
-  sessionTimeout?: number;
-}
-
-/**
- * Auth provider for consuming components to subscribe to changes in auth-related state.
- * @param props - Component inputs.
- * @param props.children - Set of children components that can possibly consume the query provider.
- * @param props.sessionTimeout - If provided, will set the value for a session timeout (in milliseconds).
- * @returns Provider element to be used by consumers to both update authentication state and subscribe to changes in authentication state.
- */
-export function AuthProvider({ children, sessionTimeout }: Props): JSX.Element {
-  const { config } = useConfig();
-  const { authentication, redirectRootToPath } = config;
-  const { basePath } = useRouter();
-  const { token, tokenClient } = useTokenClient();
-  const terraNIHProfileLoginStatus = useFetchTerraNIHProfile(token);
-  const terraProfileLoginStatus = useFetchTerraProfile(token);
-  const terraTOSLoginStatus = useFetchTerraTermsOfService(token);
-  const userProfileLoginStatus = useFetchGoogleProfile(token);
-  const isEnabled = Boolean(authentication);
-  const isAuthenticated = userProfileLoginStatus.isSuccess;
-  const releaseToken = shouldReleaseToken(
-    userProfileLoginStatus,
-    terraProfileLoginStatus,
-    terraTOSLoginStatus
-  );
-  const authenticationStatus = useAuthenticationStatus(
-    userProfileLoginStatus,
-    terraProfileLoginStatus,
-    terraTOSLoginStatus,
-    terraNIHProfileLoginStatus
-  );
-
-  // Handle completion of authentication process.
-  useAuthenticationComplete(authenticationStatus);
-
-  /**
-   * If sessionTimeout is set and user is authenticated, the app will reload and redirect to
-   * origin, including base path, root path, and query param.
-   */
-  useIdleTimer({
-    onIdle: () =>
-      isAuthenticated &&
-      sessionTimeout &&
-      (window.location.href =
-        window.location.origin +
-        basePath +
-        redirectRootToPath +
-        "?" +
-        `${INACTIVITY_PARAM}=true`),
-    timeout: sessionTimeout,
-  });
-
-  /**
-   * Requests access token and authenticates user.
-   */
-  const authenticateUser = useCallback((): void => {
-    tokenClient.requestAccessToken();
-  }, [tokenClient]);
-
-  /**
-   * Navigates to login page.
-   */
-  const requestAuthentication = useCallback((): void => {
-    Router.push(ROUTE_LOGIN);
-  }, []);
-
-  return (
-    <AuthContext.Provider
-      value={{
-        authenticateUser,
-        authenticationStatus,
-        isAuthenticated,
-        isEnabled,
-        requestAuthentication,
-        terraNIHProfileLoginStatus,
-        terraProfileLoginStatus,
-        terraTOSLoginStatus,
-        token: releaseToken ? token : undefined,
-        userProfile: userProfileLoginStatus.response,
-      }}
-    >
-      {children}
-    </AuthContext.Provider>
-  );
-}
-
-/**
- * Token is released for the following conditions:
- * - Terra endpoint is configured and the terms of service response is successful, or
- * - Terra endpoint is not configured and the user profile response is successful.
- * @param userProfileLoginStatus - User profile login status.
- * @param terraProfileLoginStatus - Terra profile login status.
- * @param terraTOSLoginStatus - Terra terms of service login status.
- * @returns true if the token should be released.
- */
-export function shouldReleaseToken(
-  userProfileLoginStatus: LoginStatus<UserProfile>,
-  terraProfileLoginStatus: LoginStatus<TerraResponse>,
-  terraTOSLoginStatus: LoginStatus<TerraTermsOfServiceResponse>
-): boolean {
-  if (terraProfileLoginStatus.isSupported) {
-    return terraTOSLoginStatus.isSuccess;
-  }
-  return userProfileLoginStatus.isSuccess;
-}

package/tests/authentication.test.ts

@@ -1,142 +0,0 @@
-import { jest } from "@jest/globals";
-import { LOGIN_STATUS_NOT_STARTED } from "../src/hooks/useAuthentication/common/constants";
-import {
-  LoginStatus,
-  REQUEST_STATUS,
-} from "../src/hooks/useAuthentication/common/entities";
-import { GoogleResponse } from "../src/hooks/useAuthentication/useFetchGoogleProfile";
-import { TerraResponse } from "../src/hooks/useAuthentication/useFetchTerraProfile";
-import { TerraTermsOfServiceResponse } from "../src/hooks/useAuthentication/useFetchTerraTermsOfService";
-
-jest.unstable_mockModule("react-idle-timer", () => ({
-  useIdleTimer: jest.fn(),
-}));
-
-const { shouldReleaseToken } = await import("../src/providers/authentication");
-
-describe("authentication", () => {
-  // Boolean constants.
-  const IS_NOT_SUCCESS = false;
-  const IS_NOT_SUPPORTED = false;
-  const IS_SUCCESS = true;
-  const IS_SUPPORTED = true;
-  // Response objects.
-  const GOOGLE_RESPONSE = {} as GoogleResponse;
-  const TERRA_RESPONSE = {} as TerraResponse;
-  const TERRA_TOS_RESPONSE = {} as TerraTermsOfServiceResponse;
-  // Login statuses - not started, not supported.
-  const LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA: LoginStatus<TerraResponse> =
-    {
-      isSuccess: IS_NOT_SUCCESS,
-      isSupported: IS_NOT_SUPPORTED,
-      requestStatus: REQUEST_STATUS.NOT_STARTED,
-      response: TERRA_RESPONSE,
-    };
-  const LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
-    {
-      isSuccess: IS_NOT_SUCCESS,
-      isSupported: IS_NOT_SUPPORTED,
-      requestStatus: REQUEST_STATUS.NOT_STARTED,
-      response: TERRA_TOS_RESPONSE,
-    };
-  // Login statuses - not started, supported.
-  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA =
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraResponse>;
-  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA_TOS =
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraTermsOfServiceResponse>;
-  const LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE =
-    LOGIN_STATUS_NOT_STARTED as LoginStatus<GoogleResponse>;
-  // Login statuses - completed, not successful.
-  const LOGIN_STATUS_COMPLETED_NOT_SUCCESS_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
-    {
-      isSuccess: IS_NOT_SUCCESS,
-      isSupported: IS_SUPPORTED,
-      requestStatus: REQUEST_STATUS.COMPLETED,
-      response: TERRA_TOS_RESPONSE,
-    };
-  const LOGIN_STATUS_COMPLETED_NOT_SUCCESS_USER_PROFILE: LoginStatus<GoogleResponse> =
-    {
-      isSuccess: IS_NOT_SUCCESS,
-      isSupported: IS_SUPPORTED,
-      requestStatus: REQUEST_STATUS.COMPLETED,
-      response: GOOGLE_RESPONSE,
-    };
-  // Login statuses - completed, successful.
-  const LOGIN_STATUS_COMPLETED_SUCCESS_TERRA: LoginStatus<TerraResponse> = {
-    isSuccess: IS_SUCCESS,
-    isSupported: IS_SUPPORTED,
-    requestStatus: REQUEST_STATUS.COMPLETED,
-    response: TERRA_RESPONSE,
-  };
-  const LOGIN_STATUS_COMPLETED_SUCCESS_TERRA_TOS: LoginStatus<TerraTermsOfServiceResponse> =
-    {
-      isSuccess: IS_SUCCESS,
-      isSupported: IS_SUPPORTED,
-      requestStatus: REQUEST_STATUS.COMPLETED,
-      response: TERRA_TOS_RESPONSE,
-    };
-  const LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE: LoginStatus<GoogleResponse> =
-    {
-      isSuccess: IS_SUCCESS,
-      isSupported: IS_SUPPORTED,
-      requestStatus: REQUEST_STATUS.COMPLETED,
-      response: GOOGLE_RESPONSE,
-    };
-
-  describe("Should Release Token", () => {
-    describe("shouldReleaseToken", () => {
-      describe("Terra endpoint is configured", () => {
-        test("login not started", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE,
-            LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA,
-            LOGIN_STATUS_NOT_STARTED_SUPPORTED_TERRA_TOS
-          );
-          expect(releaseToken).toBeFalsy();
-        });
-        test("login completed and Terra terms of service is not successful", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
-            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA,
-            LOGIN_STATUS_COMPLETED_NOT_SUCCESS_TERRA_TOS
-          );
-          expect(releaseToken).toBeFalsy();
-        });
-        test("login completed and Terra terms of service is successful", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
-            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA,
-            LOGIN_STATUS_COMPLETED_SUCCESS_TERRA_TOS
-          );
-          expect(releaseToken).toBeTruthy();
-        });
-      });
-      describe("Terra endpoint is not configured", () => {
-        test("login not started", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_NOT_STARTED_SUPPORTED_USER_PROFILE,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
-          );
-          expect(releaseToken).toBeFalsy();
-        });
-        test("user profile is not successful", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_COMPLETED_NOT_SUCCESS_USER_PROFILE,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
-          );
-          expect(releaseToken).toBeFalsy();
-        });
-        test("user profile is successful", () => {
-          const releaseToken = shouldReleaseToken(
-            LOGIN_STATUS_COMPLETED_SUCCESS_USER_PROFILE,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA,
-            LOGIN_STATUS_NOT_STARTED_NOT_SUPPORTED_TERRA_TOS
-          );
-          expect(releaseToken).toBeTruthy();
-        });
-      });
-    });
-  });
-});

package/tests/useAuthenticationStatus.test.ts

@@ -1,155 +0,0 @@
-import {
-  LOGIN_STATUS_NOT_STARTED,
-  LOGIN_STATUS_NOT_SUPPORTED,
-} from "../src/hooks/useAuthentication/common/constants";
-import {
-  AUTHENTICATION_STATUS,
-  LoginResponse,
-  LoginStatus,
-  REQUEST_STATUS,
-} from "../src/hooks/useAuthentication/common/entities";
-import { getAuthenticationStatus } from "../src/hooks/useAuthentication/useAuthenticationStatus";
-
-const TEST_LOGIN_IS_COMPLETE = "login is complete";
-const TEST_LOGIN_NOT_STARTED = "login not started";
-const TEST_USER_PROFILE_AND_TERRA_AND_TOS_IS_COMPLETE =
-  "user profile, terra and terms of service is complete";
-const TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE =
-  "user profile and terra is complete";
-const TEST_USER_PROFILE_IS_COMPLETE = "user profile is complete";
-
-describe("useAuthenticationStatus", () => {
-  // Login statuses - completed, successful.
-  const LOGIN_STATUS_COMPLETED_SUCCESS: LoginStatus<LoginResponse> = {
-    isSuccess: true,
-    isSupported: true,
-    requestStatus: REQUEST_STATUS.COMPLETED,
-    response: {} as LoginResponse,
-  };
-
-  describe("Calculate Authentication Status", () => {
-    describe("getAuthenticationStatus", () => {
-      describe("endpoints are configured", () => {
-        test(TEST_LOGIN_NOT_STARTED, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_USER_PROFILE_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_USER_PROFILE_AND_TERRA_AND_TOS_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_LOGIN_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
-        });
-      });
-      describe("NIH endpoint is not configured", () => {
-        test(TEST_LOGIN_NOT_STARTED, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_USER_PROFILE_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_USER_PROFILE_AND_TERRA_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_NOT_STARTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_LOGIN_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
-        });
-      });
-      describe("Terra endpoint is not configured", () => {
-        test(TEST_LOGIN_NOT_STARTED, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_STARTED,
-          ]);
-          expect(authenticationStatus).toEqual(
-            AUTHENTICATION_STATUS.INCOMPLETE
-          );
-        });
-        test(TEST_LOGIN_IS_COMPLETE, () => {
-          const authenticationStatus = getAuthenticationStatus([
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_NOT_SUPPORTED,
-            LOGIN_STATUS_COMPLETED_SUCCESS,
-          ]);
-          expect(authenticationStatus).toEqual(AUTHENTICATION_STATUS.COMPLETED);
-        });
-      });
-    });
-  });
-});