Skip to content

feat(settings): add new strapi customization for user expectation on the final authentication screens #19959

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.

Sign up for GitHub

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
MagentaManifold merged 1 commit into from
Jan 29, 2026
+151 −159
Merged

feat(settings): add new strapi customization for user expectation on the final authentication screens #19959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions libs/shared/cms/src/__generated__/gql.ts
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions libs/shared/cms/src/__generated__/graphql.ts
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions libs/shared/cms/src/lib/queries/relying-party/factories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ export const RelyingPartyResultFactory = (
Enum_Componentaccountsshared_Headlinefontsize.Large,
]),
headlineTextColor: faker.color.rgb(),
additionalAccessibilityInfo: faker.string.sample(),
},
NewDeviceLoginEmail: {
logoUrl: faker.internet.url(),
Expand Down
1 change: 1 addition & 0 deletions libs/shared/cms/src/lib/queries/relying-party/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export const relyingPartyQuery = graphql(`
favicon
headlineFontSize
headlineTextColor
additionalAccessibilityInfo
}
EmailFirstPage {
logoUrl
Expand Down
1 change: 1 addition & 0 deletions libs/shared/cms/src/lib/queries/relying-party/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export interface Shared {
favicon: string | null;
headlineFontSize: Enum_Componentaccountsshared_Headlinefontsize | null;
headlineTextColor: string | null;
additionalAccessibilityInfo: string | null;
}

export interface FeatureFlags {
Expand Down
1 change: 1 addition & 0 deletions packages/fxa-settings/src/models/integrations/relier-interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export interface SharedRelierCmsInfo {
favicon?: string | undefined;
headlineFontSize?: HeadlineFontSize | null;
headlineTextColor?: string | null;
additionalAccessibilityInfo?: string | undefined;
}

export interface FeatureFlagsRelierCmsInfo {
Expand Down
3 changes: 1 addition & 2 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,8 +371,7 @@ const CompleteResetPasswordContainer = ({
recoveryKeyExists,
estimatedSyncDeviceCount,
}}
isFirefoxClientServiceRelay={integration.isFirefoxClientServiceRelay()}
integrationIsSync={integration.isSync()}
integration={integration}
locationState={location.state as CompleteResetPasswordLocationState}
/>
);
Expand Down
7 changes: 4 additions & 3 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
import React from 'react';
import { Meta } from '@storybook/react';
import { withLocalization } from 'fxa-react/lib/storybooks';
import { Subject } from './mocks';
import { createMockWebIntegration, Subject } from './mocks';
import CompleteResetPassword from '.';
import { MOCK_CMS_INFO } from '../../mocks';

export default {
title: 'Pages/ResetPassword/CompleteResetPassword',
Expand All @@ -18,11 +19,11 @@ export const NoSync = () => (
<Subject recoveryKeyExists={true} estimatedSyncDeviceCount={0} />
);

export const OAuthDesktopServiceRelay = () => (
export const WithCmsAdditionalAccessibilityInfo = () => (
<Subject
isFirefoxClientServiceRelay={true}
estimatedSyncDeviceCount={0}
recoveryKeyExists={false}
integration={createMockWebIntegration({ cmsInfo: MOCK_CMS_INFO })}
/>
);

Expand Down
16 changes: 7 additions & 9 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import { renderWithLocalizationProvider } from 'fxa-react/lib/test-utils/localizationProvider';
import { Subject } from './mocks';
import { createMockWebIntegration, Subject } from './mocks';
import { screen, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { MOCK_PASSWORD } from '../../mocks';
import { MOCK_CMS_INFO, MOCK_PASSWORD } from '../../mocks';
import GleanMetrics from '../../../lib/glean';

const mockSubmitNewPassword = jest.fn((newPassword: string) =>
Expand All @@ -23,9 +23,6 @@ jest.mock('../../../lib/glean', () => ({
},
}));

const serviceRelayText =
'Firefox will try sending you back to use an email mask after you sign in.';

describe('CompleteResetPassword page', () => {
beforeEach(() => {
(GleanMetrics.passwordReset.createNewView as jest.Mock).mockClear();
Expand Down Expand Up @@ -75,19 +72,20 @@ describe('CompleteResetPassword page', () => {
expect(
screen.queryByRole('link', { name: 'Use account recovery key' })
).not.toBeInTheDocument();
expect(screen.queryByText(serviceRelayText)).not.toBeInTheDocument();
});

it('renders expected text when service=relay', async () => {
it('renders additional accessibility info from CMS', async () => {
renderWithLocalizationProvider(
<Subject
isFirefoxClientServiceRelay={true}
estimatedSyncDeviceCount={0}
recoveryKeyExists={false}
integration={createMockWebIntegration({ cmsInfo: MOCK_CMS_INFO })}
/>
);
await waitFor(() =>
expect(screen.getByText(serviceRelayText)).toBeVisible()
expect(
screen.getByText(MOCK_CMS_INFO.shared.additionalAccessibilityInfo)
).toBeVisible()
);
});

Expand Down
19 changes: 6 additions & 13 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import ResetPasswordWarning from '../../../components/ResetPasswordWarning';
import { Link, useLocation } from '@reach/router';
import Banner from '../../../components/Banner';
import { HeadingPrimary } from '../../../components/HeadingPrimary';
import { useFtlMsgResolver } from '../../../models';

const CompleteResetPassword = ({
email,
Expand All @@ -29,11 +28,12 @@ const CompleteResetPassword = ({
submitNewPassword,
estimatedSyncDeviceCount,
recoveryKeyExists,
integrationIsSync,
isFirefoxClientServiceRelay,
integration,
}: CompleteResetPasswordProps) => {
const location = useLocation();
const searchParams = location.search;
const additionalAccessibilityInfo =
integration.getCmsInfo()?.shared.additionalAccessibilityInfo;
useEffect(() => {
if (hasConfirmedRecoveryKey) {
GleanMetrics.passwordReset.recoveryKeyCreatePasswordView();
Expand All @@ -43,11 +43,9 @@ const CompleteResetPassword = ({
}
}, [hasConfirmedRecoveryKey, recoveryKeyExists]);

const ftlMsgResolver = useFtlMsgResolver();

const [isSubmitting, setIsSubmitting] = useState(false);
const isActiveSyncUser = !!(
integrationIsSync ||
integration.isSync() ||
(estimatedSyncDeviceCount !== undefined && estimatedSyncDeviceCount > 0)
);
const defaultClosed = !isActiveSyncUser;
Expand Down Expand Up @@ -98,15 +96,10 @@ const CompleteResetPassword = ({
*/}
<input type="email" value={email} className="hidden" readOnly />

{isFirefoxClientServiceRelay && (
{additionalAccessibilityInfo && (
<Banner
type="info"
content={{
localizedHeading: ftlMsgResolver.getMsg(
'complete-reset-password-desktop-relay',
'Firefox will try sending you back to use an email mask after you sign in.'
),
}}
content={{ localizedHeading: additionalAccessibilityInfo }}
/>
)}

Expand Down
5 changes: 2 additions & 3 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export type CompleteResetPasswordOAuthIntegration = Pick<
>;

type CompleteResetPasswordIntegration =
| Pick<Integration, 'type' | 'getServiceName'>
| Pick<Integration, 'type' | 'getServiceName' | 'getCmsInfo'>
| CompleteResetPasswordOAuthIntegration;

export type CompleteResetPasswordContainerProps = {
Expand All @@ -43,8 +43,7 @@ export interface CompleteResetPasswordProps {
hasConfirmedRecoveryKey?: boolean;
estimatedSyncDeviceCount?: number;
recoveryKeyExists?: boolean;
integrationIsSync: boolean;
isFirefoxClientServiceRelay: boolean;
integration: Integration;
}

export type AccountResetData = {
Expand Down
22 changes: 18 additions & 4 deletions packages/fxa-settings/src/pages/ResetPassword/CompleteResetPassword/mocks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,32 @@ import {
CompleteResetPasswordLocationState,
CompleteResetPasswordProps,
} from './interfaces';
import { RelierCmsInfo, WebIntegration } from '../../../models';
import { GenericData } from '../../../lib/model-data';

const mockSubmitNewPassword = (newPassword: string) => Promise.resolve();

export function createMockWebIntegration({
cmsInfo,
}: {
cmsInfo?: RelierCmsInfo;
}) {
const integration = new WebIntegration(
new GenericData({
uid: MOCK_UID,
})
);
integration.cmsInfo = cmsInfo;
return integration;
}

export const Subject = ({
submitNewPassword = mockSubmitNewPassword,
hasConfirmedRecoveryKey = false,
recoveryKeyExists,
testErrorMessage = '',
estimatedSyncDeviceCount,
integrationIsSync = false,
isFirefoxClientServiceRelay: isDesktopServiceRelay = false,
integration = createMockWebIntegration({}),
}: Partial<CompleteResetPasswordProps> & {
testErrorMessage?: string;
}) => {
Expand All @@ -46,8 +61,7 @@ export const Subject = ({
hasConfirmedRecoveryKey,
recoveryKeyExists,
estimatedSyncDeviceCount,
integrationIsSync,
isFirefoxClientServiceRelay: isDesktopServiceRelay,
integration,
}}
/>
</LocationProvider>
Expand Down
13 changes: 0 additions & 13 deletions packages/fxa-settings/src/pages/Signin/SigninRecoveryCode/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,6 @@ export const DefaultWithCms = () => (
/>
);

export const WithOAuthDesktopServiceRelay = () => (
<SigninRecoveryCode
finishOAuthFlowHandler={mockFinishOAuthFlowHandler}
integration={createMockOAuthNativeIntegration(false)}
navigateToRecoveryPhone={() => {
action('handleNavigation')();
return Promise.resolve();
}}
signinState={mockSigninLocationState}
submitRecoveryCode={mockSubmitSuccess}
/>
);

export const WithCodeErrorOnSubmit = () => (
<SigninRecoveryCode
finishOAuthFlowHandler={mockFinishOAuthFlowHandler}
Expand Down
25 changes: 13 additions & 12 deletions packages/fxa-settings/src/pages/Signin/SigninRecoveryCode/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ import {
import { LocationProvider } from '@reach/router';
import {
MOCK_BACKUP_CODE,
MOCK_CMS_INFO,
MOCK_OAUTH_FLOW_HANDLER_RESPONSE,
} from '../../mocks';
import * as SigninUtils from '../utils';
import { AuthUiErrors } from '../../../lib/auth-errors/auth-errors';
import { OAUTH_ERRORS } from '../../../lib/oauth';
import { tryAgainError } from '../../../lib/oauth/hooks';
import { mockOAuthNativeSigninIntegration } from '../SigninTotpCode/mocks';

const mockNavigateWithQuery = jest.fn();
jest.mock('../../../lib/hooks/useNavigateWithQuery', () => ({
Expand All @@ -42,13 +42,7 @@ jest.mock('../../../lib/glean', () => ({
}));

const mockFinishOAuthFlowHandler = jest.fn();
const mockIntegration = {
...createMockSigninWebIntegration(),
getCmsInfo: () => undefined,
};

const serviceRelayText =
'Firefox will try sending you back to use an email mask after you sign in.';
const mockIntegration = createMockSigninWebIntegration({ cmsInfo: undefined });

describe('PageSigninRecoveryCode', () => {
beforeEach(() => {
Expand Down Expand Up @@ -93,7 +87,6 @@ describe('PageSigninRecoveryCode', () => {
screen.getByRole('link', {
name: /Are you locked out/i,
});
expect(screen.queryByText(serviceRelayText)).not.toBeInTheDocument();
});

it('has expected glean click events', async () => {
Expand Down Expand Up @@ -138,19 +131,27 @@ describe('PageSigninRecoveryCode', () => {
);
});

it('renders expected text when service=relay', () => {
it('renders additional accessibility info from CMS', () => {
const mockIntegrationWithCms = createMockSigninWebIntegration({
cmsInfo: MOCK_CMS_INFO,
});
renderWithLocalizationProvider(
<LocationProvider>
<SigninRecoveryCode
finishOAuthFlowHandler={mockFinishOAuthFlowHandler}
integration={mockOAuthNativeSigninIntegration(false)}
integration={mockIntegrationWithCms}
navigateToRecoveryPhone={jest.fn()}
signinState={mockSigninLocationState}
submitRecoveryCode={jest.fn()}
/>
</LocationProvider>
);
screen.getByText(serviceRelayText);

const additionalInfo = screen.getByText(
MOCK_CMS_INFO.shared.additionalAccessibilityInfo
);

expect(additionalInfo).toBeInTheDocument();
});

describe('metrics', () => {
Expand Down
11 changes: 4 additions & 7 deletions packages/fxa-settings/src/pages/Signin/SigninRecoveryCode/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ const SigninRecoveryCode = ({
};

const cmsInfo = integration.getCmsInfo();
const additionalAccessibilityInfo =
cmsInfo?.shared.additionalAccessibilityInfo;

return (
<AppLayout cmsInfo={cmsInfo} loading={loading}>
Expand Down Expand Up @@ -260,13 +262,8 @@ const SigninRecoveryCode = ({
</p>
</FtlMsg>

{integration.isFirefoxClientServiceRelay() && (
<FtlMsg id="signin-recovery-code-desktop-relay">
<p className="text-sm mt-2">
Firefox will try sending you back to use an email mask after you
sign in.
</p>
</FtlMsg>
{additionalAccessibilityInfo && (
<p className="text-sm mt-2">{additionalAccessibilityInfo}</p>
)}

<FormVerifyCode
Expand Down
4 changes: 0 additions & 4 deletions packages/fxa-settings/src/pages/Signin/SigninTokenCode/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,3 @@ export const SplitLayoutWithCms = () => (
})}
/>
);

export const OAuthDesktopServiceRelay = () => (
<Subject integration={createOAuthNativeIntegration(false)} />
);
Loading
Loading