Skip to content

A local-first personal finance app

Frontend plugins Support [3/10]: System-Wide Feature Flag System + Frontend plugins feature flag (#5785)

lelemm0c280d60f652
diff --git a/packages/desktop-client/src/components/ThemeSelector.tsx b/packages/desktop-client/src/components/ThemeSelector.tsx
index c7e4c8167f..5c6913ef04 100644
--- a/packages/desktop-client/src/components/ThemeSelector.tsx
+++ b/packages/desktop-client/src/components/ThemeSelector.tsx
@@ -35,12 +35,14 @@ export function ThemeSelector({ style }: ThemeSelectorProps) {
development: SvgMoonStars,
} as const;
+ type ThemeIconKey = keyof typeof themeIcons;
+
function onMenuSelect(newTheme: Theme) {
setMenuOpen(false);
switchTheme(newTheme);
}
- const Icon = themeIcons[theme] || SvgSun;
+ const Icon = themeIcons[theme as ThemeIconKey] || SvgSun;
if (isNarrowWidth) {
return null;
diff --git a/packages/desktop-client/src/components/settings/Experimental.tsx b/packages/desktop-client/src/components/settings/Experimental.tsx
index d5a5c068d2..25d695d7cc 100644
--- a/packages/desktop-client/src/components/settings/Experimental.tsx
+++ b/packages/desktop-client/src/components/settings/Experimental.tsx
@@ -5,7 +5,7 @@ import { Text } from '@actual-app/components/text';
import { theme } from '@actual-app/components/theme';
import { View } from '@actual-app/components/view';
-import type { FeatureFlag } from 'loot-core/types/prefs';
+import type { FeatureFlag, SyncedPrefs } from 'loot-core/types/prefs';
import { Setting } from './UI';
@@ -68,6 +68,59 @@ function FeatureToggle({
);
}
+type GlobalFeatureToggleProps = {
+ prefName: keyof SyncedPrefs;
+ disableToggle?: boolean;
+ error?: ReactNode;
+ children: ReactNode;
+ feedbackLink?: string;
+};
+
+function GlobalFeatureToggle({
+ prefName,
+ disableToggle = false,
+ feedbackLink,
+ error,
+ children,
+}: GlobalFeatureToggleProps) {
+ const [enabled, setEnabled] = useSyncedPref(prefName, { isGlobal: true });
+
+ return (
+ <label style={{ display: 'flex' }}>
+ <Checkbox
+ checked={enabled === 'true'}
+ onChange={() => {
+ setEnabled(enabled === 'true' ? 'false' : 'true');
+ }}
+ disabled={disableToggle}
+ />
+ <View
+ style={{ color: disableToggle ? theme.pageTextSubdued : 'inherit' }}
+ >
+ <View style={{ flexDirection: 'row', alignItems: 'center', gap: 5 }}>
+ {children}
+ {feedbackLink && (
+ <Link variant="external" to={feedbackLink}>
+ <Trans>(give feedback)</Trans>
+ </Link>
+ )}
+ </View>
+
+ {disableToggle && (
+ <Text
+ style={{
+ color: theme.errorText,
+ fontWeight: 500,
+ }}
+ >
+ {error}
+ </Text>
+ )}
+ </View>
+ </label>
+ );
+}
+
export function ExperimentalFeatures() {
const [expanded, setExpanded] = useState(false);
@@ -105,6 +158,13 @@ export function ExperimentalFeatures() {
>
<Trans>Currency support</Trans>
</FeatureToggle>
+ <GlobalFeatureToggle
+ prefName="plugins"
+ disableToggle={true}
+ feedbackLink="https://github.com/actualbudget/actual/pull/4049"
+ >
+ <Trans>Client-Side plugins (soon)</Trans>
+ </GlobalFeatureToggle>
</View>
) : (
<Link
diff --git a/packages/desktop-client/src/hooks/useFeatureFlag.ts b/packages/desktop-client/src/hooks/useFeatureFlag.ts
index 4e8912cf5f..a7872b7dd2 100644
--- a/packages/desktop-client/src/hooks/useFeatureFlag.ts
+++ b/packages/desktop-client/src/hooks/useFeatureFlag.ts
@@ -7,6 +7,7 @@ const DEFAULT_FEATURE_FLAG_STATE: Record<FeatureFlag, boolean> = {
goalTemplatesUIEnabled: false,
actionTemplating: false,
currency: false,
+ plugins: false,
};
export function useFeatureFlag(name: FeatureFlag): boolean {
diff --git a/packages/desktop-client/src/hooks/useSyncedPref.ts b/packages/desktop-client/src/hooks/useSyncedPref.ts
index 3de12c360b..d314d41015 100644
--- a/packages/desktop-client/src/hooks/useSyncedPref.ts
+++ b/packages/desktop-client/src/hooks/useSyncedPref.ts
@@ -11,13 +11,19 @@ type SetSyncedPrefAction<K extends keyof SyncedPrefs> = (
export function useSyncedPref<K extends keyof SyncedPrefs>(
prefName: K,
+ options?: { isGlobal?: boolean },
): [SyncedPrefs[K], SetSyncedPrefAction<K>] {
const dispatch = useDispatch();
const setPref = useCallback<SetSyncedPrefAction<K>>(
value => {
- dispatch(saveSyncedPrefs({ prefs: { [prefName]: value } }));
+ dispatch(
+ saveSyncedPrefs({
+ prefs: { [prefName]: value },
+ isGlobal: options?.isGlobal,
+ }),
+ );
},
- [prefName, dispatch],
+ [prefName, dispatch, options?.isGlobal],
);
const pref = useSelector(state => state.prefs.synced[prefName]);
diff --git a/packages/desktop-client/src/prefs/prefsSlice.ts b/packages/desktop-client/src/prefs/prefsSlice.ts
index b5e8dc17a5..69bdca4d22 100644
--- a/packages/desktop-client/src/prefs/prefsSlice.ts
+++ b/packages/desktop-client/src/prefs/prefsSlice.ts
@@ -108,16 +108,18 @@ export const saveGlobalPrefs = createAppAsyncThunk(
type SaveSyncedPrefsPayload = {
prefs: SyncedPrefs;
+ isGlobal?: boolean;
};
export const saveSyncedPrefs = createAppAsyncThunk(
`${sliceName}/saveSyncedPrefs`,
- async ({ prefs }: SaveSyncedPrefsPayload, { dispatch }) => {
+ async ({ prefs, isGlobal }: SaveSyncedPrefsPayload, { dispatch }) => {
await Promise.all(
Object.entries(prefs).map(([prefName, value]) =>
send('preferences/save', {
id: prefName as keyof SyncedPrefs,
value,
+ isGlobal,
}),
),
);
diff --git a/packages/desktop-client/src/style/theme.tsx b/packages/desktop-client/src/style/theme.tsx
index 13189a55a3..dfb52bf6cb 100644
--- a/packages/desktop-client/src/style/theme.tsx
+++ b/packages/desktop-client/src/style/theme.tsx
@@ -18,7 +18,9 @@ const themes = {
...(isNonProductionEnvironment() && {
development: { name: 'Development', colors: developmentTheme },
}),
-};
+} as const;
+
+type ThemeKey = keyof typeof themes;
export const themeOptions = Object.entries(themes).map(
([key, { name }]) => [key, name] as [Theme, string],
@@ -84,7 +86,7 @@ export function ThemeStyle() {
);
};
} else {
- setThemeColors(themes[activeTheme]?.colors);
+ setThemeColors(themes[activeTheme as ThemeKey]?.colors);
}
}, [activeTheme, darkThemePreference]);
diff --git a/packages/loot-core/migrations/1759842823172_add_isGlobal_to_preferences.sql b/packages/loot-core/migrations/1759842823172_add_isGlobal_to_preferences.sql
new file mode 100644
index 0000000000..84821fee39
--- /dev/null
+++ b/packages/loot-core/migrations/1759842823172_add_isGlobal_to_preferences.sql
@@ -0,0 +1,8 @@
+-- Migration: Add isGlobal column to preferences table
+BEGIN TRANSACTION;
+
+ALTER TABLE preferences ADD COLUMN isGlobal INTEGER DEFAULT 0;
+
+COMMIT;
+
+
diff --git a/packages/loot-core/src/server/db/types/index.ts b/packages/loot-core/src/server/db/types/index.ts
index be6d260d98..06980de217 100644
--- a/packages/loot-core/src/server/db/types/index.ts
+++ b/packages/loot-core/src/server/db/types/index.ts
@@ -212,6 +212,7 @@ export type DbTransactionFilter = {
export type DbPreference = {
id: string;
value: string;
+ isGlobal?: 1 | 0;
};
export type DbCustomReport = {
diff --git a/packages/loot-core/src/server/preferences/app.ts b/packages/loot-core/src/server/preferences/app.ts
index 1b86f201c4..0a7ea1d69e 100644
--- a/packages/loot-core/src/server/preferences/app.ts
+++ b/packages/loot-core/src/server/preferences/app.ts
@@ -39,15 +39,21 @@ app.method('load-prefs', loadMetadataPrefs);
async function saveSyncedPrefs({
id,
value,
+ isGlobal,
}: {
id: keyof SyncedPrefs;
value: string | undefined;
+ isGlobal?: boolean;
}) {
if (!id) {
return;
}
- await db.update('preferences', { id, value });
+ await db.update('preferences', {
+ id,
+ value,
+ ...(isGlobal !== undefined && { isGlobal: isGlobal ? 1 : 0 }),
+ });
}
async function getSyncedPrefs(): Promise<SyncedPrefs> {
diff --git a/packages/loot-core/src/types/prefs.ts b/packages/loot-core/src/types/prefs.ts
index e00aa5347b..4d08e5582c 100644
--- a/packages/loot-core/src/types/prefs.ts
+++ b/packages/loot-core/src/types/prefs.ts
@@ -2,7 +2,8 @@ export type FeatureFlag =
| 'goalTemplatesEnabled'
| 'goalTemplatesUIEnabled'
| 'actionTemplating'
- | 'currency';
+ | 'currency'
+ | 'plugins';
/**
* Cross-device preferences. These sync across devices when they are changed.
@@ -19,6 +20,7 @@ export type SyncedPrefs = Partial<
| 'currencySymbolPosition'
| 'currencySpaceBetweenAmountAndSymbol'
| 'defaultCurrencyCode'
+ | 'plugins'
| `show-account-${string}-net-worth-chart`
| `side-nav.show-balance-history-${string}`
| `show-balances-${string}`
@@ -81,7 +83,13 @@ export type LocalPrefs = Partial<{
'mobile.showSpentColumn': boolean;
}>;
-export type Theme = 'light' | 'dark' | 'auto' | 'midnight' | 'development';
+export type Theme =
+ | 'light'
+ | 'dark'
+ | 'auto'
+ | 'midnight'
+ | 'development'
+ | string;
export type DarkTheme = 'dark' | 'midnight';
// GlobalPrefs are the parsed global-store.json values
@@ -93,6 +101,17 @@ export type GlobalPrefs = Partial<{
language: string;
theme: Theme;
preferredDarkTheme: DarkTheme;
+ plugins: boolean;
+ pluginThemes: Record<
+ string,
+ {
+ id: string;
+ displayName: string;
+ description?: string;
+ baseTheme?: 'light' | 'dark' | 'midnight';
+ colors: Record<string, string>;
+ }
+ >; // Complete plugin theme metadata
documentDir: string; // Electron only
serverSelfSignedCert: string; // Electron only
syncServerConfig?: {
@@ -121,6 +140,8 @@ export type GlobalPrefsJson = Partial<{
language?: GlobalPrefs['language'];
theme?: GlobalPrefs['theme'];
'preferred-dark-theme'?: GlobalPrefs['preferredDarkTheme'];
+ plugins?: string; // "true" or "false"
+ 'plugin-theme'?: string; // JSON string of complete plugin theme (current selected plugin theme)
'server-self-signed-cert'?: GlobalPrefs['serverSelfSignedCert'];
syncServerConfig?: GlobalPrefs['syncServerConfig'];
notifyWhenUpdateIsAvailable?: GlobalPrefs['notifyWhenUpdateIsAvailable'];
diff --git a/upcoming-release-notes/5785.md b/upcoming-release-notes/5785.md
new file mode 100644
index 0000000000..c3a1b91be5
--- /dev/null
+++ b/upcoming-release-notes/5785.md
@@ -0,0 +1,7 @@
+---
+category: Features
+authors: [lelemm]
+---
+
+Introduce system-wide feature flag system for managing frontend plugins.
+