[PR #8123] [CLOSED] [WIP] fix(schedules): escape $ in schedule names before AQL filter queries #136424

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

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/8123
Author: @64johnlee
Created: 6/7/2026
Status: Closed

Base: masterHead: fix/aql-dollar-sign-schedule-name-7358


📝 Commits (2)

  • 2a0a61e fix(schedules): escape $ in schedule names before AQL filter queries
  • 25199e2 [autofix.ci] apply automated fixes

📊 Changes

4 files changed (+25 additions, -4 deletions)

View changed files

📝 packages/desktop-client/src/components/mobile/schedules/MobileScheduleEditPage.tsx (+3 -1)
📝 packages/desktop-client/src/components/schedules/ScheduleEditModal.tsx (+3 -1)
📝 packages/loot-core/src/server/api.ts (+8 -2)
📝 packages/loot-core/src/server/aql/compiler.test.ts (+11 -0)

📄 Description

Summary

Saving a schedule whose name starts with $ (e.g. $Rent) always failed with a generic error. AQL's compileExpr treats any string value beginning with $ as a field reference ($fieldName syntax). When the schedule name was passed directly to .filter({ name: state.fields.name }), AQL tried to resolve $Rent as a field, threw CompileError: Field does not exist, and the UI caught it as a save error.

AQL already has an escape convention: \$ in a string value is compiled as a literal $ (handled in compileLiteral). The fix applies this escaping at the three call sites that pass user-supplied names to AQL filters.

Closes #7358

Changes

  • packages/desktop-client/src/components/schedules/ScheduleEditModal.tsx — escape $ in name before duplicate-name AQL query
  • packages/desktop-client/src/components/mobile/schedules/MobileScheduleEditPage.tsx — same fix for mobile path
  • packages/loot-core/src/server/api.ts — same fix in api/update-schedule and api/get-id-by-name handlers
  • packages/loot-core/src/server/aql/compiler.test.ts — add test documenting that \$-escaped strings compile to literal SQL values

Test plan

  • yarn workspace @actual-app/loot-core test passes (28/28 in compiler.test.ts)
  • Create a schedule named $Rent — saves successfully
  • Duplicate-name check still works: creating a second $Rent shows "already exists" error
  • Schedules without $ are unaffected

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 37 14.13 MB → 14.13 MB (+44 B) +0.00%
loot-core 1 5.28 MB → 5.28 MB (+50 B) +0.00%
api 2 3.87 MB → 3.87 MB (+50 B) +0.00%
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.13 MB → 14.13 MB (+44 B) +0.00%
Changeset
File Δ Size
src/components/schedules/ScheduleEditModal.tsx 📈 +22 B (+0.40%) 5.33 kB → 5.35 kB
src/components/mobile/schedules/MobileScheduleEditPage.tsx 📈 +22 B (+0.37%) 5.74 kB → 5.77 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 1.6 MB → 1.6 MB (+22 B) +0.00%
static/js/narrow.js 365.05 kB → 365.07 kB (+22 B) +0.01%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/BackgroundImage.js 121.09 kB 0%
static/js/FormulaEditor.js 962.55 kB 0%
static/js/ManageRules.js 46.63 kB 0%
static/js/PayeeRuleCountLabel.js 7.33 kB 0%
static/js/ReportRouter.js 1.27 MB 0%
static/js/ScheduleEditForm.js 146.57 kB 0%
static/js/SchedulesTable.js 206.26 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 185.63 kB 0%
static/js/client.js 451.37 kB 0%
static/js/da.js 100.19 kB 0%
static/js/de.js 172.1 kB 0%
static/js/en-GB.js 9.25 kB 0%
static/js/en.js 201.61 kB 0%
static/js/es.js 177.58 kB 0%
static/js/extends.js 508.79 kB 0%
static/js/fr.js 177.35 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 163.93 kB 0%
static/js/nb-NO.js 147.07 kB 0%
static/js/nl.js 119.71 kB 0%
static/js/pt-BR.js 187.34 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 173.33 kB 0%
static/js/theme.js 31.88 kB 0%
static/js/toString.js 705.14 kB 0%
static/js/uk.js 216.7 kB 0%
static/js/useFormatList.js 2.52 kB 0%
static/js/useTransactionBatchActions.js 9.71 kB 0%
static/js/wide.js 298.88 kB 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 116.44 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 5.28 MB → 5.28 MB (+50 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/api.ts 📈 +50 B (+0.21%) 23.53 kB → 23.57 kB
View detailed bundle breakdown

Added

Asset File Size % Changed
kcab.worker.45RO-vbj.js 0 B → 5.28 MB (+5.28 MB) -

Removed

Asset File Size % Changed
kcab.worker.lfNBY2TT.js 5.28 MB → 0 B (-5.28 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.87 MB → 3.87 MB (+50 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/api.ts 📈 +50 B (+0.21%) 22.9 kB → 22.95 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
index.js 3.87 MB → 3.87 MB (+50 B) +0.00%

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/8123 **Author:** [@64johnlee](https://github.com/64johnlee) **Created:** 6/7/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `fix/aql-dollar-sign-schedule-name-7358` --- ### 📝 Commits (2) - [`2a0a61e`](https://github.com/actualbudget/actual/commit/2a0a61eaaf71fa9eb83c901f919befb18d8425c0) fix(schedules): escape $ in schedule names before AQL filter queries - [`25199e2`](https://github.com/actualbudget/actual/commit/25199e23d4984bd7ee4253c7d29df1ac6153a3c9) [autofix.ci] apply automated fixes ### 📊 Changes **4 files changed** (+25 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `packages/desktop-client/src/components/mobile/schedules/MobileScheduleEditPage.tsx` (+3 -1) 📝 `packages/desktop-client/src/components/schedules/ScheduleEditModal.tsx` (+3 -1) 📝 `packages/loot-core/src/server/api.ts` (+8 -2) 📝 `packages/loot-core/src/server/aql/compiler.test.ts` (+11 -0) </details> ### 📄 Description ## Summary Saving a schedule whose name starts with `$` (e.g. `$Rent`) always failed with a generic error. AQL's `compileExpr` treats any string value beginning with `$` as a field reference (`$fieldName` syntax). When the schedule name was passed directly to `.filter({ name: state.fields.name })`, AQL tried to resolve `$Rent` as a field, threw `CompileError: Field does not exist`, and the UI caught it as a save error. AQL already has an escape convention: `\$` in a string value is compiled as a literal `$` (handled in `compileLiteral`). The fix applies this escaping at the three call sites that pass user-supplied names to AQL filters. Closes #7358 ## Changes - `packages/desktop-client/src/components/schedules/ScheduleEditModal.tsx` — escape `$` in name before duplicate-name AQL query - `packages/desktop-client/src/components/mobile/schedules/MobileScheduleEditPage.tsx` — same fix for mobile path - `packages/loot-core/src/server/api.ts` — same fix in `api/update-schedule` and `api/get-id-by-name` handlers - `packages/loot-core/src/server/aql/compiler.test.ts` — add test documenting that `\$`-escaped strings compile to literal SQL values ## Test plan - [ ] `yarn workspace @actual-app/loot-core test` passes (28/28 in `compiler.test.ts`) - [ ] Create a schedule named `$Rent` — saves successfully - [ ] Duplicate-name check still works: creating a second `$Rent` shows "already exists" error - [ ] Schedules without `$` are unaffected <!--- actual-bot-sections ---> <hr /> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 37 | 14.13 MB → 14.13 MB (+44 B) | +0.00% loot-core | 1 | 5.28 MB → 5.28 MB (+50 B) | +0.00% api | 2 | 3.87 MB → 3.87 MB (+50 B) | +0.00% 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.13 MB → 14.13 MB (+44 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `src/components/schedules/ScheduleEditModal.tsx` | 📈 +22 B (+0.40%) | 5.33 kB → 5.35 kB `src/components/mobile/schedules/MobileScheduleEditPage.tsx` | 📈 +22 B (+0.37%) | 5.74 kB → 5.77 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/index.js | 1.6 MB → 1.6 MB (+22 B) | +0.00% static/js/narrow.js | 365.05 kB → 365.07 kB (+22 B) | +0.01% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/BackgroundImage.js | 121.09 kB | 0% static/js/FormulaEditor.js | 962.55 kB | 0% static/js/ManageRules.js | 46.63 kB | 0% static/js/PayeeRuleCountLabel.js | 7.33 kB | 0% static/js/ReportRouter.js | 1.27 MB | 0% static/js/ScheduleEditForm.js | 146.57 kB | 0% static/js/SchedulesTable.js | 206.26 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 | 185.63 kB | 0% static/js/client.js | 451.37 kB | 0% static/js/da.js | 100.19 kB | 0% static/js/de.js | 172.1 kB | 0% static/js/en-GB.js | 9.25 kB | 0% static/js/en.js | 201.61 kB | 0% static/js/es.js | 177.58 kB | 0% static/js/extends.js | 508.79 kB | 0% static/js/fr.js | 177.35 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 163.93 kB | 0% static/js/nb-NO.js | 147.07 kB | 0% static/js/nl.js | 119.71 kB | 0% static/js/pt-BR.js | 187.34 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 173.33 kB | 0% static/js/theme.js | 31.88 kB | 0% static/js/toString.js | 705.14 kB | 0% static/js/uk.js | 216.7 kB | 0% static/js/useFormatList.js | 2.52 kB | 0% static/js/useTransactionBatchActions.js | 9.71 kB | 0% static/js/wide.js | 298.88 kB | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 116.44 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 5.28 MB → 5.28 MB (+50 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/api.ts` | 📈 +50 B (+0.21%) | 23.53 kB → 23.57 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.45RO-vbj.js | 0 B → 5.28 MB (+5.28 MB) | - **Removed** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.lfNBY2TT.js | 5.28 MB → 0 B (-5.28 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.87 MB → 3.87 MB (+50 B) | +0.00% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/api.ts` | 📈 +50 B (+0.21%) | 22.9 kB → 22.95 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.87 MB → 3.87 MB (+50 B) | +0.00% **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:11:09 -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#136424