Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions src/auth/auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -480,20 +480,10 @@ export const loadTerraUser = async (): Promise<void> => {
try {
const signInStatus = 'userLoaded';
const getProfile = Ajax().User.profile.get();
const getAllowances = Ajax().User.getUserAllowances();
const getAttributes = Ajax().User.getUserAttributes();
const getTermsOfService = Ajax().TermsOfService.getUserTermsOfServiceDetails();
const getEnterpriseFeatures = Ajax().User.getEnterpriseFeatures();
const getSamUser = Ajax().User.getSamUserResponse();
const [profile, terraUserAllowances, terraUserAttributes, termsOfService, enterpriseFeatures, samUser] =
await Promise.all([
getProfile,
getAllowances,
getAttributes,
getTermsOfService,
getEnterpriseFeatures,
getSamUser,
]);
const getCombinedState = Ajax().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,
Expand Down
52 changes: 20 additions & 32 deletions src/auth/login.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { loadTerraUser } from 'src/auth/auth';
import { Ajax } from 'src/libs/ajax';
import { GroupRole } from 'src/libs/ajax/Groups';
import { SamUserTermsOfServiceDetails } from 'src/libs/ajax/TermsOfService';
import { SamUserResponse } from 'src/libs/ajax/User';
import { TerraUserState, userStore } from 'src/libs/state';
import { SamUserAttributes, SamUserCombinedStateResponse, SamUserResponse } from 'src/libs/ajax/User';
import { userStore } from 'src/libs/state';

jest.mock('src/libs/ajax');

Expand Down Expand Up @@ -67,6 +67,14 @@ const testSamUserAllowances = {
details: testSamUserAllowancesDetails,
};

const mockSamUserCombinedState: SamUserCombinedStateResponse = {
samUser: mockSamUserResponse,
terraUserAllowances: testSamUserAllowances,
terraUserAttributes: { marketingConsent: false } as SamUserAttributes,
termsOfService: mockSamUserTermsOfServiceDetails,
enterpriseFeatures: [],
};

const mockNihDatasetPermission = {
name: 'testNihDatasetPermissionName',
authorized: true,
Expand All @@ -92,25 +100,17 @@ describe('a request to load a terra user', () => {
});
describe('when successful', () => {
// 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 getNihStatusFunction = jest.fn().mockResolvedValue(mockOrchestrationNihStatusResponse);
const getFenceStatusFunction = jest.fn().mockResolvedValue({});
const getSamUserCombinedStateMock = jest.fn().mockResolvedValue(mockSamUserCombinedState);
const getNihStatusMock = jest.fn().mockResolvedValue(mockOrchestrationNihStatusResponse);
const getFenceStatusMock = jest.fn().mockResolvedValue({});

asMockedFn(Ajax).mockImplementation(
() =>
({
User: {
getUserAllowances: getUserAllowancesFunction,
getUserAttributes: getUserAttributesFunction,
getUserTermsOfServiceDetails: getUserTermsOfServiceDetailsFunction,
getEnterpriseFeatures: getEnterpriseFeaturesFunction,
getSamUserResponse: getSamUserResponseFunction,
getNihStatus: getNihStatusFunction,
getFenceStatus: getFenceStatusFunction,
getSamUserCombinedState: getSamUserCombinedStateMock,
getNihStatus: getNihStatusMock,
getFenceStatus: getFenceStatusMock,
profile: {
get: jest.fn().mockReturnValue(mockTerraUserProfile),
},
Expand All @@ -128,39 +128,27 @@ describe('a request to load a terra user', () => {
await act(() => loadTerraUser());

// Assert
expect(getSamUserResponseFunction).toHaveBeenCalled();
expect(getSamUserCombinedStateMock).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(getSamUserCombinedStateMock).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(Ajax).mockImplementation(
() =>
({
User: {
getUserAllowances: getUserAllowancesFunction,
getUserAttributes: getUserAttributesFunction,
getUserTermsOfServiceDetails: getUserTermsOfServiceDetailsFunction,
getEnterpriseFeatures: getEnterpriseFeaturesFunction,
getSamUserResponse: getSamUserResponseFunction,
getSamUserCombinedState: getSamUserCombinedStateMockFailure,
profile: {
get: jest.fn().mockReturnValue(mockTerraUserProfile),
},
Expand Down
84 changes: 53 additions & 31 deletions src/libs/ajax/User.ts
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down Expand Up @@ -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) => {
Expand All @@ -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) => {
Expand All @@ -192,17 +196,50 @@ 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 = {
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,
} as SamUserResponse;

const terraUserAllowances = {
allowed: responseJson.allowances.allowed,
details: {
enabled: responseJson.allowances.details.enabled,
termsOfService: responseJson.allowances.details.termsOfService,
} as SamUserAllowancesDetails,
} as SamUserAllowances;

const terraUserAttributes = { marketingConsent: responseJson.attributes.marketingConsent } as SamUserAttributes;

const termsOfService = {
latestAcceptedVersion: responseJson.termsOfServiceDetails.latestAcceptedVersion,
acceptedOn: responseJson.termsOfServiceDetails.acceptedOn
? new Date(responseJson.termsOfServiceDetails.acceptedOn)
: undefined,
permitsSystemUsage: responseJson.termsOfServiceDetails.permitsSystemUsage,
isCurrentVersion: responseJson.termsOfServiceDetails.isCurrentVersion,
} as SamUserTermsOfServiceDetails;

const enterpriseFeatures = responseJson.additionalDetails.enterpriseFeatures
? responseJson.additionalDetails.enterpriseFeatures.resources.map((resource) => resource.resourceId)
: [];

return {
samUser,
terraUserAllowances,
terraUserAttributes,
termsOfService,
enterpriseFeatures,
} as SamUserCombinedStateResponse;
},

registerWithProfile: async (
Expand Down Expand Up @@ -267,21 +304,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 }));
Expand Down
19 changes: 14 additions & 5 deletions src/registration/terms-of-service/TermsOfServicePage.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ import { act, fireEvent, screen } from '@testing-library/react';
import { h } from 'react-hyperscript-helpers';
import { Ajax } from 'src/libs/ajax';
import { SamUserTermsOfServiceDetails } from 'src/libs/ajax/TermsOfService';
import { SamUserAllowances, SamUserResponse } from 'src/libs/ajax/User';
import {
SamUserAllowances,
SamUserAttributes,
SamUserCombinedStateResponse,
SamUserResponse,
} 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';
Expand Down Expand Up @@ -71,6 +76,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 } as SamUserAttributes,
termsOfService,
enterpriseFeatures: [],
};
const getTermsOfServiceText = jest.fn().mockResolvedValue('some text');
const getUserTermsOfServiceDetails = jest
.fn()
Expand All @@ -89,10 +101,7 @@ const setupMockAjax = async (
captureEvent: jest.fn(),
},
User: {
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: [] }),
Expand Down
Loading