fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync #4241

NullScope · 2025-01-25T15:34:01Z

Some bank accounts have no transactionId in GoCardless, meaning that any changes (e.g setting to 0 for duplicated transactions) to any such imported transaction will cause Actual to re-import the transaction instead of updating or ignoring it.

GoCardless has an internalTransactionId for cases like these as described here: https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529646897820-internalTransactionId-a-unique-transaction-ID-now-generated-by-GoCardless

There are some caveats though:

It does NOT exist in pending transactions
It is ONLY guaranteed to be unique inside the same bank account

As such, this PR falls back to {acctId}-{internalTransactionId} in case transactionId does not exist AND the transaction has been cleared.

Fixes #2495

netlify · 2025-01-25T15:34:19Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`aa69af4`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67a0b17bdbb5e50008914e51
😎 Deploy Preview	https://deploy-preview-4241.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2025-01-25T15:35:19Z

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
15	6.71 MB → 6.71 MB (-101 B)	-0.00%

Changeset

File	Δ	Size
`node_modules/clsx/dist/clsx.mjs`	🆕 +368 B	0 B → 368 B
`node_modules/clsx/dist/clsx.mjs?commonjs-proxy`	🆕 +64 B	0 B → 64 B
`node_modules/react-grid-layout/build/components/WidthProvider.js`	📈 +1 B (+0.02%)	5.22 kB → 5.22 kB
`node_modules/react-grid-layout/build/GridItem.js`	📈 +1 B (+0.00%)	21.49 kB → 21.49 kB
`node_modules/react-grid-layout/build/ReactGridLayout.js`	📈 +1 B (+0.00%)	24.96 kB → 24.96 kB
`node_modules/clsx/dist/clsx.js`	🔥 -509 B (-100%)	509 B → 0 B
`node_modules/clsx/dist/clsx.js?commonjs-module`	🔥 -27 B (-100%)	27 B → 0 B

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/ReportRouter.js	1.59 MB → 1.59 MB (+67 B)	+0.00%

Smaller

Asset	File Size	% Changed
static/js/index.js	4.29 MB → 4.29 MB (-168 B)	-0.00%

Unchanged

Asset	File Size	% Changed
static/js/en-GB.js	99.33 kB	0%
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/nl.js	83.87 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/pt-BR.js	103.29 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/uk.js	111.11 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/en.js	99.34 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/narrow.js	84.94 kB	0%
static/js/wide.js	102.8 kB	0%

github-actions · 2025-01-25T15:35:20Z

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
1	1.33 MB → 1.33 MB (+108 B)	+0.01%

Changeset

File	Δ	Size
`packages/loot-core/src/server/accounts/sync.ts`	📈 +197 B (+0.73%)	26.19 kB → 26.39 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
kcab.worker.js	1.33 MB → 1.33 MB (+108 B)	+0.01%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

coderabbitai · 2025-01-25T18:06:56Z

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

/usr/local/bin/yarn: 3: dirname: not found
/usr/local/bin/yarn: 7: dirname: not found
node:internal/modules/cjs/loader:1251
throw err;
^

Error: Cannot find module '/yarn.js'
at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
at Module._load (node:internal/modules/cjs/loader:1074:27)
at TracingChannel.traceSync (node:diagnostics_channel:315:14)
at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:166:5)
at node:internal/main/run_main_module:30:49 {
code: 'MODULE_NOT_FOUND',
requireStack: []
}

Node.js v22.9.0

Walkthrough

The pull request introduces a modification to the normalizeBankSyncTransactions function in the packages/loot-core/src/server/accounts/sync.ts file. The change focuses on how the imported_id is assigned for bank-synced transactions. Previously, the function directly assigned trans.transactionId to imported_id. The updated logic now conditionally sets imported_id based on two criteria: if the transaction is marked as cleared and lacks a transactionId, it generates a unique identifier by concatenating trans.account and trans.internalTransactionId.

Assessment against linked issues

