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

Check gocardless bank data type before setting state #3793

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

thraizz
Copy link
Contributor

@thraizz thraizz commented Nov 5, 2024

Hey, thanks for the great work on actual. I had a smaller issue and could fix it myself, so I'm raising this PR.
I had the issue that I deleted my token in GoCardless and then GoCardless would give back an error object instead of an array in the useAvailableBanks hook. This would cause errors down the line, for example when giving this as sugggestions to the Autocomplete component.
Checking if the response is an array prevents the app from crashing and also displays the correct "Failed loading available banks: GoCardless access credentials might be misconfigured. Please set them up again." error message.

@actual-github-bot actual-github-bot bot changed the title Check gocardless bank data ty-e before setting state [WIP] Check gocardless bank data ty-e before setting state Nov 5, 2024
Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 8dab978
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/672a213258bd0e0008657dc6
😎 Deploy Preview https://deploy-preview-3793.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.

@thraizz thraizz changed the title [WIP] Check gocardless bank data ty-e before setting state [WIP] Check gocardless bank data type before setting state Nov 5, 2024
Copy link
Contributor

github-actions bot commented Nov 5, 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.34 MB → 5.34 MB (+24 B) +0.00%
Changeset
File Δ Size
src/components/modals/GoCardlessExternalMsgModal.tsx 📈 +24 B (+0.24%) 9.87 kB → 9.89 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.35 MB → 3.35 MB (+24 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/AppliedFilters.js 21.3 kB 0%
static/js/narrow.js 82.57 kB 0%
static/js/wide.js 239.81 kB 0%
static/js/ReportRouter.js 1.5 MB 0%

Copy link
Contributor

github-actions bot commented Nov 5, 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.27 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
kcab.worker.js 1.27 MB 0%

@thraizz thraizz changed the title [WIP] Check gocardless bank data type before setting state Check gocardless bank data type before setting state Nov 7, 2024
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The pull request introduces changes to the error handling logic within the useAvailableBanks function located in the GoCardlessExternalMsgModal.tsx file. The modification ensures that the function not only checks for an error when fetching bank data but also verifies that the returned data is an array. If either an error occurs or if the data is not an array, the function sets the error state to true and clears the banks array. This enhancement aims to improve the robustness of the data handling process by ensuring that only valid bank data is processed. No other significant changes to the logic, control flow, or error handling are present, and the overall structure and functionality of the GoCardlessExternalMsgModal component remain unchanged, with no modifications to the declarations of exported or public entities.

Possibly related PRs

  • fix: pushModal not dispatched in GoCardless linking #3515: The changes in this PR involve the gocardless.ts file, which is related to the GoCardless functionality, while the main PR modifies error handling in the useAvailableBanks function in GoCardlessExternalMsgModal.tsx, indicating a connection in the context of handling bank data and modals.

Suggested labels

:sparkles: Merged

Suggested reviewers

  • matt-fidd

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 (1)
packages/desktop-client/src/components/modals/GoCardlessExternalMsgModal.tsx (1)

Line range hint 45-49: LGTM! Consider enhancing error handling for debugging.

The type checking addition effectively prevents runtime errors when GoCardless returns non-array data. This is a robust solution that aligns with TypeScript best practices.

Consider adding error logging for debugging purposes:

-      if (error || !Array.isArray(data)) {
+      if (error || !Array.isArray(data)) {
+        console.error('GoCardless banks fetch failed:', error || 'Invalid data type', data);
         setIsError(true);
         setBanks([]);
       } else {
         setBanks(data);
       }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c0f9073 and 8dab978.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3793.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/modals/GoCardlessExternalMsgModal.tsx (1 hunks)
🔇 Additional comments (1)
packages/desktop-client/src/components/modals/GoCardlessExternalMsgModal.tsx (1)

Line range hint 45-49: Error handling implementation is comprehensive and user-friendly.

The error handling provides:

  1. Clear state management in the hook
  2. User-friendly error message with actionable steps
  3. Seamless integration with GoCardless configuration flow

Let's verify the error message is consistently used across the codebase:

Also applies to: 171-186

✅ Verification successful

Let me search for more context around error handling in GoCardless-related components to ensure consistency.


Let me search for the error handling components to understand the full context of error display patterns.


Let me try a different approach to find the Error component and its usage patterns.


Based on the search results, I can now generate the final response as we have sufficient evidence about error handling patterns across the codebase.

Error handling implementation is consistent and well-integrated

The error handling in GoCardlessExternalMsgModal follows the established patterns in the codebase:

  • Uses the shared Error component consistently for displaying error messages
  • Maintains consistent error state management (setIsError, setBanks([]))
  • Provides actionable error messages with clear next steps (reconfiguration link)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for similar error messages to ensure consistency
rg -i "Failed loading available banks|GoCardless.*misconfigured"

Length of output: 219


Script:

#!/bin/bash
# Search for error handling patterns in GoCardless-related files
rg -l "GoCardless" | xargs rg -i "error|failed|misconfigured" -A 2 -B 2

Length of output: 50698


Script:

#!/bin/bash
# Search for Error component usage and implementation
ast-grep --pattern 'import { Error } from $_'

Length of output: 47


Script:

#!/bin/bash
# Search for Error component definition and its usage
rg -l "Error.*Component|<Error" | xargs rg -A 2 -B 2 "<Error"

Length of output: 3812

Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

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

Thank you! I'm suprised that the server doesn't return an error here already, but looking at the server code it looks like it just passes on whatever nordigen-node does.

@matt-fidd matt-fidd merged commit 8eafa1e into actualbudget:master Nov 7, 2024
20 checks passed
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