Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix sync errors when Simplefin account removed #4007

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

greatwitenorth
Copy link

@greatwitenorth greatwitenorth commented Dec 18, 2024

Recently I had to remove and then add again my bank account in the Simplefin admin due to syncing issues on their end. Once I completed this, I tried syncing my accounts before relinking them and the sync just hung, showing the message "Syncing 18 accounts remaining". The console revealed this error:

sync.ts:856 Uncaught (in promise) TypeError: Cannot read properties of undefined (reading 'error_code')
    at gZ (sync.ts:856:18)
    at async _7.simplefin-batch-sync (main.ts:1181:15)
gZ @ sync.ts:856
await in gZ
_7.simplefin-batch-sync @ main.ts:1181
await in _7.simplefin-batch-sync
oZ @ mutators.ts:67

It seems like once there are orphaned accounts in my Actual database which don't exist anymore in Simplefin, that the sync fails completely.

I've added in a check to ensure that download is not empty before proceeding. This seems to resolve the issue.

Note, this also surfaced another issue with Simplefin where if there was a single missing account, it would return all accounts as missing. This has been reported to them and resolved.

Copy link

netlify bot commented Dec 18, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit d21e590
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6763248fd69f740008531933
😎 Deploy Preview https://deploy-preview-4007.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

github-actions bot commented Dec 18, 2024

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
10 5.53 MB 0%

Changeset

No files were changed

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/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 83.36 kB 0%
static/js/wide.js 161.25 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/TransactionList.js 102.91 kB 0%
static/js/ReportRouter.js 1.58 MB 0%
static/js/index.js 3.45 MB 0%

Copy link
Contributor

github-actions bot commented Dec 18, 2024

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.32 MB → 1.32 MB (+7 B) +0.00%
Changeset
File Δ Size
packages/loot-core/src/server/accounts/sync.ts 📈 +57 B (+0.21%) 26.1 kB → 26.15 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
kcab.worker.js 1.32 MB → 1.32 MB (+7 B) +0.00%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@greatwitenorth greatwitenorth changed the title [WIP] Fix sync errors when Simplefin account removed Fix sync errors when Simplefin account removed Dec 18, 2024
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

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.

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

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request modifies the SimpleFinBatchSync function in the packages/loot-core/src/server/accounts/sync.ts file by adding a conditional check to prevent processing accounts when the download response is invalid. Specifically, a new guard clause is introduced to skip processing if the download variable is falsy (undefined, null, or false). This change aims to improve error handling by ensuring that the function only proceeds with account synchronization when a valid download response is available. The core logic of the function remains unchanged, maintaining the existing approach for handling successful downloads and potential errors.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • UnderKoen
  • youngcw
  • matt-fidd

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/loot-core/src/server/accounts/sync.ts (1)

866-869: Consider adding debug logging for skipped accounts.

To improve observability, consider logging when accounts are skipped due to undefined downloads.

    if (!download) {
+     console.log(`Skipping sync for account ${account.id}: No download data available`);
      continue;
    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 11bde73 and 863095d.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4007.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/server/accounts/sync.ts (1 hunks)
🧰 Additional context used
📓 Learnings (2)
📓 Common learnings
Learnt from: matt-fidd
PR: actualbudget/actual#3581
File: packages/loot-core/src/client/actions/account.ts:180-194
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In `packages/loot-core/src/client/actions/account.ts`, within the `syncAccounts` function, the batch sync request for SimpleFin accounts handles errors by returning error objects instead of throwing exceptions. Therefore, wrapping this block in a try-catch is unnecessary.
packages/loot-core/src/server/accounts/sync.ts (1)
Learnt from: matt-fidd
PR: actualbudget/actual#3581
File: packages/loot-core/src/client/actions/account.ts:180-194
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In `packages/loot-core/src/client/actions/account.ts`, within the `syncAccounts` function, the batch sync request for SimpleFin accounts handles errors by returning error objects instead of throwing exceptions. Therefore, wrapping this block in a try-catch is unnecessary.
🔇 Additional comments (1)
packages/loot-core/src/server/accounts/sync.ts (1)

866-869: LGTM! Guard clause prevents processing undefined downloads.

The addition of this guard clause effectively prevents the sync process from attempting to process undefined downloads, which resolves the sync hanging issue when Simplefin accounts are removed and re-added.

@psybers
Copy link
Contributor

psybers commented Dec 27, 2024

I think this is similar to #3941? Except that one actually displays an error while your solution silently ignores it.

@psybers
Copy link
Contributor

psybers commented Dec 27, 2024

Ok I think the two PRs might handle slightly different edge cases.

But your solution does still just ignore the issue, when it probably makes sense to notify the user via UI error message that something was wrong.

@greatwitenorth
Copy link
Author

Ok I think the two PRs might handle slightly different edge cases.

But your solution does still just ignore the issue, when it probably makes sense to notify the user via UI error message that something was wrong.

Good point! I did notice that all the errors come up at once at the very end as notifications in the bottom right. But I can see if there's a better way to handle the errors while it's checking each account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants