Skip to content
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

fix: update app title in all available languages #14546

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+251 −221
Open

fix: update app title in all available languages #14546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f51120a
update app title in appmetadata and text resource only from settings
standeren Jan 21, 2025
d0e11ba
render flag as separat component
standeren Jan 24, 2025
38fc976
fix tests
standeren Jan 24, 2025
fce6790
use getAppTitlesToDisplay from utils
standeren Jan 30, 2025
019bd23
removed flags, and coderabbit comments
nkylstad Jan 31, 2025
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
14 changes: 1 addition & 13 deletions ...ment/layout/PageHeader/SubHeader/SettingsModalButton/SettingsModal/SettingsModal.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,15 @@ import userEvent from '@testing-library/user-event';
import { SettingsModal } from './SettingsModal';
import { textMock } from '@studio/testing/mocks/i18nMock';
import { createQueryClientMock } from 'app-shared/mocks/queryClientMock';
import type { QueryClient, UseMutationResult } from '@tanstack/react-query';
import type { QueryClient } from '@tanstack/react-query';
import type { ServicesContextProps } from 'app-shared/contexts/ServicesContext';
import { ServicesContextProvider } from 'app-shared/contexts/ServicesContext';
import type { AppConfig } from 'app-shared/types/AppConfig';
import { useAppConfigMutation } from 'app-development/hooks/mutations';
import { MemoryRouter } from 'react-router-dom';
import { SettingsModalContextProvider } from 'app-development/contexts/SettingsModalContext';
import { PreviewContextProvider } from 'app-development/contexts/PreviewContext';
import type { SettingsModalHandle } from 'app-development/types/SettingsModalHandle';
import { typedLocalStorage } from '@studio/pure-functions';

jest.mock('app-development/hooks/mutations/useAppConfigMutation');

const updateAppConfigMutation = jest.fn();
const mockUpdateAppConfigMutation = useAppConfigMutation as jest.MockedFunction<
typeof useAppConfigMutation
>;
mockUpdateAppConfigMutation.mockReturnValue({
mutate: updateAppConfigMutation,
} as unknown as UseMutationResult<void, Error, AppConfig, unknown>);