Objective	Addressed	Explanation
Identify Missing Transaction [#2495]	✅
Handle Transactions without TransactionId	✅
Ensure Correct Transaction Sync	❓	Requires further verification in the specific GoCardless use case

Possibly related PRs

update synced account balance in db if available #3452: Modifies the same sync.ts file with transaction handling changes.
Fix issue where the UI is stuck sync'ing if no data from server #3941: Introduces error handling in the synchronization process, which could interact with the logic of how transactions are normalized and identified.

Suggested labels

merged, bug-fix, transaction-sync

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ec16c99 and 5eda09e.

📒 Files selected for processing (1)

packages/loot-core/src/server/accounts/sync.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/loot-core/src/server/accounts/sync.ts

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: Analyze
GitHub Check: build (macos-latest)
GitHub Check: Wait for Netlify build to finish
GitHub Check: build (windows-latest)
GitHub Check: build (ubuntu-latest)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

psybers · 2025-01-25T18:35:49Z

I don't know GoCardless or the code for that sync, but I wonder about this documentation note: "if the key internalTransactionId is absent from the transactions output, it means it has not been rolled out for that institution yet."

So it is possible a transaction might be missing both the bank's ID and GC's ID (even for cleared txn). In that case, your code would generate an ID of "account-" which would lead to every transaction being "duplicates". Probably should handle that edge case and fall back to not setting anything.

This reverts commit ec16c99.

NullScope · 2025-01-25T18:43:38Z

I don't know GoCardless or the code for that sync, but I wonder about this documentation note: "if the key internalTransactionId is absent from the transactions output, it means it has not been rolled out for that institution yet."

So it is possible a transaction might be missing both the bank's ID and GC's ID (even for cleared txn). In that case, your code would generate an ID of "account-" which would lead to every transaction being "duplicates". Probably should handle that edge case and fall back to not setting anything.

Ah true, I'll add that edge case 👍

matt-fidd

LGTM!

Actually, I'll need to check if this breaks deduplication with existing transactions

NullScope · 2025-01-27T17:30:18Z

@matt-fidd if you need any help let me know 👍

matt-fidd

Tested and it all works :)

matt-fidd · 2025-01-29T00:13:54Z

Nice work on this issue, hopefully as time goes on we can move away from using transactionId but it'll take a while to be sure that it's fully supported on GoCardless' side before we do.

NullScope · 2025-01-29T12:31:58Z

Nice work on this issue, hopefully as time goes on we can move away from using transactionId but it'll take a while to be sure that it's fully supported on GoCardless' side before we do.

@matt-fidd thanks! Yeah I felt like this is a good transitional step in the meantime to solve some issues users were facing (including myself)

fix(actualbudget#2495): fixed gocardless import ID

249aab2

actual-github-bot bot added the 🚧 WIP label Jan 25, 2025

NullScope changed the title ~~fix(#2495): fixed gocardless import ID~~ fix(#2495): fixed GoCardless import ID Jan 25, 2025

NullScope changed the title ~~fix(#2495): fixed GoCardless import ID~~ fix(#2495): fixed GoCardless transaction ID Jan 25, 2025

chore: added release note

16aab5c

NullScope changed the title ~~fix(#2495): fixed GoCardless transaction ID~~ fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync Jan 25, 2025

NullScope added 2 commits January 25, 2025 15:45

chore: updated release note

9a0b8b8

refactor: made condition more clear

ec16c99

NullScope marked this pull request as ready for review January 25, 2025 18:02

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Jan 25, 2025

Revert "refactor: made condition more clear"

fcbc906

This reverts commit ec16c99.

fix: added edge case

5eda09e

psybers approved these changes Jan 25, 2025

View reviewed changes

matt-fidd previously approved these changes Jan 27, 2025

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Jan 27, 2025

actual-github-bot bot added 🔍 Ready for review and removed ✅ Approved labels Jan 27, 2025

Merge branch 'master' into fix-gocardless-import-id

bd066de

matt-fidd approved these changes Jan 29, 2025

View reviewed changes

actual-github-bot bot removed the 🔍 Ready for review label Jan 29, 2025

actual-github-bot bot added the ✅ Approved label Jan 29, 2025

Merge branch 'master' into fix-gocardless-import-id

987a413

NullScope added 2 commits January 31, 2025 11:00

Merge branch 'master' into fix-gocardless-import-id

3ff7429

Merge branch 'master' into fix-gocardless-import-id

aa69af4

matt-fidd merged commit bd06342 into actualbudget:master Feb 5, 2025
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Feb 5, 2025

NullScope deleted the fix-gocardless-import-id branch February 5, 2025 23:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync #4241

fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync #4241

NullScope commented Jan 25, 2025 •

edited

Loading

netlify bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

coderabbitai bot commented Jan 25, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

psybers commented Jan 25, 2025

NullScope commented Jan 25, 2025

matt-fidd left a comment

NullScope commented Jan 27, 2025

matt-fidd left a comment

matt-fidd commented Jan 29, 2025

NullScope commented Jan 29, 2025

fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync #4241

fix(#2495): fix GoCardless transaction ID to fallback to it's own generated ID on sync #4241

Conversation

NullScope commented Jan 25, 2025 • edited Loading

netlify bot commented Jan 25, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Jan 25, 2025 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Jan 25, 2025 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Jan 25, 2025 • edited Loading

Walkthrough

Assessment against linked issues

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

psybers commented Jan 25, 2025

NullScope commented Jan 25, 2025

matt-fidd left a comment

Choose a reason for hiding this comment

NullScope commented Jan 27, 2025

matt-fidd left a comment

Choose a reason for hiding this comment

matt-fidd commented Jan 29, 2025

NullScope commented Jan 29, 2025

NullScope commented Jan 25, 2025 •

edited

Loading

netlify bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

coderabbitai bot commented Jan 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)