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

chore: Replace collection with Zustand store in EditableSettingsProvider #35597

Merged
merged 2 commits into from
Mar 24, 2025
Merged

chore: Replace collection with Zustand store in EditableSettingsProvider #35597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2402396
Remove collection from `EditableSettingsProvider`
tassoevan Mar 13, 2025
586e4ad
Use Zustand
tassoevan Mar 15, 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
139 changes: 99 additions & 40 deletions apps/meteor/client/views/admin/EditableSettingsContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,127 @@
import type { ISettingBase, ISettingColor, ISetting } from '@rocket.chat/core-typings';
import type { SettingsContextQuery } from '@rocket.chat/ui-contexts';
import { createContext, useContext, useMemo, useSyncExternalStore } from 'react';
import type { ISetting } from '@rocket.chat/core-typings';
import { createContext, useContext } from 'react';
import { create, type StoreApi, type UseBoundStore } from 'zustand';
import { useShallow } from 'zustand/shallow';

export type EditableSetting = (ISettingBase | ISettingColor) & {
export type EditableSetting = ISetting & {
disabled: boolean;
changed: boolean;
invisible: boolean;
};

type EditableSettingsContextQuery = SettingsContextQuery & {
changed?: boolean;
export const compareSettings = (a: EditableSetting, b: EditableSetting): number => {
const sorter = a.sorter - b.sorter;
if (sorter !== 0) return sorter;

const tab = (a.tab ?? '').localeCompare(b.tab ?? '');
if (tab !== 0) return tab;

const i18nLabel = a.i18nLabel.localeCompare(b.i18nLabel);

return i18nLabel;
};

type EditableSettingsContextQuery =
| {
group: ISetting['_id'];
}
| {
group: ISetting['_id'];
section: string;
tab?: ISetting['_id'];
}
| {
group: ISetting['_id'];
changed: true;
};

export interface IEditableSettingsState {
state: EditableSetting[];
initialState: ISetting[];
sync(newInitialState: ISetting[]): void;
mutate(changes: Partial<EditableSetting>[]): void;
}

export type EditableSettingsContextValue = {
readonly queryEditableSetting: (
_id: ISetting['_id'],
) => [subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => EditableSetting | undefined];
readonly queryEditableSettings: (
query: EditableSettingsContextQuery,
) => [subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => EditableSetting[]];
readonly queryGroupSections: (
_id: ISetting['_id'],
tab?: ISetting['_id'],
) => [subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => string[]];
readonly queryGroupTabs: (
_id: ISetting['_id'],
) => [subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => ISetting['_id'][]];
readonly dispatch: (changes: Partial<EditableSetting>[]) => void;
useEditableSettingsStore: UseBoundStore<StoreApi<IEditableSettingsState>>;
};

export const EditableSettingsContext = createContext<EditableSettingsContextValue>({
queryEditableSetting: () => [(): (() => void) => (): void => undefined, (): undefined => undefined],
queryEditableSettings: () => [(): (() => void) => (): void => undefined, (): EditableSetting[] => []],
queryGroupSections: () => [(): (() => void) => (): void => undefined, (): string[] => []],
queryGroupTabs: () => [(): (() => void) => (): void => undefined, (): ISetting['_id'][] => []],
dispatch: () => undefined,
useEditableSettingsStore: create<IEditableSettingsState>()(() => ({
state: [],
initialState: [],
sync: () => undefined,
mutate: () => undefined,
})),
});

export const useEditableSetting = (_id: ISetting['_id']): EditableSetting | undefined => {
const { queryEditableSetting } = useContext(EditableSettingsContext);
const { useEditableSettingsStore } = useContext(EditableSettingsContext);

const [subscribe, getSnapshot] = useMemo(() => queryEditableSetting(_id), [queryEditableSetting, _id]);
return useSyncExternalStore(subscribe, getSnapshot);
return useEditableSettingsStore((state) => state.state.find((x) => x._id === _id));
};

export const useEditableSettings = (query?: EditableSettingsContextQuery): EditableSetting[] => {
const { queryEditableSettings } = useContext(EditableSettingsContext);
const [subscribe, getSnapshot] = useMemo(() => queryEditableSettings(query ?? {}), [queryEditableSettings, query]);
return useSyncExternalStore(subscribe, getSnapshot);
export const useEditableSettings = (query: EditableSettingsContextQuery): EditableSetting[] => {
const { useEditableSettingsStore } = useContext(EditableSettingsContext);

return useEditableSettingsStore(
useShallow((state) =>
state.state
.filter((x) => {
if ('changed' in query) {
return x.group === query.group && x.changed;
}

if ('section' in query) {
return (
x.group === query.group &&
(query.section ? x.section === query.section : !x.section) &&
(query.tab ? x.tab === query.tab : !x.tab)
);
}

return x.group === query.group;
})
.sort(compareSettings),
),
);
};

export const useEditableSettingsGroupSections = (_id: ISetting['_id'], tab?: ISetting['_id']): string[] => {
const { queryGroupSections } = useContext(EditableSettingsContext);
const { useEditableSettingsStore } = useContext(EditableSettingsContext);

const [subscribe, getSnapshot] = useMemo(() => queryGroupSections(_id, tab), [queryGroupSections, _id, tab]);
return useSyncExternalStore(subscribe, getSnapshot);
return useEditableSettingsStore(
useShallow((state) =>
Array.from(
new Set(
state.state
.filter((x) => x.group === _id && (tab !== undefined ? x.tab === tab : !x.tab))
.sort(compareSettings)
.map(({ section }) => section || ''),
),
),
),
);
};

export const useEditableSettingsGroupTabs = (_id: ISetting['_id']): ISetting['_id'][] => {
const { queryGroupTabs } = useContext(EditableSettingsContext);
const { useEditableSettingsStore } = useContext(EditableSettingsContext);

const [subscribe, getSnapshot] = useMemo(() => queryGroupTabs(_id), [queryGroupTabs, _id]);
return useSyncExternalStore(subscribe, getSnapshot);
return useEditableSettingsStore(
useShallow((state) =>
Array.from(
new Set(
state.state
.filter((x) => x.group === _id)
.sort(compareSettings)
.map(({ tab }) => tab || ''),
),
),
),
);
};

export const useEditableSettingsDispatch = (): ((changes: Partial<EditableSetting>[]) => void) =>
useContext(EditableSettingsContext).dispatch;
export const useEditableSettingsDispatch = (): ((changes: Partial<EditableSetting>[]) => void) => {
const { useEditableSettingsStore } = useContext(EditableSettingsContext);
return useEditableSettingsStore((state) => state.mutate);
};
Loading
Loading