describe('SettingsModal', () => {
const user = userEvent.setup();
afterEach(jest.clearAllMocks);
Expand Down
202 changes: 95 additions & 107 deletions ...er/SubHeader/SettingsModalButton/SettingsModal/components/Tabs/AboutTab/AboutTab.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,32 @@
import React from 'react';
import { render, screen, waitForElementToBeRemoved } from '@testing-library/react';
import { screen, waitForElementToBeRemoved } from '@testing-library/react';
import { AboutTab } from './AboutTab';
import { textMock } from '@studio/testing/mocks/i18nMock';
import type { AppConfig } from 'app-shared/types/AppConfig';
import userEvent from '@testing-library/user-event';
import { useAppConfigMutation } from 'app-development/hooks/mutations';
import type { UseMutationResult } from '@tanstack/react-query';
import type { ServicesContextProps } from 'app-shared/contexts/ServicesContext';
import { ServicesContextProvider } from 'app-shared/contexts/ServicesContext';
import { createQueryClientMock } from 'app-shared/mocks/queryClientMock';
import { queriesMock } from 'app-shared/mocks/queriesMock';
import { mockRepository1, mockRepository2 } from '../../../mocks/repositoryMock';
import { mockAppConfig } from '../../../mocks/appConfigMock';
import { formatDateToDateAndTimeString } from 'app-development/utils/dateUtils';
import { MemoryRouter } from 'react-router-dom';
import type { ApplicationMetadata } from 'app-shared/types/ApplicationMetadata';
import { app, org } from '@studio/testing/testids';
import { SettingsModalContextProvider } from 'app-development/contexts/SettingsModalContext';
import { PreviewContext, type PreviewContextProps } from 'app-development/contexts/PreviewContext';
import { renderWithProviders } from 'app-development/test/mocks';
import { APP_NAME, DEFAULT_LANGUAGE } from 'app-shared/constants';
import { createQueryClientMock } from 'app-shared/mocks/queryClientMock';
import type { PreviewContextProps } from '../../../../../../../../contexts/PreviewContext';
import { queriesMock } from 'app-shared/mocks/queriesMock';

const nb: string = 'nb';
const nn: string = 'nn';
const en: string = 'en';
const da: string = 'da';
const mockNewText: string = 'test';

const mockAppTitle = 'mockAppTitle';
const mockAppMetadata: ApplicationMetadata = {
id: `${org}/${app}`,
org,
title: { [DEFAULT_LANGUAGE]: mockAppTitle },
createdBy: 'Test Testesen',
};

const defaultPreviewContextProps: PreviewContextProps = {
shouldReloadPreview: false,
doReloadPreview: jest.fn(),
previewHasLoaded: jest.fn(),
};

jest.mock('app-development/hooks/mutations/useAppConfigMutation');
const updateAppConfigMutation = jest.fn();
const mockUpdateAppConfigMutation = useAppConfigMutation as jest.MockedFunction<
typeof useAppConfigMutation
>;
mockUpdateAppConfigMutation.mockReturnValue({
mutate: updateAppConfigMutation,
} as unknown as UseMutationResult<void, Error, AppConfig, unknown>);

const getAppConfig = jest.fn().mockImplementation(() => Promise.resolve({}));
const getRepoMetadata = jest.fn().mockImplementation(() => Promise.resolve({}));
const getAppMetadata = jest.fn().mockImplementation(() => Promise.resolve({}));

jest.mock('react-router-dom', () => ({
...jest.requireActual('react-router-dom'),
useParams: () => {
return { org, app };
},
}));

describe('AboutTab', () => {
afterEach(jest.clearAllMocks);

Expand All @@ -62,29 +36,27 @@ describe('AboutTab', () => {
expect(screen.getByTitle(textMock('settings_modal.loading_content'))).toBeInTheDocument();
});

it('fetches appConfig on mount', () => {
it('fetches languages on mount', () => {
renderAboutTab();
expect(getAppConfig).toHaveBeenCalledTimes(1);
expect(queriesMock.getTextLanguages).toHaveBeenCalledTimes(1);
});

it('fetches repoMetadata on mount', () => {
renderAboutTab();
expect(getRepoMetadata).toHaveBeenCalledTimes(1);
expect(queriesMock.getRepoMetadata).toHaveBeenCalledTimes(1);
});

it('fetches applicationMetadata on mount', () => {
renderAboutTab();
expect(getAppMetadata).toHaveBeenCalledTimes(1);
expect(queriesMock.getAppMetadata).toHaveBeenCalledTimes(1);
});

it.each(['getAppConfig', 'getRepoMetadata', 'getAppMetadata'])(
it.each(['getTextLanguages', 'getRepoMetadata', 'getAppMetadata'])(
'shows an error message if an error occured on the %s query',
async (queryName) => {
async (queryName: string) => {
const errorMessage = 'error-message-test';
renderAboutTab({
queries: {
[queryName]: () => Promise.reject({ message: errorMessage }),
},
[queryName]: jest.fn().mockImplementation(() => Promise.reject({ message: errorMessage })),
});

await waitForElementToBeRemoved(() =>
Expand All @@ -101,43 +73,79 @@ describe('AboutTab', () => {
await resolveAndWaitForSpinnerToDisappear();

const repoNameInput = screen.getByLabelText(textMock('settings_modal.about_tab_repo_label'));
expect(repoNameInput).toHaveValue(mockAppConfig.repositoryName);
expect(repoNameInput).toHaveValue(mockRepository1.name);
expect(repoNameInput).toHaveAttribute('readonly');
});

it('displays correct value in "name" input field, and updates the value on change', async () => {
const user = userEvent.setup();
await resolveAndWaitForSpinnerToDisappear();

const appName = screen.getByLabelText(textMock('settings_modal.about_tab_name_label'));
expect(appName).toHaveValue(mockAppConfig.serviceName);

const appName = screen.getByLabelText(textMock('language.nb'));
expect(appName).toHaveValue(mockAppMetadata.title.nb);
await user.clear(appName);
await user.type(appName, mockNewText);

expect(appName).toHaveValue(`${mockAppConfig.serviceName}${mockNewText}`);
expect(appName).toHaveValue(mockNewText);
});

it('displays correct value in "alternative id" input field, and updates the value on change', async () => {
const user = userEvent.setup();
await resolveAndWaitForSpinnerToDisappear();
it('displays empty input fields for recommended app title languages even though titles are not set in appMetadata', async () => {
const getAppMetadata = jest
.fn()
.mockImplementation(() => Promise.resolve({ ...mockAppMetadata, title: {} }));
await resolveAndWaitForSpinnerToDisappear({ getAppMetadata });

[nb, nn, en].forEach((lang) => {
const appName = screen.getByRole('textbox', { name: textMock(`language.${lang}`) });
expect(appName).toBeInTheDocument();
expect(appName).not.toHaveValue();
});
});

const altId = screen.getByLabelText(textMock('settings_modal.about_tab_alt_id_label'));
expect(altId).toHaveValue(mockAppConfig.serviceId);
it('displays input fields for recommended app title languages as readOnly if app does not have translation for them', async () => {
const getTextLanguages = jest.fn().mockImplementation(() => Promise.resolve([]));
const getAppMetadata = jest
.fn()
.mockImplementation(() => Promise.resolve({ ...mockAppMetadata, title: {} }));
await resolveAndWaitForSpinnerToDisappear({ getTextLanguages, getAppMetadata });

[nb, nn, en].forEach((lang) => {
const appName = screen.getByRole('textbox', { name: textMock(`language.${lang}`) });
expect(appName).toBeDisabled();
});
});

await user.type(altId, mockNewText);
it('displays input fields for remaining app titles for languages available in app in addition to the recommended', async () => {
const getTextLanguages = jest
.fn()
.mockImplementation(() => Promise.resolve([DEFAULT_LANGUAGE, da]));
await resolveAndWaitForSpinnerToDisappear({ getTextLanguages });

expect(altId).toHaveValue(`${mockAppConfig.serviceId}${mockNewText}`);
[nb, nb, en, da].forEach((lang) => {
const appName = screen.getByRole('textbox', { name: textMock(`language.${lang}`) });
expect(appName).toBeInTheDocument();
});
});

it('should update app config when saving', async () => {
it('should update appMetadata and text resource for given language when saving', async () => {
const user = userEvent.setup();
await resolveAndWaitForSpinnerToDisappear();

const altId = screen.getByLabelText(textMock('settings_modal.about_tab_alt_id_label'));
await user.type(altId, mockNewText);
const serviceNameNb = screen.getByLabelText(textMock('language.nb'));
await user.clear(serviceNameNb);
await user.type(serviceNameNb, mockNewText);
await user.tab();

expect(updateAppConfigMutation).toHaveBeenCalledTimes(1);
expect(queriesMock.updateAppMetadata).toHaveBeenCalledTimes(1);
expect(queriesMock.updateAppMetadata).toHaveBeenCalledWith(
org,
app,
expect.objectContaining({ title: { nb: mockNewText } }),
);
expect(queriesMock.upsertTextResources).toHaveBeenCalledTimes(1);
expect(queriesMock.upsertTextResources).toHaveBeenCalledWith(org, app, DEFAULT_LANGUAGE, {
[APP_NAME]: mockNewText,
});
});

it('displays owners full name when it is set', async () => {
Expand All @@ -148,11 +156,8 @@ describe('AboutTab', () => {
});

it('displays owners login name when full name is not set', async () => {
getRepoMetadata.mockImplementation(() => Promise.resolve(mockRepository2));
renderAboutTab();
await waitForElementToBeRemoved(() =>
screen.queryByTitle(textMock('settings_modal.loading_content')),
);
const getRepoMetadata = jest.fn().mockImplementation(() => Promise.resolve(mockRepository2));
await resolveAndWaitForSpinnerToDisappear({ getRepoMetadata });

expect(screen.queryByText(mockRepository1.owner.full_name)).not.toBeInTheDocument();
expect(screen.getByText(mockRepository1.owner.login)).toBeInTheDocument();
Expand All @@ -176,58 +181,41 @@ describe('AboutTab', () => {
expect(screen.getByText(mockAppMetadata.createdBy)).toBeInTheDocument();
});

it('calls "doReloadPreview" when saving the app config', async () => {
it('calls "doReloadPreview" when changing service name', async () => {
const user = userEvent.setup();

const doReloadPreview = jest.fn();
await resolveAndWaitForSpinnerToDisappear({ previewContextProps: { doReloadPreview } });
await resolveAndWaitForSpinnerToDisappear({}, { doReloadPreview });

const serviceName = screen.getByLabelText(textMock('settings_modal.about_tab_name_label'));
await user.type(serviceName, mockNewText);
const serviceNameNb = screen.getByLabelText(textMock('language.nb'));
await user.type(serviceNameNb, mockNewText);
await user.tab();

expect(doReloadPreview).toHaveBeenCalledTimes(1);
});
});

type Props = {
queries: Partial<ServicesContextProps>;
previewContextProps: Partial<PreviewContextProps>;
};

const resolveAndWaitForSpinnerToDisappear = async (props: Partial<Props> = {}) => {
getAppConfig.mockImplementation(() => Promise.resolve(mockAppConfig));
getRepoMetadata.mockImplementation(() => Promise.resolve(mockRepository1));
getAppMetadata.mockImplementation(() => Promise.resolve(mockAppMetadata));

renderAboutTab(props);
const resolveAndWaitForSpinnerToDisappear = async (
queries: Partial<ServicesContextProps> = {},
previewContextProps: Partial<PreviewContextProps> = {},
) => {
const getTextLanguages = jest.fn().mockImplementation(() => Promise.resolve([DEFAULT_LANGUAGE]));
const getRepoMetadata = jest.fn().mockImplementation(() => Promise.resolve(mockRepository1));
const getAppMetadata = jest.fn().mockImplementation(() => Promise.resolve(mockAppMetadata));

renderAboutTab(
{ getTextLanguages, getRepoMetadata, getAppMetadata, ...queries },
{ ...previewContextProps },
);
await waitForElementToBeRemoved(() =>
screen.queryByTitle(textMock('settings_modal.loading_content')),
);
};

const renderAboutTab = (props: Partial<Props> = {}) => {
const { queries, previewContextProps } = props;

const allQueries: ServicesContextProps = {
...queriesMock,
getAppConfig,
getRepoMetadata,
getAppMetadata,
...queries,
};

return render(
<MemoryRouter>
<ServicesContextProvider {...allQueries} client={createQueryClientMock()}>
<SettingsModalContextProvider>
<PreviewContext.Provider
value={{ ...defaultPreviewContextProps, ...previewContextProps }}
>
<AboutTab />
</PreviewContext.Provider>
</SettingsModalContextProvider>
</ServicesContextProvider>
</MemoryRouter>,
);
const renderAboutTab = (
queries: Partial<ServicesContextProps> = {},
previewContextProps: Partial<PreviewContextProps> = {},
) => {
const queryClient = createQueryClientMock();
return renderWithProviders({ ...queries }, queryClient, { ...previewContextProps })(<AboutTab />);
};
Loading