mattermost-mobile/app/context/theme/index.tsx
Elias Nahum d84a0afd3a
Avoid unnecessary re-renders (#8673)
* Only set the height on the message component if it ends up being greater than the maxHeight to avoid re-renders

* Cache the teams theme to avoid unnecessary computation and re-renders

* useDidUpdate instead of useEffect to avoid setting the theme preference without need

* add comment on clear cache
2025-03-13 21:28:48 +08:00

133 lines
4 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import {withObservables} from '@nozbe/watermelondb/react';
import React, {type ComponentType, createContext, useEffect, useState} from 'react';
import {Appearance} from 'react-native';
import {Preferences} from '@constants';
import useDidUpdate from '@hooks/did_update';
import {queryThemePreferences} from '@queries/servers/preference';
import {observeCurrentTeamId} from '@queries/servers/system';
import {setThemeDefaults, updateThemeIfNeeded} from '@utils/theme';
import type {PreferenceModel} from '@database/models/server';
import type Database from '@nozbe/watermelondb/Database';
type Props = {
currentTeamId?: string;
children: React.ReactNode;
themes: PreferenceModel[];
}
type WithThemeProps = {
theme: Theme;
}
export function getDefaultThemeByAppearance(): Theme {
if (Appearance.getColorScheme() === 'dark') {
return Preferences.THEMES.onyx;
}
return Preferences.THEMES.denim;
}
export const ThemeContext = createContext(getDefaultThemeByAppearance());
const {Consumer, Provider} = ThemeContext;
const themeCache = new Map<string, Theme>();
let clearingThemeCache = false;
const clearThemeCache = () => {
if (clearingThemeCache) {
return;
}
clearingThemeCache = true;
themeCache.clear();
setTimeout(() => {
// We set this timeout to avoid clearing the cache multiple times
// this would happen as we have a Provider for each screen in the stack
// and when the themes changes we only want to invalidate the cache once
clearingThemeCache = false;
}, 300);
};
const getTheme = (teamId: string | undefined, themes: PreferenceModel[]): Theme => {
if (teamId && themeCache.has(teamId)) {
return themeCache.get(teamId)!;
}
const newTheme = (() => {
if (teamId) {
const teamTheme = themes.find((t) => t.name === teamId) || themes[0];
if (teamTheme?.value) {
try {
return setThemeDefaults(JSON.parse(teamTheme.value));
} catch {
// no theme change
}
}
}
return getDefaultThemeByAppearance();
})();
themeCache.set(teamId || 'default', newTheme);
return newTheme;
};
const ThemeProvider = ({currentTeamId, children, themes}: Props) => {
const [theme, setTheme] = useState(() => getTheme(currentTeamId, themes));
useEffect(() => {
const listener = Appearance.addChangeListener(() => {
const newTheme = getTheme(currentTeamId, themes);
if (theme !== newTheme) {
setTheme(newTheme);
}
});
return () => listener.remove();
}, [currentTeamId, themes, theme]);
useEffect(() => {
updateThemeIfNeeded(theme);
}, [theme]);
useDidUpdate(() => {
clearThemeCache();
}, [themes]);
useDidUpdate(() => {
setTheme(getTheme(currentTeamId, themes));
}, [currentTeamId, themes]);
return (<Provider value={theme}>{children}</Provider>);
};
export const CustomThemeProvider = ({theme, children}: {theme: Theme; children: React.ReactNode}) => {
return (<Provider value={theme}>{children}</Provider>);
};
export function withTheme<T extends WithThemeProps>(Component: ComponentType<T>): ComponentType<T> {
return function ThemeComponent(props) {
return (
<Consumer>
{(theme: Theme) => (
<Component
{...props}
theme={theme}
/>
)}
</Consumer>
);
};
}
export function useTheme(): Theme {
return React.useContext(ThemeContext);
}
const enhancedThemeProvider = withObservables([], ({database}: {database: Database}) => ({
currentTeamId: observeCurrentTeamId(database),
themes: queryThemePreferences(database).observeWithColumns(['value']),
}));
export default enhancedThemeProvider(ThemeProvider);