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 flicker when saving transaction on account page when transactions are scheduled #3920

Conversation

MikesGlitch
Copy link
Contributor

@MikesGlitch MikesGlitch commented Dec 1, 2024

Info: #3916

Fixes:
test

Copy link

netlify bot commented Dec 1, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 8ee21dd
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/674ca3e5ddf06100081c1011
😎 Deploy Preview https://deploy-preview-3920.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.

@MikesGlitch MikesGlitch changed the title fix flicker when saving transaction on account page when there are sc… 🐛 Fix flicker when saving transaction on account page when transactions are scheduled Dec 1, 2024
Copy link
Contributor

github-actions bot commented Dec 1, 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 → 5.45 MB (-59 B) -0.00%
Changeset
File Δ Size
src/hooks/useAccountPreviewTransactions.ts 📉 -59 B (-3.42%) 1.68 kB → 1.63 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
static/js/useAccountPreviewTransactions.js 1.68 kB → 1.63 kB (-59 B) -3.42%

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 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 Dec 1, 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 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.32 MB 0%

@@ -32,10 +32,6 @@ export function useAccountPreviewTransactions({
const payees = usePayees();

const previewTransactions = useMemo(() => {
if (isLoading) {
return [];
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was causing the flicker - we reset the preview transactions array whenever we saved a transaction on the page. I think this is unnecessary.

@MikesGlitch MikesGlitch added this to the v24.12.0 milestone Dec 1, 2024
@MikesGlitch MikesGlitch marked this pull request as ready for review December 1, 2024 18:04
Copy link
Contributor

coderabbitai bot commented Dec 1, 2024

Walkthrough

The pull request introduces changes to the useAccountPreviewTransactions function within the useAccountPreviewTransactions.ts file. The primary modification involves the removal of an early return statement that previously checked if isLoading was true. In the prior implementation, if isLoading was true, the function would return an empty array for previewTransactions. With the new changes, the function now bypasses this check and continues to evaluate the presence of accountId. If accountId is absent, it returns originalPreviewTransactions directly, irrespective of the loading state. Additionally, the dependency array for the useMemo hook has been updated by removing isLoading, which may influence the recalculation of the memoized value. The structure of the return statement has also been modified to utilize a more organized object notation for returning isLoading and previewTransactions.

Possibly related PRs

Suggested labels

::sparkles: Merged

Suggested reviewers

  • joel-jeremy

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/desktop-client/src/hooks/useAccountPreviewTransactions.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 (1)
packages/desktop-client/src/hooks/useAccountPreviewTransactions.ts (1)

51-54: LGTM! Improved loading state handling

The restructured return statement correctly maintains the preview transactions during loading states instead of resetting them. This is a better pattern for React applications as it:

  1. Prevents unnecessary UI resets
  2. Allows components to handle loading states without losing existing data
  3. Reduces flickering during data updates

Consider adopting this pattern across similar hooks in the codebase where loading states are managed. Instead of resetting data during loading, let the UI components decide how to handle the loading state while preserving existing data.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 22623ce and 8ee21dd.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3920.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/hooks/useAccountPreviewTransactions.ts (1 hunks)
🔇 Additional comments (2)
packages/desktop-client/src/hooks/useAccountPreviewTransactions.ts (2)

49-49: LGTM! Correct optimization of useMemo dependencies

The removal of isLoading from the dependency array is appropriate as the preview transactions transformation logic is independent of the loading state. This change helps prevent unnecessary recalculations and fixes the flickering issue.


49-54: Verify similar patterns in other transaction-related hooks

Let's check if other hooks in the codebase follow a similar pattern that might need the same optimization.

✅ Verification successful

No issues found with the loading state pattern

The verification shows that the loading state pattern in useAccountPreviewTransactions is consistent with other implementations in the codebase:

  • The core usePreviewTransactions hook in transactions.ts follows the same pattern of managing loading state and returning it with preview transactions
  • The loading state is properly managed with state updates (setIsLoading) and returned in a similar structure
  • No early returns based on loading state were found that would suggest a need for optimization
  • The changes are localized and don't impact other parts of the codebase
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for similar hooks that might have early returns based on loading state
ast-grep --pattern 'export function use$_($_) {
  $$$
  if ($isLoading) {
    return $$$
  }
  $$$
}'

# Look for other preview transaction related hooks
fd -e ts -e tsx -x rg -l 'usePreviewTransactions|PreviewTransactions'

Length of output: 497


Script:

#!/bin/bash
# Let's examine the content of these files to check for similar patterns
rg -U "usePreviewTransactions|PreviewTransactions" ./packages/loot-core/src/client/data-hooks/transactions.ts -A 10 -B 5

# Check the implementation in account actions
rg -U "usePreviewTransactions|PreviewTransactions" ./packages/loot-core/src/client/actions/account.ts -A 10 -B 5

# Look for loading state patterns in hooks
ast-grep --pattern 'const $isLoading = $_'

# Check for return patterns with loading state
ast-grep --pattern 'return {
  $isLoading,
  $$$
}'

Length of output: 2025

Copy link
Member

@youngcw youngcw left a comment

Choose a reason for hiding this comment

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

Looks good to me. Maybe @joel-jeremy should look at it too if possible.

Copy link
Contributor

@joel-jeremy joel-jeremy left a comment

Choose a reason for hiding this comment

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

Nice catch! LGTM!

@MikesGlitch MikesGlitch merged commit 501c865 into actualbudget:master Dec 2, 2024
20 checks passed
@MikesGlitch MikesGlitch deleted the fix/flickering-when-saving-transaction-with-scheduled branch December 2, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants