Skip to content

A local-first personal finance app

🛠️ Add retries to electron loot-core import (#5843)

Michael Clarkda93ddf63b47
diff --git a/package.json b/package.json
index 117dca5181..aaaa6ae714 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
"start:server-monitor": "yarn workspace @actual-app/sync-server start-monitor",
"start:server-dev": "NODE_ENV=development BROWSER_OPEN=localhost:5006 yarn npm-run-all --parallel 'start:server-monitor' 'start'",
"start:desktop": "yarn desktop-dependencies && npm-run-all --parallel 'start:desktop-*'",
- "desktop-dependencies": "yarn rebuild-electron && yarn workspace loot-core build:browser",
+ "desktop-dependencies": "npm-run-all --parallel rebuild-electron build:browser-backend",
"start:desktop-node": "yarn workspace loot-core watch:node",
"start:desktop-client": "yarn workspace @actual-app/web watch",
"start:desktop-server-client": "yarn workspace @actual-app/web build:browser",
@@ -31,6 +31,7 @@
"start:browser": "npm-run-all --parallel 'start:browser-*'",
"start:browser-backend": "yarn workspace loot-core watch:browser",
"start:browser-frontend": "yarn workspace @actual-app/web start:browser",
+ "build:browser-backend": "yarn workspace loot-core build:browser",
"build:server": "yarn build:browser && yarn workspace @actual-app/sync-server build",
"build:browser": "./bin/package-browser",
"build:desktop": "./bin/package-electron",
diff --git a/packages/desktop-electron/server.ts b/packages/desktop-electron/server.ts
index cf8a79f2ec..f48c946869 100644
--- a/packages/desktop-electron/server.ts
+++ b/packages/desktop-electron/server.ts
@@ -1,3 +1,7 @@
+import promiseRetry from 'promise-retry';
+
+const BACKEND_IMPORT_MAX_RETRIES = 30;
+
const lazyLoadBackend = async (isDev: boolean) => {
if (process.env.lootCoreScript === undefined) {
throw new Error(
@@ -6,11 +10,33 @@ const lazyLoadBackend = async (isDev: boolean) => {
}
try {
- const bundle = await import(process.env.lootCoreScript);
+ // These retries are primarily for dev mode, where we watch for changes in loot-core
+ // In a packaged build this should always work the first time.
+ const bundle = await promiseRetry(
+ async (retry, number) => {
+ try {
+ return await import(process.env.lootCoreScript!);
+ } catch (error) {
+ console.info(
+ `Loading server bundle: Attempt ${number} of ${BACKEND_IMPORT_MAX_RETRIES}`,
+ );
+
+ retry(error);
+ }
+ },
+ {
+ retries: BACKEND_IMPORT_MAX_RETRIES,
+ minTimeout: 1000,
+ maxTimeout: 1000,
+ factor: 1, // No exponential backoff
+ },
+ );
bundle.initApp(isDev);
} catch (error) {
- console.error('Failed to init the server bundle:', error);
- throw new Error(`Failed to init the server bundle: ${error}`);
+ console.error('Failed to init the server bundle after all retries:', error);
+ throw new Error(
+ `Failed to init the server bundle after all retries: ${error}`,
+ );
}
};
diff --git a/upcoming-release-notes/5843.md b/upcoming-release-notes/5843.md
new file mode 100644
index 0000000000..703a4a5b5a
--- /dev/null
+++ b/upcoming-release-notes/5843.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MikesGlitch]
+---
+
+Add retries into the initialisation of the desktop app backend for a better dev-experience