yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-09-21 14:31:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17669 from strapi/chore/application-infos

Browse Source 
Chore: Refactor data-fetching and simplify ApplicationInfosPage
This commit is contained in:
Gustav Hansen 2023-08-15 16:03:49 +02:00 committed by GitHub
commit 0b2975dbed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 91 additions and 216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/core/admin/admin/src/pages/Admin/index.js
View File

@ -42,7 +42,9 @@ const ProfilePage = lazy(() =>
import(/* webpackChunkName: "Admin_profilePage" */ '../ProfilePage')
);
const SettingsPage = lazy(() =>
import(/* webpackChunkName: "Admin_settingsPage" */ '../SettingsPage')
import(/* webpackChunkName: "Admin_settingsPage" */ '../SettingsPage').then((module) => ({
default: module.SettingsPage,
}))
);
// Simple hook easier for testing

6
packages/core/admin/admin/src/pages/SettingsPage/components/SettingsNav/index.js
View File

@ -12,14 +12,14 @@ import PropTypes from 'prop-types';
import { useIntl } from 'react-intl';
import { NavLink, useLocation } from 'react-router-dom';
import { getSectionsToDisplay } from '../../utils';
const SettingsNav = ({ menu }) => {
const { formatMessage } = useIntl();
const { trackUsage } = useTracking();
const { pathname } = useLocation();
const filteredMenu = getSectionsToDisplay(menu);
const filteredMenu = menu.filter(
(section) => !section.links.every((link) => link.isDisplayed === false)
);
const sections = filteredMenu.map((section) => {
return {

42
packages/core/admin/admin/src/pages/SettingsPage/index.js
View File

@ -1,15 +1,4 @@
/**
*
* SettingsPage
*
*/
// NOTE TO PLUGINS DEVELOPERS:
// If you modify this file you also need to update the documentation accordingly
// Here's the file: strapi/docs/3.0.0-beta.x/plugin-development/frontend-settings-api.md
// IF THE DOC IS NOT UPDATED THE PULL REQUEST WILL NOT BE MERGED
import React, { memo, useMemo } from 'react';
import * as React from 'react';
import { Layout } from '@strapi/design-system';
import { LoadingIndicatorPage, useStrapiApp } from '@strapi/helper-plugin';
@ -19,14 +8,14 @@ import { Redirect, Route, Switch, useParams } from 'react-router-dom';
import { useSettingsMenu } from '../../hooks';
import { useEnterprise } from '../../hooks/useEnterprise';
import { createRoute, makeUniqueRoutes } from '../../utils';
import createRoute from '../../utils/createRoute';
import makeUniqueRoutes from '../../utils/makeUniqueRoutes';
import SettingsNav from './components/SettingsNav';
import { ROUTES_CE } from './constants';
import ApplicationInfosPage from './pages/ApplicationInfosPage';
import { createSectionsRoutes } from './utils';
function SettingsPage() {
export function SettingsPage() {
const { settingId } = useParams();
const { settings } = useStrapiApp();
const { formatMessage } = useIntl();
@ -43,13 +32,17 @@ function SettingsPage() {
);
// Creates the admin routes
const adminRoutes = useMemo(() => {
const adminRoutes = React.useMemo(() => {
return makeUniqueRoutes(
routes.map(({ to, Component, exact }) => createRoute(Component, to, exact))
);
}, [routes]);
const pluginsRoutes = createSectionsRoutes(settings);
const pluginsRoutes = Object.values(settings).flatMap((section) => {
const { links } = section;
return links.map((link) => createRoute(link.Component, link.to, link.exact || false));
});
// Since the useSettingsMenu hook can make API calls in order to check the links permissions
// We need to add a loading state to prevent redirecting the user while permissions are being checked
@ -61,14 +54,14 @@ function SettingsPage() {
return <Redirect to="/settings/application-infos" />;
}
const settingTitle = formatMessage({
id: 'global.settings',
defaultMessage: 'Settings',
});
return (
<Layout sideNav={<SettingsNav menu={menu} />}>
<Helmet title={settingTitle} />
<Helmet
title={formatMessage({
id: 'global.settings',
defaultMessage: 'Settings',
})}
/>
<Switch>
<Route path="/settings/application-infos" component={ApplicationInfosPage} exact />
@ -78,6 +71,3 @@ function SettingsPage() {
</Layout>
);
}
export default memo(SettingsPage);
export { SettingsPage };

106
packages/core/admin/admin/src/pages/SettingsPage/pages/ApplicationInfosPage/index.js
View File

@ -1,4 +1,4 @@
import React, { useRef } from 'react';
import * as React from 'react';
import {
Button,
@ -14,8 +14,11 @@ import {
Typography,
} from '@strapi/design-system';
import {
prefixFileUrlWithBackendUrl,
SettingsPageTitle,
useAPIErrorHandler,
useAppInfo,
useFetchClient,
useFocusWhenNavigate,
useNotification,
useRBAC,
@ -23,7 +26,7 @@ import {
} from '@strapi/helper-plugin';
import { Check, ExternalLink } from '@strapi/icons';
import { useIntl } from 'react-intl';
import { useMutation, useQuery, useQueryClient } from 'react-query';
import { useMutation, useQuery } from 'react-query';
import { useSelector } from 'react-redux';
import { useConfigurations } from '../../../../hooks';
@ -31,18 +34,20 @@ import { useEnterprise } from '../../../../hooks/useEnterprise';
import { selectAdminPermissions } from '../../../App/selectors';
import CustomizationInfos from './components/CustomizationInfos';
import { fetchProjectSettings, postProjectSettings } from './utils/api';
import getFormData from './utils/getFormData';
const AdminSeatInfoCE = () => null;
const ApplicationInfosPage = () => {
const inputsRef = useRef();
const inputsRef = React.useRef();
const toggleNotification = useNotification();
const { trackUsage } = useTracking();
const { formatMessage } = useIntl();
const queryClient = useQueryClient();
useFocusWhenNavigate();
const { get, post } = useFetchClient();
const { updateProjectSettings } = useConfigurations();
const permissions = useSelector(selectAdminPermissions);
const { formatAPIError } = useAPIErrorHandler();
const {
communityEdition,
latestStrapiReleaseTag,
@ -50,8 +55,7 @@ const ApplicationInfosPage = () => {
shouldUpdateStrapi,
strapiVersion,
} = useAppInfo();
const { updateProjectSettings } = useConfigurations();
const permissions = useSelector(selectAdminPermissions);
const AdminSeatInfo = useEnterprise(
AdminSeatInfoCE,
async () =>
@ -65,38 +69,68 @@ const ApplicationInfosPage = () => {
const {
allowedActions: { canRead, canUpdate },
} = useRBAC(permissions.settings['project-settings']);
const canSubmit = canRead && canUpdate;
const { data, isLoading } = useQuery('project-settings', fetchProjectSettings, {
enabled: canRead,
});
useFocusWhenNavigate();
const submitMutation = useMutation((body) => postProjectSettings(body), {
async onSuccess({ menuLogo, authLogo }) {
await queryClient.invalidateQueries('project-settings', { refetchActive: true });
updateProjectSettings({ menuLogo: menuLogo?.url, authLogo: authLogo?.url });
const { data, isLoading } = useQuery(
['project-settings'],
async () => {
const { data } = await get('/admin/project-settings');
return data;
},
{
cacheTime: 0,
enabled: canRead,
select(data) {
return {
...data,
authLogo: data.authLogo
? {
...data.authLogo,
url: prefixFileUrlWithBackendUrl(data.authLogo.url),
}
: data.authLogo,
menuLogo: data.menuLogo
? {
...data.menuLogo,
url: prefixFileUrlWithBackendUrl(data.menuLogo.url),
}
: data.menuLogo,
};
},
}
);
const submitMutation = useMutation(
(body) =>
post('/admin/project-settings', body, {
headers: {
'Content-Type': 'multipart/form-data',
},
}),
{
onError(error) {
toggleNotification({
type: 'warning',
message: formatAPIError(error),
});
},
const handleSubmit = (e) => {
e.preventDefault();
async onSuccess(data) {
const { menuLogo, authLogo } = data;
if (!canUpdate) return;
updateProjectSettings({ menuLogo: menuLogo?.url, authLogo: authLogo?.url });
const inputValues = inputsRef.current.getValues();
const formData = getFormData(inputValues);
submitMutation.mutate(formData, {
onSuccess() {
const { menuLogo, authLogo } = inputValues;
if (menuLogo.rawFile) {
if (menuLogo?.rawFile) {
trackUsage('didChangeLogo', {
logo: 'menu',
});
}
if (authLogo.rawFile) {
if (authLogo?.rawFile) {
trackUsage('didChangeLogo', {
logo: 'auth',
});
@ -107,13 +141,13 @@ const ApplicationInfosPage = () => {
message: formatMessage({ id: 'app', defaultMessage: 'Saved' }),
});
},
onError() {
toggleNotification({
type: 'warning',
message: { id: 'notification.error', defaultMessage: 'An error occurred' },
});
},
});
}
);
const handleSubmit = (e) => {
e.preventDefault();
submitMutation.mutate(getFormData(inputsRef.current.getValues()));
};
// block rendering until the EE component is fully loaded
@ -145,7 +179,7 @@ const ApplicationInfosPage = () => {
defaultMessage: 'Administration panel’s global information',
})}
primaryAction={
canSubmit && (
canUpdate && (
<Button type="submit" startIcon={<Check />}>
{formatMessage({ id: 'global.save', defaultMessage: 'Save' })}
</Button>

14
packages/core/admin/admin/src/pages/SettingsPage/pages/ApplicationInfosPage/tests/index.test.js
View File

@ -56,20 +56,6 @@ jest.mock('@strapi/helper-plugin', () => ({
useAppInfo: jest.fn(() => ({ shouldUpdateStrapi: false, latestStrapiReleaseTag: 'v3.6.8' })),
useNotification: jest.fn(() => jest.fn()),
useRBAC: jest.fn(() => ({ allowedActions: { canRead: true, canUpdate: true } })),
useFetchClient: jest.fn().mockReturnValue({
get: jest.fn().mockResolvedValue({
data: {
menuLogo: {
ext: 'png',
height: 256,
name: 'image.png',
size: 27.4,
url: 'uploads/image_fe95c5abb9.png',
width: 246,
},
},
}),
}),
}));
jest.mock('../../../../../hooks', () => ({

23
packages/core/admin/admin/src/pages/SettingsPage/pages/ApplicationInfosPage/utils/api.js
View File

@ -1,23 +0,0 @@
import { getFetchClient } from '@strapi/helper-plugin';
import prefixAllUrls from './prefixAllUrls';
const fetchProjectSettings = async () => {
const { get } = getFetchClient();
const { data } = await get('/admin/project-settings');
return prefixAllUrls(data);
};
const postProjectSettings = async (body) => {
const { post } = getFetchClient();
const { data } = await post('/admin/project-settings', body, {
headers: {
'Content-Type': 'multipart/form-data',
},
});
return prefixAllUrls(data);
};
export { fetchProjectSettings, postProjectSettings };

17
packages/core/admin/admin/src/pages/SettingsPage/pages/ApplicationInfosPage/utils/prefixAllUrls.js
View File

@ -1,17 +0,0 @@
import { prefixFileUrlWithBackendUrl } from '@strapi/helper-plugin';
import transform from 'lodash/transform';
const prefixAllUrls = (data) =>
transform(
data,
(result, value, key) => {
if (value && value.url) {
result[key] = { ...value, url: prefixFileUrlWithBackendUrl(value.url) };
} else {
result[key] = value;
}
},
{}
);
export default prefixAllUrls;

11
packages/core/admin/admin/src/pages/SettingsPage/utils/createSectionsRoutes.js
View File

@ -1,11 +0,0 @@
import flatMap from 'lodash/flatMap';
import { createRoute } from '../../../utils';
const createSectionsRoutes = (settings) => {
const allLinks = flatMap(settings, (section) => section.links);
return allLinks.map((link) => createRoute(link.Component, link.to, link.exact || false));
};
export default createSectionsRoutes;

5
packages/core/admin/admin/src/pages/SettingsPage/utils/getSectionsToDisplay.js
View File

@ -1,5 +0,0 @@
const getSectionsToDisplay = (menu) => {
return menu.filter((section) => !section.links.every((link) => link.isDisplayed === false));
};
export default getSectionsToDisplay;

2
packages/core/admin/admin/src/pages/SettingsPage/utils/index.js
View File

@ -1,2 +0,0 @@
export { default as createSectionsRoutes } from './createSectionsRoutes';
export { default as getSectionsToDisplay } from './getSectionsToDisplay';

40
packages/core/admin/admin/src/pages/SettingsPage/utils/tests/createSectionsRoutes.js
View File

@ -1,40 +0,0 @@
import createSectionsRoutes from '../createSectionsRoutes';
describe('ADMIN | CONTAINERS | SettingsPage | utils', () => {
describe('createSectionsRoutes', () => {
it('should return an empty array', () => {
expect(createSectionsRoutes([])).toEqual([]);
});
it('should return the correct data', () => {
const data = [
{
id: 'global',
links: [],
},
{
id: 'permissions',
links: [
{
Component: () => 'test',
to: '/test',
exact: true,
},
{
Component: null,
to: '/test1',
exact: true,
},
],
},
];
const results = createSectionsRoutes(data);
expect(results).toHaveLength(1);
expect(results[0].key).toEqual('/test');
expect(results[0].props.path).toEqual('/test');
expect(results[0].props.component()).toEqual('test');
});
});
});

39
packages/core/admin/admin/src/pages/SettingsPage/utils/tests/getSectionsToDisplay.test.js
View File

@ -1,39 +0,0 @@
import getSectionsToDisplay from '../getSectionsToDisplay';
describe('ADMIN | Container | SettingsPage | utils | getSectionToDisplay', () => {
it('should filter the sections that have all links with the isDisplayed property to false', () => {
const data = [
{
id: 'global',
links: [
{
isDisplayed: false,
},
{
isDisplayed: false,
},
],
},
{
id: 'permissions',
links: [
{
isDisplayed: true,
},
{
isDisplayed: false,
},
],
},
{
id: 'test',
links: [],
},
];
const results = getSectionsToDisplay(data);
expect(results).toHaveLength(1);
expect(results[0].id).toEqual('permissions');
});
});