Skip to content

A local-first personal finance app

🐛 [Bug] Pinning sidebar doesn't persist on reload (#4733)

Alec Bakholdin91aa2ae47b02
diff --git a/packages/loot-core/src/platform/server/asyncStorage/__mocks__/index.ts b/packages/loot-core/src/platform/server/asyncStorage/__mocks__/index.ts
index 2d9e40ee1d..be45225229 100644
--- a/packages/loot-core/src/platform/server/asyncStorage/__mocks__/index.ts
+++ b/packages/loot-core/src/platform/server/asyncStorage/__mocks__/index.ts
@@ -6,17 +6,15 @@ const store: GlobalPrefsJson = {};
export const init: T.Init = function () {};
-export const getItem: T.GetItem = function (key) {
- return new Promise(function (resolve) {
- return resolve(store[key]);
- });
+export const getItem: T.GetItem = async function (key) {
+ return store[key];
};
-export const setItem: T.SetItem = function (key, value) {
+export const setItem: T.SetItem = async function (key, value) {
store[key] = value;
};
-export const removeItem: T.RemoveItem = function (key) {
+export const removeItem: T.RemoveItem = async function (key) {
delete store[key];
};
@@ -32,13 +30,13 @@ export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(
});
}
-export const multiSet: T.MultiSet = function (keyValues) {
+export const multiSet: T.MultiSet = async function (keyValues) {
keyValues.forEach(function ([key, value]) {
store[key] = value;
});
};
-export const multiRemove: T.MultiRemove = function (keys) {
+export const multiRemove: T.MultiRemove = async function (keys) {
keys.forEach(function (key) {
delete store[key];
});
diff --git a/packages/loot-core/src/platform/server/asyncStorage/index.d.ts b/packages/loot-core/src/platform/server/asyncStorage/index.d.ts
index 88f7f415de..39fb728125 100644
--- a/packages/loot-core/src/platform/server/asyncStorage/index.d.ts
+++ b/packages/loot-core/src/platform/server/asyncStorage/index.d.ts
@@ -13,22 +13,22 @@ export type GetItem = typeof getItem;
export function setItem<K extends keyof GlobalPrefsJson>(
key: K,
value: GlobalPrefsJson[K],
-): void;
+): Promise<void>;
export type SetItem = typeof setItem;
-export function removeItem(key: keyof GlobalPrefsJson): void;
+export function removeItem(key: keyof GlobalPrefsJson): Promise<void>;
export type RemoveItem = typeof removeItem;
-export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(
+export function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(
keys: K,
): Promise<{ [P in keyof K]: [K[P], GlobalPrefsJson[K[P]]] }>;
export type MultiGet = typeof multiGet;
export function multiSet<K extends keyof GlobalPrefsJson>(
keyValues: Array<[K, GlobalPrefsJson[K]]>,
-): void;
+): Promise<void>;
export type MultiSet = typeof multiSet;
-export function multiRemove(keys: (keyof GlobalPrefsJson)[]): void;
+export function multiRemove(keys: (keyof GlobalPrefsJson)[]): Promise<void>;
export type MultiRemove = typeof multiRemove;
diff --git a/packages/loot-core/src/platform/server/asyncStorage/index.electron.ts b/packages/loot-core/src/platform/server/asyncStorage/index.electron.ts
index 7852e45f46..0664d7dc8e 100644
--- a/packages/loot-core/src/platform/server/asyncStorage/index.electron.ts
+++ b/packages/loot-core/src/platform/server/asyncStorage/index.electron.ts
@@ -25,7 +25,7 @@ export const init: T.Init = function ({ persist = true } = {}) {
persisted = persist;
};
-function _saveStore() {
+function _saveStore(): Promise<void> {
if (persisted) {
return new Promise(function (resolve, reject) {
fs.writeFile(
@@ -33,7 +33,7 @@ function _saveStore() {
JSON.stringify(store),
'utf8',
function (err) {
- return err ? reject(err) : resolve(undefined);
+ return err ? reject(err) : resolve();
},
);
});
@@ -59,13 +59,9 @@ export const removeItem: T.RemoveItem = function (key) {
export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(
keys: K,
) {
- return new Promise(function (resolve) {
- return resolve(
- keys.map(function (key) {
- return [key, store[key]];
- }) as { [P in keyof K]: [K[P], GlobalPrefsJson[K[P]]] },
- );
- });
+ return keys.map(key => [key, store[key]]) as {
+ [P in keyof K]: [K[P], GlobalPrefsJson[K[P]]];
+ };
}
export const multiSet: T.MultiSet = function (keyValues) {
diff --git a/packages/loot-core/src/platform/server/asyncStorage/index.ts b/packages/loot-core/src/platform/server/asyncStorage/index.ts
index 94ce316a46..c504f66303 100644
--- a/packages/loot-core/src/platform/server/asyncStorage/index.ts
+++ b/packages/loot-core/src/platform/server/asyncStorage/index.ts
@@ -6,12 +6,6 @@ import * as T from './index.d';
export const init: T.Init = function () {};
-function commit(trans) {
- if (trans.commit) {
- trans.commit();
- }
-}
-
export const getItem: T.GetItem = async function (key) {
const db = await getDatabase();
@@ -23,7 +17,6 @@ export const getItem: T.GetItem = async function (key) {
req.onerror = e => reject(e);
// @ts-expect-error fix me
req.onsuccess = e => resolve(e.target.result);
- commit(transaction);
});
};
@@ -37,7 +30,7 @@ export const setItem: T.SetItem = async function (key, value) {
const req = objectStore.put(value, key);
req.onerror = e => reject(e);
req.onsuccess = () => resolve(undefined);
- commit(transaction);
+ transaction.commit();
});
};
@@ -51,7 +44,7 @@ export const removeItem: T.RemoveItem = async function (key) {
const req = objectStore.delete(key);
req.onerror = e => reject(e);
req.onsuccess = () => resolve(undefined);
- commit(transaction);
+ transaction.commit();
});
};
@@ -74,7 +67,7 @@ export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>(
}),
);
- commit(transaction);
+ transaction.commit();
return promise;
}
@@ -94,8 +87,8 @@ export const multiSet: T.MultiSet = async function (keyValues) {
}),
);
- commit(transaction);
- return promise;
+ transaction.commit();
+ await promise;
};
export const multiRemove: T.MultiRemove = async function (keys) {
@@ -114,6 +107,6 @@ export const multiRemove: T.MultiRemove = async function (keys) {
}),
);
- commit(transaction);
- return promise;
+ transaction.commit();
+ await promise;
};
diff --git a/packages/loot-core/src/server/preferences/app.ts b/packages/loot-core/src/server/preferences/app.ts
index b18b9026c3..51a5783687 100644
--- a/packages/loot-core/src/server/preferences/app.ts
+++ b/packages/loot-core/src/server/preferences/app.ts
@@ -69,12 +69,10 @@ async function saveGlobalPrefs(prefs: GlobalPrefs) {
if (prefs.maxMonths) {
await asyncStorage.setItem('max-months', '' + prefs.maxMonths);
}
- if (prefs.documentDir) {
- if (prefs.documentDir && (await fs.exists(prefs.documentDir))) {
- await asyncStorage.setItem('document-dir', prefs.documentDir);
- }
+ if (prefs.documentDir && (await fs.exists(prefs.documentDir))) {
+ await asyncStorage.setItem('document-dir', prefs.documentDir);
}
- if (prefs.floatingSidebar) {
+ if (prefs.floatingSidebar !== undefined) {
await asyncStorage.setItem('floating-sidebar', '' + prefs.floatingSidebar);
}
if (prefs.language) {
diff --git a/upcoming-release-notes/4733.md b/upcoming-release-notes/4733.md
new file mode 100644
index 0000000000..4c449aebe8
--- /dev/null
+++ b/upcoming-release-notes/4733.md
@@ -0,0 +1,6 @@
+---
+category: Bugfix
+authors: [alecbakholdin]
+---
+
+Fixed issue where sidebar wouldn't persist pinning preference on page reload