From 9c527e3fce38f6bece55123c75ae2ac32e113d09 Mon Sep 17 00:00:00 2001
From: Jed Fox <git@jedfox.com>
Date: Mon, 24 Jul 2023 15:48:30 -0400
Subject: [PATCH] Improve messaging when the API fails to download a file
(#1396)
---
packages/loot-core/src/server/api.ts | 1 +
packages/loot-core/src/shared/errors.ts | 7 ++++---
upcoming-release-notes/1396.md | 6 ++++++
3 files changed, 11 insertions(+), 3 deletions(-)
create mode 100644 upcoming-release-notes/1396.md
diff --git a/packages/loot-core/src/server/api.ts b/packages/loot-core/src/server/api.ts
index 2d67d5e9c..885d21fc0 100644
--- a/packages/loot-core/src/server/api.ts
+++ b/packages/loot-core/src/server/api.ts
@@ -204,6 +204,7 @@ handlers['api/download-budget'] = async function ({ syncId, password }) {
let result = await handlers['download-budget']({ fileId: file.fileId });
if (result.error) {
+ console.log('Full error details', result.error);
throw new Error(getDownloadError(result.error));
}
await handlers['load-budget']({ id: result.id });
diff --git a/packages/loot-core/src/shared/errors.ts b/packages/loot-core/src/shared/errors.ts
index 61b16f4f1..1f62874da 100644
--- a/packages/loot-core/src/shared/errors.ts
+++ b/packages/loot-core/src/shared/errors.ts
@@ -51,10 +51,11 @@ export function getDownloadError({ reason, meta, fileName }) {
);
default:
- let info = meta && meta.fileId ? `(fileId: ${meta.fileId})` : '';
+ let info = meta && meta.fileId ? `, fileId: ${meta.fileId}` : '';
return (
- 'Something went wrong trying to download that file, sorry! Visit https://actualbudget.org/contact/ for support. ' +
- info
+ 'Something went wrong trying to download that file, sorry! ' +
+ 'Visit https://actualbudget.org/contact/ for support. ' +
+ `(reason: ${reason}${info})`
);
}
}
diff --git a/upcoming-release-notes/1396.md b/upcoming-release-notes/1396.md
new file mode 100644
index 000000000..8213e5fc0
--- /dev/null
+++ b/upcoming-release-notes/1396.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [j-f1]
+---
+
+Improve error messaging when the API package fails to download a file
--
GitLab