[PR #8026] [MERGED] [AI] API: improve messaging for version/schema mismatch errors #136357

Closed
opened 2026-06-17 21:05:57 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/8026
Author: @MatissJanis
Created: 6/1/2026
Status: Merged
Merged: 6/2/2026
Merged by: @MatissJanis

Base: masterHead: claude/api-version-check-messaging-uqI4b


📝 Commits (7)

  • 59cf791 [AI] Improve messaging for API version/schema mismatch errors
  • ffe0ef1 [AI] Set release note author to MatissJanis
  • 3090146 Add release notes for PR #8026
  • db1d10c [AI] Address review: use Vitest globals and remove duplicate release note
  • 7e32cda [AI] Avoid i18n in loot-core for schema-mismatch message
  • 458f371 [AI] Remove unnecessary code comments
  • df7d608 [AI] Add missing-meta test for getDownloadError

📊 Changes

4 files changed (+99 additions, -3 deletions)

View changed files

📝 packages/loot-core/src/server/api.ts (+4 -2)
packages/loot-core/src/shared/errors.test.ts (+63 -0)
📝 packages/loot-core/src/shared/errors.ts (+26 -1)
upcoming-release-notes/8026.md (+6 -0)

📄 Description

Description

Improving the error message people get when the schema mismatches when using the API. To hopefully reduce the amount of support questions about this.

N/A

Testing

Unit tests added

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 37 14.03 MB → 14.03 MB (+724 B) +0.00%
loot-core 1 5.34 MB → 5.34 MB (+771 B) +0.01%
api 2 3.97 MB → 3.97 MB (+762 B) +0.02%
cli 1 7.97 MB 0%
crdt 1 11.12 kB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
37 14.03 MB → 14.03 MB (+724 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts 📈 +724 B (+14.26%) 4.96 kB → 5.67 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/extends.js 500.96 kB → 501.67 kB (+724 B) +0.14%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/index.js 1.54 MB 0%
static/js/BackgroundImage.js 121.09 kB 0%
static/js/FormulaEditor.js 962.55 kB 0%
static/js/ManageRules.js 46.98 kB 0%
static/js/PayeeRuleCountLabel.js 7.33 kB 0%
static/js/ReportRouter.js 1.26 MB 0%
static/js/ScheduleEditForm.js 146.44 kB 0%
static/js/SchedulesTable.js 202.7 kB 0%
static/js/TransactionEdit.js 90.63 kB 0%
static/js/TransactionList.js 85.81 kB 0%
static/js/Value.js 5.08 MB 0%
static/js/_baseIsEqual.js 98.38 kB 0%
static/js/ca.js 186.75 kB 0%
static/js/client.js 451.37 kB 0%
static/js/da.js 101.15 kB 0%
static/js/de.js 170.77 kB 0%
static/js/en-GB.js 9.25 kB 0%
static/js/en.js 198.48 kB 0%
static/js/es.js 178.68 kB 0%
static/js/fr.js 178.57 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 165 kB 0%
static/js/narrow.js 364.2 kB 0%
static/js/nb-NO.js 148.05 kB 0%
static/js/nl.js 106.28 kB 0%
static/js/pt-BR.js 188.43 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 174.48 kB 0%
static/js/theme.js 31.88 kB 0%
static/js/toString.js 705.14 kB 0%
static/js/uk.js 207.46 kB 0%
static/js/useFormatList.js 2.52 kB 0%
static/js/useTransactionBatchActions.js 9.71 kB 0%
static/js/wide.js 297.21 kB 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 117.01 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 5.34 MB → 5.34 MB (+771 B) +0.01%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts 📈 +733 B (+28.04%) 2.55 kB → 3.27 kB
home/runner/work/actual/actual/packages/loot-core/src/server/api.ts 📈 +38 B (+0.16%) 23.49 kB → 23.52 kB
View detailed bundle breakdown

Added

Asset File Size % Changed
kcab.worker.B_yYPCGv.js 0 B → 5.34 MB (+5.34 MB) -

Removed

Asset File Size % Changed
kcab.worker._bwMMgjb.js 5.34 MB → 0 B (-5.34 MB) -100%

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged
No assets were unchanged


api

Total

Files count Total bundle size % Changed
2 3.97 MB → 3.97 MB (+762 B) +0.02%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts 📈 +724 B (+28.05%) 2.52 kB → 3.23 kB
home/runner/work/actual/actual/packages/loot-core/src/server/api.ts 📈 +38 B (+0.16%) 22.87 kB → 22.9 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
index.js 3.97 MB → 3.97 MB (+762 B) +0.02%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
models.js 0 B 0%

cli

Total

Files count Total bundle size % Changed
1 7.97 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
cli.js 7.97 MB 0%

crdt

Total

Files count Total bundle size % Changed
1 11.12 kB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
index.js 11.12 kB 0%

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/8026 **Author:** [@MatissJanis](https://github.com/MatissJanis) **Created:** 6/1/2026 **Status:** ✅ Merged **Merged:** 6/2/2026 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `claude/api-version-check-messaging-uqI4b` --- ### 📝 Commits (7) - [`59cf791`](https://github.com/actualbudget/actual/commit/59cf79134b9d330f7ab70fbabe65bb826d39fad5) [AI] Improve messaging for API version/schema mismatch errors - [`ffe0ef1`](https://github.com/actualbudget/actual/commit/ffe0ef12316c8b2effbec4b08b05fb8b90939912) [AI] Set release note author to MatissJanis - [`3090146`](https://github.com/actualbudget/actual/commit/309014636ea48a4c34e5e0118d75dfc15400894a) Add release notes for PR #8026 - [`db1d10c`](https://github.com/actualbudget/actual/commit/db1d10c8727286cd60b594a97f6f051b4aac5cef) [AI] Address review: use Vitest globals and remove duplicate release note - [`7e32cda`](https://github.com/actualbudget/actual/commit/7e32cda75224941f4f79e5667652fc5973b8ede3) [AI] Avoid i18n in loot-core for schema-mismatch message - [`458f371`](https://github.com/actualbudget/actual/commit/458f3712ad9b1b95638907e5685f1397aa54c34e) [AI] Remove unnecessary code comments - [`df7d608`](https://github.com/actualbudget/actual/commit/df7d608233fd1f6fb8232064198a3285382a7129) [AI] Add missing-meta test for getDownloadError ### 📊 Changes **4 files changed** (+99 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `packages/loot-core/src/server/api.ts` (+4 -2) ➕ `packages/loot-core/src/shared/errors.test.ts` (+63 -0) 📝 `packages/loot-core/src/shared/errors.ts` (+26 -1) ➕ `upcoming-release-notes/8026.md` (+6 -0) </details> ### 📄 Description <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://actualbudget.org/docs/contributing/#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description <!-- What does this PR do? Why is it needed? Please give context on the "why?": why do we need this change? What problem is it solving for you?--> Improving the error message people get when the schema mismatches when using the API. To hopefully reduce the amount of support questions about this. ## Related issue(s) <!-- e.g. Fixes #123, Relates to #456 --> N/A ## Testing <!-- What did you test? How can we reproduce the issue you are fixing or how can we test the feature you built? --> Unit tests added ## Checklist - [x] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- actual-bot-sections ---> <hr /> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 37 | 14.03 MB → 14.03 MB (+724 B) | +0.00% loot-core | 1 | 5.34 MB → 5.34 MB (+771 B) | +0.01% api | 2 | 3.97 MB → 3.97 MB (+762 B) | +0.02% cli | 1 | 7.97 MB | 0% crdt | 1 | 11.12 kB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 37 | 14.03 MB → 14.03 MB (+724 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts` | 📈 +724 B (+14.26%) | 4.96 kB → 5.67 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- static/js/extends.js | 500.96 kB → 501.67 kB (+724 B) | +0.14% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 1.54 MB | 0% static/js/BackgroundImage.js | 121.09 kB | 0% static/js/FormulaEditor.js | 962.55 kB | 0% static/js/ManageRules.js | 46.98 kB | 0% static/js/PayeeRuleCountLabel.js | 7.33 kB | 0% static/js/ReportRouter.js | 1.26 MB | 0% static/js/ScheduleEditForm.js | 146.44 kB | 0% static/js/SchedulesTable.js | 202.7 kB | 0% static/js/TransactionEdit.js | 90.63 kB | 0% static/js/TransactionList.js | 85.81 kB | 0% static/js/Value.js | 5.08 MB | 0% static/js/_baseIsEqual.js | 98.38 kB | 0% static/js/ca.js | 186.75 kB | 0% static/js/client.js | 451.37 kB | 0% static/js/da.js | 101.15 kB | 0% static/js/de.js | 170.77 kB | 0% static/js/en-GB.js | 9.25 kB | 0% static/js/en.js | 198.48 kB | 0% static/js/es.js | 178.68 kB | 0% static/js/fr.js | 178.57 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 165 kB | 0% static/js/narrow.js | 364.2 kB | 0% static/js/nb-NO.js | 148.05 kB | 0% static/js/nl.js | 106.28 kB | 0% static/js/pt-BR.js | 188.43 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 174.48 kB | 0% static/js/theme.js | 31.88 kB | 0% static/js/toString.js | 705.14 kB | 0% static/js/uk.js | 207.46 kB | 0% static/js/useFormatList.js | 2.52 kB | 0% static/js/useTransactionBatchActions.js | 9.71 kB | 0% static/js/wide.js | 297.21 kB | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 117.01 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 5.34 MB → 5.34 MB (+771 B) | +0.01% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts` | 📈 +733 B (+28.04%) | 2.55 kB → 3.27 kB `home/runner/work/actual/actual/packages/loot-core/src/server/api.ts` | 📈 +38 B (+0.16%) | 23.49 kB → 23.52 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.B_yYPCGv.js | 0 B → 5.34 MB (+5.34 MB) | - **Removed** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker._bwMMgjb.js | 5.34 MB → 0 B (-5.34 MB) | -100% **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** No assets were unchanged </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 2 | 3.97 MB → 3.97 MB (+762 B) | +0.02% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/shared/errors.ts` | 📈 +724 B (+28.05%) | 2.52 kB → 3.23 kB `home/runner/work/actual/actual/packages/loot-core/src/server/api.ts` | 📈 +38 B (+0.16%) | 22.87 kB → 22.9 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.97 MB → 3.97 MB (+762 B) | +0.02% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- models.js | 0 B | 0% </div> </details> --- #### cli **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 7.97 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- cli.js | 7.97 MB | 0% </div> </details> --- #### crdt **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 11.12 kB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- index.js | 11.12 kB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-06-17 21:05:57 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#136357