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

🐛 (bank-sync) fix initial sync - close modal stack, show loading indicators #3540

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

MatissJanis
Copy link
Member

Two fixes here for the initial bank sync:

  1. close all the modal windows after successfully linking
  2. show a loading indicator besides accounts after linking

@actual-github-bot actual-github-bot bot changed the title 🐛 (bank-sync) fix initial sync - close modal stack, show loading indicators [WIP] 🐛 (bank-sync) fix initial sync - close modal stack, show loading indicators Oct 2, 2024
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes in this pull request involve modifications to the SelectLinkedAccountsModal component and the linkAccount and linkAccountSimpleFin functions in the loot-core actions. The modal's onNext function now dispatches a closeModal action after linking accounts, simplifying the button's functionality. Additionally, TypeScript type annotations are added to the parameters of the account linking functions, and conditional logic is introduced to handle account syncing based on the presence of an upgradingId.

Changes

File Path Change Summary
packages/desktop-client/src/components/modals/SelectLinkedAccountsModal.jsx Added import for closeModal action and modified onNext function to dispatch closeModal() after linking, simplifying the Link accounts button's onPress handler.
packages/loot-core/src/client/actions/account.ts Updated linkAccount and linkAccountSimpleFin functions with TypeScript type annotations for parameters and added conditional logic to dispatch setAccountsSyncing when upgradingId is provided.

Possibly related PRs

  • fix: pushModal not dispatched in GoCardless linking #3515: This PR addresses the dispatching of the pushModal action in the GoCardless linking process, which is directly related to the modal functionality being modified in the main PR. Both involve handling modal actions within the application.

Suggested labels

:sparkles: Merged

Suggested reviewers

  • MikesGlitch
  • youngcw

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

netlify bot commented Oct 2, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 43e5587
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/66fd1212591eaf0008740ce1
😎 Deploy Preview https://deploy-preview-3540.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.

@MatissJanis MatissJanis added this to the v24.10.0 milestone Oct 2, 2024
Copy link
Contributor

github-actions bot commented Oct 2, 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
9 5.29 MB → 5.29 MB (+170 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/client/actions/account.ts 📈 +204 B (+4.23%) 4.71 kB → 4.91 kB
src/components/modals/SelectLinkedAccountsModal.jsx 📉 -34 B (-0.46%) 7.18 kB → 7.14 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.31 MB → 3.31 MB (+170 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/AppliedFilters.js 20.96 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 81.98 kB 0%
static/js/wide.js 225.26 kB 0%
static/js/ReportRouter.js 1.5 MB 0%

Copy link
Contributor

github-actions bot commented Oct 2, 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.19 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.19 MB 0%

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 (4)
packages/loot-core/src/client/actions/account.ts (2)

58-68: LGTM! Consider adding a comment for clarity.

The changes look good and align with the PR objectives. The added type annotations improve type safety, and the new logic for upgradingId addresses the requirement to show loading indicators during the account linking process.

Consider adding a brief comment explaining the purpose of the upgradingId check, like this:

// Show loading indicator for the account being upgraded
if (upgradingId) {
  await dispatch(setAccountsSyncing([upgradingId]));
}

This would enhance code readability and make the intent clearer for future maintainers.


80-89: LGTM! Consider extracting common logic.

The changes look good and align with the PR objectives. The added type annotations improve type safety, and the new logic for upgradingId addresses the requirement to show loading indicators during the account linking process.

Since the upgradingId logic is identical in both linkAccount and linkAccountSimpleFin, consider extracting it into a separate function for better maintainability:

function handleUpgradingId(dispatch: Dispatch, upgradingId?: string) {
  if (upgradingId) {
    return dispatch(setAccountsSyncing([upgradingId]));
  }
}

// Then in both functions:
await handleUpgradingId(dispatch, upgradingId);

This would reduce code duplication and make future changes easier to manage.

packages/desktop-client/src/components/modals/SelectLinkedAccountsModal.jsx (2)

94-95: LGTM: Modal closure added after account linking.

The addition of dispatch(closeModal()); at the end of the onNext function correctly implements the PR objective to close all modal windows after successful account linking.

Consider wrapping the dispatch(closeModal()); call in a try-catch block to handle any potential errors during the modal closure process:

try {
  dispatch(closeModal());
} catch (error) {
  console.error('Error closing modal:', error);
  // Optionally, you can add user feedback here
}

Implementation of loading indicators is missing.

While the changes successfully implement the closing of modal windows after account linking, there are no visible loading indicators next to accounts during the linking process, as mentioned in the PR objectives.

🔗 Analysis chain

Line range hint 1-254: Implementation of loading indicators is missing.

While the changes successfully implement the closing of modal windows after account linking, there are no visible changes to add loading indicators next to accounts during the linking process, as mentioned in the PR objectives.

Could you please confirm if the loading indicators are implemented in a different file? If not, consider adding the loading indicators to fully meet the PR objectives. Here's a script to check for potential implementations elsewhere:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for loading indicator implementations in other files
rg --type js --type jsx -i "loading\s*(indicator|spinner)" packages/desktop-client/src

Length of output: 116


Script:

#!/bin/bash
# Search for loading indicator implementations in JS and JSX files
rg -i "loading\s*(indicator|spinner)" packages/desktop-client/src --glob "*.js" --glob "*.jsx"

Length of output: 321

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5064b06 and 43e5587.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3540.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/modals/SelectLinkedAccountsModal.jsx (3 hunks)
  • packages/loot-core/src/client/actions/account.ts (2 hunks)
🔇 Additional comments (3)
packages/loot-core/src/client/actions/account.ts (1)

Line range hint 58-89: Overall changes align well with PR objectives.

The modifications to both linkAccount and linkAccountSimpleFin functions successfully address the PR's goal of showing loading indicators during the account linking process. The added TypeScript type annotations enhance code quality and maintainability.

These changes contribute to improving the user experience during the initial bank synchronization process, as outlined in the PR objectives. The code now provides visual feedback (loading indicators) when linking accounts, which should help users understand that the system is processing their request.

To further improve the code:

  1. Consider adding comments to explain the purpose of the upgradingId logic.
  2. Evaluate the suggestion to extract the common upgradingId handling logic into a separate function.

These minor improvements would enhance code readability and maintainability without affecting the functionality.

packages/desktop-client/src/components/modals/SelectLinkedAccountsModal.jsx (2)

5-5: LGTM: Import statement for closeModal added correctly.

The import of closeModal from 'loot-core/client/actions' is correctly added and aligns with the PR objective to close the modal stack after linking accounts.


182-182: LGTM: Button onPress handler simplified correctly.

The simplification of the onPress handler to directly use onNext is correct and aligns with the changes made to the onNext function. This change maintains the intended functionality while reducing code complexity.

@MatissJanis MatissJanis changed the title [WIP] 🐛 (bank-sync) fix initial sync - close modal stack, show loading indicators 🐛 (bank-sync) fix initial sync - close modal stack, show loading indicators Oct 2, 2024
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.

Closing the modal is a massive improvement

Unsure if I'm testing this properly or not, but I'm not seeing the initial accounts syncing indicators because they don't show in the UI until they've been fully synced (testing with SimpleFIN because it's easier than GCL)

Screen.Recording.2024-10-02.110407.mp4

Happy to merge this in for the release regardless, as the above behaviour is the same as edge

@MatissJanis
Copy link
Member Author

TBH this mostly applies to GoCardless. SimpleFIN works quite differently, so the solution there would also need to be different.

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