ID-1174 Combine loadTerraUser sam api calls into one (#4844)

Co-authored-by: Nick Watts <[email protected]>

Author: Ghost-in-a-Jar

src/auth/auth.ts

@@ -13,7 +13,6 @@ import { fetchOk } from 'src/libs/ajax/ajax-common';
 import { ExternalCredentials } from 'src/libs/ajax/ExternalCredentials';
 import { Groups } from 'src/libs/ajax/Groups';
 import { Metrics } from 'src/libs/ajax/Metrics';
-import { TermsOfService } from 'src/libs/ajax/TermsOfService';
 import { SamUserAttributes, User } from 'src/libs/ajax/User';
 import { withErrorIgnoring, withErrorReporting } from 'src/libs/error';
 import Events, { captureAppcuesEvent, MetricsEventName } from 'src/libs/events';
@@ -483,20 +482,10 @@ export const loadTerraUser = async (): Promise<void> => {
   try {
     const signInStatus = 'userLoaded';
     const getProfile = User().profile.get();
-    const getAllowances = User().getUserAllowances();
-    const getAttributes = User().getUserAttributes();
-    const getTermsOfService = TermsOfService().getUserTermsOfServiceDetails();
-    const getEnterpriseFeatures = User().getEnterpriseFeatures();
-    const getSamUser = User().getSamUserResponse();
-    const [profile, terraUserAllowances, terraUserAttributes, termsOfService, enterpriseFeatures, samUser] =
-      await Promise.all([
-        getProfile,
-        getAllowances,
-        getAttributes,
-        getTermsOfService,
-        getEnterpriseFeatures,
-        getSamUser,
-      ]);
+    const getCombinedState = User().getSamUserCombinedState();
+    const [profile, terraUserCombinedState] = await Promise.all([getProfile, getCombinedState]);
+    const { terraUserAttributes, enterpriseFeatures, samUser, terraUserAllowances, termsOfService } =
+      terraUserCombinedState;
     clearNotification(sessionExpirationProps.id);
     userStore.update((state: TerraUserState) => ({
       ...state,

src/auth/login.test.ts

@@ -5,8 +5,8 @@ import { loadTerraUser } from 'src/auth/auth';
 import { Groups, GroupsContract } from 'src/libs/ajax/Groups';
 import { Metrics, MetricsContract } from 'src/libs/ajax/Metrics';
 import { SamUserTermsOfServiceDetails, TermsOfService, TermsOfServiceContract } from 'src/libs/ajax/TermsOfService';
-import { SamUserResponse, User, UserContract } from 'src/libs/ajax/User';
-import { oidcStore, TerraUserState, userStore } from 'src/libs/state';
+import { SamUserCombinedStateResponse, SamUserResponse, User, UserContract } from 'src/libs/ajax/User';
+import { oidcStore, userStore } from 'src/libs/state';
 
 jest.mock('src/libs/ajax/TermsOfService');
 jest.mock('src/libs/ajax/User');
@@ -73,6 +73,14 @@ const testSamUserAllowances = {
   details: testSamUserAllowancesDetails,
 };
 
+const mockSamUserCombinedState: SamUserCombinedStateResponse = {
+  samUser: mockSamUserResponse,
+  terraUserAllowances: testSamUserAllowances,
+  terraUserAttributes: { marketingConsent: false },
+  termsOfService: mockSamUserTermsOfServiceDetails,
+  enterpriseFeatures: [],
+};
+
 const mockNihDatasetPermission = {
   name: 'testNihDatasetPermissionName',
   authorized: true,
@@ -87,11 +95,7 @@ const mockOrchestrationNihStatusResponse = {
 // TODO centralize Ajax mock setup so it can be reused across tests
 describe('a request to load a terra user', () => {
   // Arrange (shared between tests for the success case)
-  const getUserAllowancesFunction = jest.fn().mockResolvedValue(testSamUserAllowances);
-  const getUserAttributesFunction = jest.fn().mockResolvedValue({ marketingConsent: false });
-  const getUserTermsOfServiceDetailsFunction = jest.fn().mockResolvedValue(mockSamUserTermsOfServiceDetails);
-  const getEnterpriseFeaturesFunction = jest.fn().mockResolvedValue([]);
-  const getSamUserResponseFunction = jest.fn().mockResolvedValue(mockSamUserResponse);
+  const getSamUserCombinedStateFunction = jest.fn().mockResolvedValue(mockSamUserCombinedState);
   const getNihStatusFunction = jest.fn().mockResolvedValue(mockOrchestrationNihStatusResponse);
   const getFenceStatusFunction = jest.fn().mockResolvedValue({});
 
@@ -105,11 +109,7 @@ describe('a request to load a terra user', () => {
       captureEvent: jest.fn(),
     } as Partial<MetricsContract> as MetricsContract);
     asMockedFn(User).mockReturnValue({
-      getUserAllowances: getUserAllowancesFunction,
-      getUserAttributes: getUserAttributesFunction,
-      getUserTermsOfServiceDetails: getUserTermsOfServiceDetailsFunction,
-      getEnterpriseFeatures: getEnterpriseFeaturesFunction,
-      getSamUserResponse: getSamUserResponseFunction,
+      getSamUserCombinedState: getSamUserCombinedStateFunction,
       getNihStatus: getNihStatusFunction,
       getFenceStatus: getFenceStatusFunction,
       profile: {
@@ -131,36 +131,24 @@ describe('a request to load a terra user', () => {
       await act(() => loadTerraUser());
 
       // Assert
-      expect(getSamUserResponseFunction).toHaveBeenCalled();
+      expect(getSamUserCombinedStateFunction).toHaveBeenCalled();
     });
     it('should update the samUser in state', async () => {
       // Act
       await act(() => loadTerraUser());
 
-      let samUser;
-      await act(async () => {
-        samUser = await getSamUserResponseFunction.mock.results[0].value;
-      });
-      userStore.update((state: TerraUserState) => ({
-        ...state,
-        samUser,
-      }));
       // Assert
-      expect(getSamUserResponseFunction).toHaveBeenCalled();
+      expect(getSamUserCombinedStateFunction).toHaveBeenCalled();
       expect(userStore.get().samUser).toEqual(mockSamUserResponse);
     });
     describe('when not successful', () => {
       it('should fail with an error', async () => {
         // // Arrange
         // mock a failure to get samUserResponse
-        const getSamUserResponseFunction = jest.fn().mockRejectedValue(new Error('unknown'));
+        const getSamUserCombinedStateMockFailure = jest.fn().mockRejectedValue(new Error('unknown'));
 
         asMockedFn(User).mockReturnValue({
-          getUserAllowances: getUserAllowancesFunction,
-          getUserAttributes: getUserAttributesFunction,
-          getUserTermsOfServiceDetails: getUserTermsOfServiceDetailsFunction,
-          getEnterpriseFeatures: getEnterpriseFeaturesFunction,
-          getSamUserResponse: getSamUserResponseFunction,
+          getSamUserCombinedState: getSamUserCombinedStateMockFailure,
           profile: {
             get: jest.fn().mockReturnValue(mockTerraUserProfile),
           },

src/libs/ajax/User.ts

@@ -1,5 +1,6 @@
 import _ from 'lodash/fp';
 import { authOpts, fetchOrchestration, fetchSam, jsonBody } from 'src/libs/ajax/ajax-common';
+import { SamUserTermsOfServiceDetails } from 'src/libs/ajax/TermsOfService';
 import { TerraUserProfile } from 'src/libs/state';
 
 export interface SamUserRegistrationStatusResponse {
@@ -162,6 +163,14 @@ export type SamUserAttributesRequest = {
   marketingConsent: boolean | undefined;
 };
 
+export type SamUserCombinedStateResponse = {
+  samUser: SamUserResponse;
+  terraUserAllowances: SamUserAllowances;
+  terraUserAttributes: SamUserAttributes;
+  termsOfService: SamUserTermsOfServiceDetails;
+  enterpriseFeatures: string[];
+};
+
 export type OrchestrationUserRegistrationRequest = object;
 
 export const User = (signal?: AbortSignal) => {
@@ -171,11 +180,6 @@ export const User = (signal?: AbortSignal) => {
       return res.json();
     },
 
-    getUserAllowances: async (): Promise<SamUserAllowances> => {
-      const res = await fetchSam('api/users/v2/self/allowed', _.mergeAll([authOpts(), { signal }]));
-      return res.json();
-    },
-
     getUserAttributes: async (): Promise<SamUserAttributes> => {
       const res = await fetchSam('api/users/v2/self/attributes', _.mergeAll([authOpts(), { signal }]));
       return res.json().then((obj) => {
@@ -192,17 +196,44 @@ export const User = (signal?: AbortSignal) => {
       return res.json();
     },
 
-    getEnterpriseFeatures: async (): Promise<string[]> => {
-      try {
-        const res = await fetchSam(
-          '/api/resources/v2?format=flat&resourceTypes=enterprise-feature&roles=user',
-          _.mergeAll([authOpts(), { signal }])
-        );
-        const json = await res.json();
-        return json.resources.map((resource) => resource.resourceId);
-      } catch (error: unknown) {
-        return [];
-      }
+    getSamUserCombinedState: async (): Promise<SamUserCombinedStateResponse> => {
+      const res = await fetchSam('api/users/v2/self/combinedState', _.mergeAll([authOpts(), { signal }]));
+      const responseJson = await res.json();
+      const samUser: SamUserResponse = {
+        id: responseJson.samUser.id,
+        googleSubjectId: responseJson.samUser.googleSubjectId,
+        email: responseJson.samUser.email,
+        azureB2CId: responseJson.samUser.azureB2CId,
+        allowed: responseJson.samUser.allowed,
+        createdAt: responseJson.samUser.createdAt ? new Date(responseJson.samUser.createdAt) : undefined,
+        registeredAt: responseJson.samUser.registeredAt ? new Date(responseJson.samUser.registeredAt) : undefined,
+        updatedAt: responseJson.samUser.updatedAt ? new Date(responseJson.samUser.updatedAt) : undefined,
+      };
+
+      const terraUserAllowances: SamUserAllowances = responseJson.allowances;
+
+      const terraUserAttributes: SamUserAttributes = { marketingConsent: responseJson.attributes.marketingConsent };
+
+      const termsOfService: SamUserTermsOfServiceDetails = {
+        latestAcceptedVersion: responseJson.termsOfServiceDetails.latestAcceptedVersion,
+        acceptedOn: responseJson.termsOfServiceDetails.acceptedOn
+          ? new Date(responseJson.termsOfServiceDetails.acceptedOn)
+          : undefined,
+        permitsSystemUsage: responseJson.termsOfServiceDetails.permitsSystemUsage,
+        isCurrentVersion: responseJson.termsOfServiceDetails.isCurrentVersion,
+      };
+
+      const enterpriseFeatures = responseJson.additionalDetails.enterpriseFeatures
+        ? responseJson.additionalDetails.enterpriseFeatures.resources.map((resource) => resource.resourceId)
+        : [];
+
+      return {
+        samUser,
+        terraUserAllowances,
+        terraUserAttributes,
+        termsOfService,
+        enterpriseFeatures,
+      };
     },
 
     registerWithProfile: async (
@@ -267,21 +298,6 @@ export const User = (signal?: AbortSignal) => {
       return res.json();
     },
 
-    getSamUserResponse: async (): Promise<SamUserResponse> => {
-      const res = await fetchSam('api/users/v2/self', _.mergeAll([authOpts(), { method: 'GET' }]));
-      const json = await res.json();
-      return {
-        id: json.id,
-        googleSubjectId: json.googleSubjectId,
-        email: json.email,
-        azureB2CId: json.azureB2CId,
-        allowed: json.allowed,
-        createdAt: json.createdAt ? new Date(json.createdAt) : undefined,
-        registeredAt: json.registeredAt ? new Date(json.registeredAt) : undefined,
-        updatedAt: json.updatedAt ? new Date(json.updatedAt) : undefined,
-      };
-    },
-
     getNihStatus: async (): Promise<OrchestrationNihStatusResponse | undefined> => {
       try {
         const res = await fetchOrchestration('api/nih/status', _.merge(authOpts(), { signal }));

src/registration/terms-of-service/TermsOfServicePage.test.ts

@@ -5,7 +5,13 @@ import { Ajax } from 'src/libs/ajax';
 import { Groups, GroupsContract } from 'src/libs/ajax/Groups';
 import { Metrics, MetricsContract } from 'src/libs/ajax/Metrics';
 import { SamUserTermsOfServiceDetails, TermsOfService, TermsOfServiceContract } from 'src/libs/ajax/TermsOfService';
-import { SamUserAllowances, SamUserResponse, User, UserContract } from 'src/libs/ajax/User';
+import {
+  SamUserAllowances,
+  SamUserCombinedStateResponse,
+  SamUserResponse,
+  User,
+  UserContract,
+} from 'src/libs/ajax/User';
 import { AuthState, authStore } from 'src/libs/state';
 import { TermsOfServicePage } from 'src/registration/terms-of-service/TermsOfServicePage';
 import { asMockedFn, renderWithAppContexts as render } from 'src/testing/test-utils';
@@ -68,6 +74,13 @@ const setupMockAjax = async (
     registeredAt: new Date('1970-01-01'),
     updatedAt: new Date('1970-01-01'),
   };
+  const mockSamUserCombinedState: SamUserCombinedStateResponse = {
+    samUser: mockSamUserResponse,
+    terraUserAllowances,
+    terraUserAttributes: { marketingConsent: false },
+    termsOfService,
+    enterpriseFeatures: [],
+  };
   const getTermsOfServiceText = jest.fn().mockResolvedValue('some text');
   const getUserTermsOfServiceDetails = jest
     .fn()
@@ -95,10 +108,7 @@ const setupMockAjax = async (
   } as Partial<MetricsContract> as MetricsContract);
 
   asMockedFn(User).mockReturnValue({
-    getUserAttributes: jest.fn().mockResolvedValue({ marketingConsent: true }),
-    getUserAllowances: jest.fn().mockResolvedValue(terraUserAllowances),
-    getEnterpriseFeatures: jest.fn().mockResolvedValue([]),
-    getSamUserResponse: jest.fn().mockResolvedValue(mockSamUserResponse),
+    getSamUserCombinedState: jest.fn().mockResolvedValue(mockSamUserCombinedState),
     profile: {
       get: jest.fn().mockResolvedValue({ keyValuePairs: [] }),
       update: jest.fn().mockResolvedValue({ keyValuePairs: [] }),