[PR #8037] [MERGED] [AI] fix(api): prevent navigator crash when loading @actual-app/api in Node.js #122287

Closed
opened 2026-06-11 21:04:35 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

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

Base: masterHead: master


📝 Commits (4)

  • e9cb86e [AI] fix(api): prevent navigator crash when loading @actual-app/api in Node.js
  • 33a43ae Add release note
  • 5027448 Update upcoming-release-notes/8037.md
  • df275a5 Delete packages/api/platform.test.ts

📊 Changes

2 files changed (+7 additions, -2 deletions)

View changed files

📝 packages/loot-core/src/shared/months.ts (+1 -2)
upcoming-release-notes/8037.md (+6 -0)

📄 Description

Description

I use lunchflow/actual-flow for importing certain transactions into Actual Budget. I was trying to update the @actual-app/api package in actual-flow to 26.6.0, but I ran into a ReferenceError. I had Claude investigate the issue and write a test replicating it, which fails without the fix. Below is Claude's commit message with the changes:

Problem

@actual-app/api 26.5.0 and 26.6.0 throw "ReferenceError: navigator is not defined" on import in Node.js environments. The loot-core shared bundle includes three platform variants:

platform.ts – browser (references navigator at module load time)
platform.electron.ts – Electron/desktop (uses Node.js os module)
platform.api.ts – Node.js API (safe constants only)

The API vite build uses resolve: { conditions: ['api'] } to pick the right variant via the loot-core package imports map (#shared/platform). However, months.ts was importing via a bare relative path (./platform) instead of the imports-map alias (#shared/platform). Vite's conditions-based resolution does not apply to relative imports, so the build fell back to platform.ts (the browser variant), bundling navigator references that crash at load time.

Fix

Change months.ts to import #shared/platform instead of ./platform. This goes through the loot-core package imports map, which the vite api condition resolves to platform.api.ts — the Node.js-safe variant.

platform.api.ts was already added to the repo alongside this condition infrastructure (in the same 26.6.0 release) but the months.ts import was missed, leaving the crash in the published package.

Testing

Added packages/api/platform.test.ts, which imports @actual-app/core/shared/ platform under the api vite condition and asserts that isBrowser, isPlaywright and isIOSAgent are all false. This test:

  • Fails if platform.api.ts is deleted (module not found)
  • Fails if platform.api.ts is modified to reference navigator (ReferenceError)
  • Fails if the api vite condition is removed, falling back to platform.ts which throws ReferenceError at import time in Node.js

Verified by Kyle Slattery against a live Actual Budget instance via the actual-flow integration tool (https://github.com/lunchflow/actual-flow).

Testing

When upgrading and trying to run actual-flow, I encountered the exception. After this change, I rebuilt actual-flow, and it worked. I had Claude write a regression test that failed, and then had it fix it.

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 0%
loot-core 1 5.34 MB 0%
api 2 3.97 MB → 3.93 MB (-42.32 kB) -1.04%
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 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
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.99 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/extends.js 501.67 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 107.12 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 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
kcab.worker.B_yYPCGv.js 5.34 MB 0%

api

Total

Files count Total bundle size % Changed
2 3.97 MB → 3.93 MB (-42.32 kB) -1.04%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/months.ts 📉 -21 B (-0.40%) 5.08 kB → 5.06 kB
node_modules/ua-parser-js/src/main/ua-parser.mjs 🔥 -41.87 kB (-100%) 41.87 kB → 0 B
home/runner/work/actual/actual/packages/loot-core/src/shared/platform.ts 🔥 -431 B (-100%) 431 B → 0 B
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller

Asset File Size % Changed
index.js 3.97 MB → 3.93 MB (-42.32 kB) -1.04%

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/8037 **Author:** [@kyleslattery](https://github.com/kyleslattery) **Created:** 6/2/2026 **Status:** ✅ Merged **Merged:** 6/2/2026 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (4) - [`e9cb86e`](https://github.com/actualbudget/actual/commit/e9cb86e9e228424420bc4030db1f2d3b77c8793d) [AI] fix(api): prevent navigator crash when loading @actual-app/api in Node.js - [`33a43ae`](https://github.com/actualbudget/actual/commit/33a43aea0bdbf1b5f28fc4f5cdf915200b0d0c20) Add release note - [`5027448`](https://github.com/actualbudget/actual/commit/502744822b3fdaae250de6358b7743da52175ce2) Update upcoming-release-notes/8037.md - [`df275a5`](https://github.com/actualbudget/actual/commit/df275a5505db633d26d3081cc84c4cd13d561361) Delete packages/api/platform.test.ts ### 📊 Changes **2 files changed** (+7 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `packages/loot-core/src/shared/months.ts` (+1 -2) ➕ `upcoming-release-notes/8037.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 I use [lunchflow/actual-flow](https://github.com/lunchflow/actual-flow/) for importing certain transactions into Actual Budget. I was trying to update the @actual-app/api package in actual-flow to 26.6.0, but I ran into a ReferenceError. I had Claude investigate the issue and write a test replicating it, which fails without the fix. Below is Claude's commit message with the changes: ### Problem @actual-app/api 26.5.0 and 26.6.0 throw "ReferenceError: navigator is not defined" on import in Node.js environments. The loot-core shared bundle includes three platform variants: platform.ts – browser (references navigator at module load time) platform.electron.ts – Electron/desktop (uses Node.js os module) platform.api.ts – Node.js API (safe constants only) The API vite build uses `resolve: { conditions: ['api'] }` to pick the right variant via the loot-core package imports map (#shared/platform). However, months.ts was importing via a bare relative path (`./platform`) instead of the imports-map alias (`#shared/platform`). Vite's conditions-based resolution does not apply to relative imports, so the build fell back to platform.ts (the browser variant), bundling navigator references that crash at load time. ### Fix Change months.ts to import `#shared/platform` instead of `./platform`. This goes through the loot-core package imports map, which the vite `api` condition resolves to platform.api.ts — the Node.js-safe variant. platform.api.ts was already added to the repo alongside this condition infrastructure (in the same 26.6.0 release) but the months.ts import was missed, leaving the crash in the published package. ### Testing Added packages/api/platform.test.ts, which imports @actual-app/core/shared/ platform under the `api` vite condition and asserts that isBrowser, isPlaywright and isIOSAgent are all false. This test: - Fails if platform.api.ts is deleted (module not found) - Fails if platform.api.ts is modified to reference navigator (ReferenceError) - Fails if the api vite condition is removed, falling back to platform.ts which throws ReferenceError at import time in Node.js Verified by Kyle Slattery against a live Actual Budget instance via the actual-flow integration tool (https://github.com/lunchflow/actual-flow). ## Testing When upgrading and trying to run actual-flow, I encountered the exception. After this change, I rebuilt actual-flow, and it worked. I had Claude write a regression test that failed, and then had it fix it. ## 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 ---> <hr /> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 37 | 14.03 MB | 0% loot-core | 1 | 5.34 MB | 0% api | 2 | 3.97 MB → 3.93 MB (-42.32 kB) | -1.04% 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 | 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 ----- | --------- | --------- 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.99 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/extends.js | 501.67 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 | 107.12 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 | 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 ----- | --------- | --------- kcab.worker.B_yYPCGv.js | 5.34 MB | 0% </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 2 | 3.97 MB → 3.93 MB (-42.32 kB) | -1.04% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/shared/months.ts` | 📉 -21 B (-0.40%) | 5.08 kB → 5.06 kB `node_modules/ua-parser-js/src/main/ua-parser.mjs` | 🔥 -41.87 kB (-100%) | 41.87 kB → 0 B `home/runner/work/actual/actual/packages/loot-core/src/shared/platform.ts` | 🔥 -431 B (-100%) | 431 B → 0 B </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.97 MB → 3.93 MB (-42.32 kB) | -1.04% **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-11 21:04:35 -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#122287