A local-first personal finance app
fix flaky e2e test (#9114)
Matt Fiddaman6ee7900cf05e
diff --git a/packages/desktop-client/e2e/settings.test.ts b/packages/desktop-client/e2e/settings.test.tsindex e4fceabcaa..ff20d7037c 100644--- a/packages/desktop-client/e2e/settings.test.ts+++ b/packages/desktop-client/e2e/settings.test.ts@@ -50,7 +50,14 @@ test.describe('Settings', () => {await page.route('**/test/theme/refs/heads/main/actual.css*', route =>route.fulfill({ body: ':root { --color-pageBackground: #eeeeee; }' }),);- await page.evaluate(() => window.Actual.setTheme('light'));+ await expect(async () => {+ await page.evaluate(() => window.Actual.setTheme('light'));+ await expect(page.locator('[data-theme]')).toHaveAttribute(+ 'data-theme',+ 'light',+ { timeout: 1000 },+ );+ }).toPass({ timeout: 15000 });await page.getByRole('button', { name: 'Light', exact: true }).click();await page.getByRole('button', { name: 'Custom theme', exact: true })diff --git a/packages/desktop-client/src/prefs/prefsSlice.test.ts b/packages/desktop-client/src/prefs/prefsSlice.test.tsnew file mode 100644index 0000000000..d56650b96b--- /dev/null+++ b/packages/desktop-client/src/prefs/prefsSlice.test.ts@@ -0,0 +1,75 @@+import type { GlobalPrefs } from '@actual-app/core/types/prefs';++vi.mock(+ '@actual-app/core/platform/client/connection',+ () => import('#mocks/connection'),+);++async function setup() {+ vi.resetModules();+ const { initServer } =+ await import('@actual-app/core/platform/client/connection');+ const { configureTestAppStore, createTestQueryClient } =+ await import('#mocks');+ const { loadGlobalPrefs, loadPrefs, saveGlobalPrefs } =+ await import('./prefsSlice');++ let storedGlobalPrefs: GlobalPrefs = {};+ let globalLoads = 0;+ let releaseFirstLoad: (() => void) | undefined;++ initServer({+ 'load-prefs': async () => ({}),+ 'preferences/get': async () => ({}),+ 'save-global-prefs': async prefs => {+ storedGlobalPrefs = { ...storedGlobalPrefs, ...prefs };+ return 'ok';+ },+ 'load-global-prefs': async () => {+ const snapshot = storedGlobalPrefs;+ globalLoads++;+ if (globalLoads === 1) {+ await new Promise<void>(resolve => {+ releaseFirstLoad = resolve;+ });+ }+ return snapshot;+ },+ });++ return {+ store: configureTestAppStore({ queryClient: createTestQueryClient() }),+ loadGlobalPrefs,+ loadPrefs,+ saveGlobalPrefs,+ waitForFirstLoad: () => vi.waitFor(() => expect(globalLoads).toBe(1)),+ releaseFirstLoad: () => releaseFirstLoad?.(),+ };+}++describe('prefsSlice', () => {+ it('keeps a global pref saved while loadGlobalPrefs is in flight', async () => {+ const { store, loadGlobalPrefs, saveGlobalPrefs, ...server } =+ await setup();++ const loading = store.dispatch(loadGlobalPrefs());+ await server.waitForFirstLoad();+ await store.dispatch(saveGlobalPrefs({ prefs: { theme: 'light' } }));+ server.releaseFirstLoad();+ await loading;++ expect(store.getState().prefs.global.theme).toBe('light');+ });++ it('keeps a global pref saved while loadPrefs is in flight', async () => {+ const { store, loadPrefs, saveGlobalPrefs, ...server } = await setup();++ const loading = store.dispatch(loadPrefs());+ await server.waitForFirstLoad();+ await store.dispatch(saveGlobalPrefs({ prefs: { theme: 'light' } }));+ server.releaseFirstLoad();+ await loading;++ expect(store.getState().prefs.global.theme).toBe('light');+ });+});diff --git a/packages/desktop-client/src/prefs/prefsSlice.ts b/packages/desktop-client/src/prefs/prefsSlice.tsindex 73724dd763..cd373b8fab 100644--- a/packages/desktop-client/src/prefs/prefsSlice.ts+++ b/packages/desktop-client/src/prefs/prefsSlice.ts@@ -34,6 +34,8 @@ const initialState: PrefsState = {server: {},};+let globalPrefsSaveCount = 0;+export const loadPrefs = createAppAsyncThunk(`${sliceName}/loadPrefs`,async (_, { dispatch, getState }) => {@@ -45,10 +47,16 @@ export const loadPrefs = createAppAsyncThunk(dispatch(closeModal());}- const [globalPrefs, syncedPrefs] = await Promise.all([- send('load-global-prefs'),- send('preferences/get'),- ]);+ let savesBeforeLoad: number;+ let globalPrefs: GlobalPrefs;+ let syncedPrefs: SyncedPrefs;+ do {+ savesBeforeLoad = globalPrefsSaveCount;+ [globalPrefs, syncedPrefs] = await Promise.all([+ send('load-global-prefs'),+ send('preferences/get'),+ ]);+ } while (savesBeforeLoad !== globalPrefsSaveCount);dispatch(setPrefs({ local: prefs, global: globalPrefs, synced: syncedPrefs }),@@ -84,7 +92,13 @@ export const savePrefs = createAppAsyncThunk(export const loadGlobalPrefs = createAppAsyncThunk(`${sliceName}/loadGlobalPrefs`,async (_, { dispatch, getState }) => {- const globalPrefs = await send('load-global-prefs');+ let savesBeforeLoad: number;+ let globalPrefs: GlobalPrefs;+ do {+ savesBeforeLoad = globalPrefsSaveCount;+ globalPrefs = await send('load-global-prefs');+ } while (savesBeforeLoad !== globalPrefsSaveCount);+dispatch(setPrefs({local: getState().prefs.local,@@ -108,6 +122,7 @@ export const saveGlobalPrefs = createAppAsyncThunk({ dispatch },) => {await send('save-global-prefs', prefs);+ globalPrefsSaveCount++;dispatch(mergeGlobalPrefs(prefs));onSaveGlobalPrefs?.();},diff --git a/upcoming-release-notes/fix-settings-theme-e2e-test.md b/upcoming-release-notes/fix-settings-theme-e2e-test.mdnew file mode 100644index 0000000000..fad2930524--- /dev/null+++ b/upcoming-release-notes/fix-settings-theme-e2e-test.md@@ -0,0 +1,6 @@+---+category: Maintenance+authors: [matt-fidd]+---++Fix a flaky settings e2e test that could run before the light theme was applied