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

Add more logging for GoCardless rate limit information #3895

Merged
merged 3 commits into from
Dec 6, 2024

Conversation

matt-fidd
Copy link
Contributor

@matt-fidd matt-fidd commented Nov 25, 2024

Adds a little more information to the error printed in the console when the GoCardless rate limit is reached. I'd love to work this into the UI at some point but this is an improvement.

Complimentary server PR: actualbudget/actual-server#509

Fixes actualbudget/actual-server#488

@actual-github-bot actual-github-bot bot changed the title Add more logging for GoCardless rate limit information [WIP] Add more logging for GoCardless rate limit information Nov 25, 2024
Copy link

netlify bot commented Nov 25, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 7e3963a
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6744d627a7f8d60008e03389
😎 Deploy Preview https://deploy-preview-3895.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 Nov 25, 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.45 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/workbox-window.prod.es5.js 5.69 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.68 kB 0%
static/js/narrow.js 82.93 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/wide.js 241.19 kB 0%
static/js/ReportRouter.js 1.52 MB 0%
static/js/index.js 3.44 MB 0%

Copy link
Contributor

github-actions bot commented Nov 25, 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 (+59 B) +0.00%
Changeset
File Δ Size
packages/loot-core/src/server/accounts/sync.ts 📈 +133 B (+0.51%) 25.63 kB → 25.76 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 (+59 B) +0.00%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@matt-fidd matt-fidd changed the title [WIP] Add more logging for GoCardless rate limit information Add more logging for GoCardless rate limit information Nov 25, 2024
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

The pull request introduces changes to the BankSyncError function in the sync.ts file, adding an optional details parameter to enhance error handling capabilities. This modification allows for additional error information to be included when a BankSyncError is thrown. In the downloadGoCardlessTransactions function, the error handling logic has been updated to incorporate rateLimitHeaders into the error details, providing more context during error occurrences. While the overall control flow of the downloadGoCardlessTransactions function remains unchanged, the error handling now captures and transmits more detailed information, which could aid in debugging and logging processes. The downloadSimpleFinTransactions function has not been altered and retains its original error handling structure, indicating that the changes are specific to the downloadGoCardlessTransactions function and the BankSyncError function. The overall structure and responsibilities of the functions remain intact, with the focus solely on improving the error reporting mechanism.

Possibly related PRs

Suggested labels

::sparkles: Merged

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.


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 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

🧹 Outside diff range and nitpick comments (3)
packages/loot-core/src/server/accounts/sync.ts (3)

35-36: Consider using a more specific type for details parameter.

The addition of the optional details parameter is a good improvement for error context. However, consider using a more specific type instead of the generic object to better document the expected structure.

-function BankSyncError(type: string, code: string, details?: object) {
+type ErrorDetails = {
+  rateLimitHeaders?: Record<string, string>;
+  // Add other potential detail fields here
+};
+function BankSyncError(type: string, code: string, details?: ErrorDetails) {

155-159: Consider adding debug logging for rate limit headers.

The addition of rate limit headers to error details is good. To further improve debugging capabilities, consider adding debug logging for the rate limit headers when they are present.

     const errorDetails = {
       rateLimitHeaders: res.rateLimitHeaders,
     };
 
+    if (res.rateLimitHeaders) {
+      console.log('GoCardless rate limit headers:', res.rateLimitHeaders);
+    }
+
     throw BankSyncError(res.error_type, res.error_code, errorDetails);

Line range hint 211-211: Consider consistent error handling across sync providers.

The SimpleFin error handling doesn't include the details parameter in the BankSyncError call. For consistency, consider adding error details support for SimpleFin as well.

-    throw BankSyncError(res.error_type, res.error_code);
+    const errorDetails = {
+      // Add relevant SimpleFin error details here
+    };
+    throw BankSyncError(res.error_type, res.error_code, errorDetails);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c25e3d4 and 7e3963a.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3895.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/server/accounts/sync.ts (2 hunks)

@matt-fidd matt-fidd merged commit 3ce7ae9 into actualbudget:master Dec 6, 2024
20 checks passed
@fira42073
Copy link

thanks!

@matt-fidd matt-fidd deleted the gocardless-rate-limit branch December 16, 2024 21:23
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.

[Bug]: No way of knowing when rate limit will be lifted
3 participants