Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts #4179

joel-jeremy · 2025-01-17T17:19:51Z

Follow up to #4161

This will save us 1 DB call on each of the create/update/delete actions

netlify · 2025-01-17T17:20:08Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`5de2d87`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67908ea736770800085a3335
😎 Deploy Preview	https://deploy-preview-4179.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2025-01-17T17:21:16Z

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
15	6.68 MB → 6.68 MB (-582 B)	-0.01%

Changeset

File	Δ	Size
`home/runner/work/actual/actual/packages/loot-core/src/client/queries/queriesSlice.ts`	📉 -582 B (-4.45%)	12.77 kB → 12.2 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/index.js	4.28 MB → 4.28 MB (-582 B)	-0.01%

Unchanged

Asset	File Size	% Changed
static/js/en.js	99.08 kB	0%
static/js/en-GB.js	95 kB	0%
static/js/nl.js	60.77 kB	0%
static/js/pt-BR.js	105.58 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/narrow.js	84.62 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/wide.js	101.46 kB	0%
static/js/uk.js	114.36 kB	0%
static/js/ReportRouter.js	1.59 MB	0%

github-actions · 2025-01-17T17:21:18Z

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.33 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.33 MB	0%

joel-jeremy · 2025-01-17T17:22:10Z

packages/loot-core/src/client/actions/queries.ts

-      dispatch(getCategories());
-      // Also need to refresh payees because they might use one of the
-      // deleted categories as the default category
-      dispatch(getPayees());


I don't think we need to update payees on category delete. Please correct me if I'm wrong on this one.

joel-jeremy · 2025-01-17T17:22:22Z

packages/loot-core/src/client/actions/queries.ts

    await send('category-group-delete', { id, transferId });
-    await dispatch(getCategories());
-    // See `deleteCategory` for why we need this
-    await dispatch(getPayees());


Same comment above. I don't think we need to update payees on category delete. Please correct me if I'm wrong on this one.

…hared-listeners.ts

coderabbitai · 2025-01-22T06:27:26Z

Walkthrough

The pull request introduces modifications to the queriesSlice.ts file, specifically removing the dispatch parameter from multiple asynchronous thunk actions. These actions include operations related to accounts, groups, categories, and payees. The changes affect functions such as createAccount, closeAccount, reopenAccount, createGroup, updateGroup, deleteGroup, createCategory, updateCategory, deleteCategory, moveCategory, moveCategoryGroup, and createPayee.

The primary modification involves removing the dispatch parameter from function signatures and eliminating associated dispatch calls that were previously used to refresh state after certain actions. While the core logic for sending server requests remains unchanged, the automatic state update mechanism through dispatched actions has been removed.

Possibly related PRs

Add back eslint useDispatch and useSelector rules #4123: Modifies ESLint rules related to useDispatch, which is conceptually aligned with the removal of dispatch parameters
[Mobile] Fix "Category budget has been updated to ..." notification even when the budget was not updated #4200: Addresses onUpdate function, indicating a similar approach to refining update triggering mechanisms

Suggested labels

sparkles:, refactor, state-management

Suggested reviewers

jfdoming

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f0c81ee and 5de2d87.

⛔ Files ignored due to path filters (1)

upcoming-release-notes/4179.md is excluded by !**/*.md

📒 Files selected for processing (1)

packages/loot-core/src/client/queries/queriesSlice.ts (11 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Functional
GitHub Check: Visual regression
GitHub Check: build (windows-latest)
GitHub Check: build (ubuntu-latest)

🔇 Additional comments (3)

packages/loot-core/src/client/queries/queriesSlice.ts (3)

375-380: LGTM! Changes align with PR objective.

The removal of the dispatch parameter from createPayee is consistent with the PR's goal, while initiallyLoadPayees correctly retains its dispatch usage for conditional loading.

Line range hint 167-380: Overall changes look good with one suggestion.

The removal of dispatch calls from CRUD operations is consistent and aligns well with the PR objective of centralizing dispatch calls in shared-listeners.ts. This will help reduce database calls as intended. The only suggestion is to move the error handling in deleteCategory to shared-listeners.ts for consistency.

167-167: Verify state synchronization after removing dispatch calls.

The removal of dispatch calls aligns with the PR objective. However, we should verify that the account state is properly synchronized through shared-listeners.ts after these operations.

Let's verify the state synchronization implementation in shared-listeners.ts:

Also applies to: 186-191, 207-207

✅ Verification successful

State synchronization is properly implemented

The removal of dispatch calls is safe as the codebase implements a robust state synchronization system through shared listeners and sync events. Account operations trigger sync events that notify all relevant components to update their state.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Search for account-related listeners in shared-listeners.ts
rg -A 5 "account-(create|close|reopen)" --type ts
Length of output: 9026

Script:
#!/bin/bash
# Search for shared listeners implementation
rg -l "shared-listeners" --type ts

# Then search for sync/refresh patterns in those files
rg "(sync|refresh|subscribe.*account)" --type ts
Length of output: 66092

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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.

actual-github-bot bot changed the title ~~Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts~~ [WIP] Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts Jan 17, 2025

actual-github-bot bot added the 🚧 WIP label Jan 17, 2025

joel-jeremy changed the base branch from master to update-global-event-listeners January 17, 2025 17:21

joel-jeremy commented Jan 17, 2025

View reviewed changes

joel-jeremy force-pushed the update-global-event-listeners branch from 25a8732 to 1b8cf86 Compare January 19, 2025 08:02

joel-jeremy force-pushed the remove-duplicate-sync-event-listeners branch from 09d82aa to 247a3c9 Compare January 19, 2025 08:21

Base automatically changed from update-global-event-listeners to master January 22, 2025 06:18

joel-jeremy added 3 commits January 21, 2025 22:22

Remove unnecessary dispatch calls that are already being handles by s…

30aa328

…hared-listeners.ts

Release notes

d45f1fd

Fix lint error

5de2d87

joel-jeremy force-pushed the remove-duplicate-sync-event-listeners branch from dcda62c to 5de2d87 Compare January 22, 2025 06:22

joel-jeremy changed the title ~~[WIP] Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts~~ Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts Jan 22, 2025

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Jan 22, 2025

joel-jeremy requested a review from UnderKoen January 22, 2025 15:59

UnderKoen approved these changes Jan 23, 2025

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Jan 23, 2025

joel-jeremy merged commit 1f5e5d4 into master Jan 23, 2025
20 checks passed

joel-jeremy deleted the remove-duplicate-sync-event-listeners branch January 23, 2025 16:28

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Jan 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts #4179

Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts #4179

joel-jeremy commented Jan 17, 2025 •

edited

Loading

netlify bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

joel-jeremy Jan 17, 2025

joel-jeremy Jan 17, 2025

coderabbitai bot commented Jan 22, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts #4179

Remove unnecessary dispatch calls that are already being handled by shared-listeners.ts #4179

Conversation

joel-jeremy commented Jan 17, 2025 • edited Loading

netlify bot commented Jan 17, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Jan 17, 2025 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Jan 17, 2025 • edited Loading

Bundle Stats — loot-core

joel-jeremy Jan 17, 2025

Choose a reason for hiding this comment

joel-jeremy Jan 17, 2025

Choose a reason for hiding this comment

coderabbitai bot commented Jan 22, 2025

Walkthrough

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

joel-jeremy commented Jan 17, 2025 •

edited

Loading

netlify bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)