Fix Issue 3331, sort favorite payees before other frequently used payees #3412

qedi-r · 2024-09-09T22:52:18Z

This fixes #3331. It changes the Suggested Payees section from

Alice
Bob
Charlie
Dave
Ernie

to

Alice
Charlie
Bob
Dave
Ernie

in cases where there are fewer than five favorites in the system.

It also adds tests, I could separate the tests from the bugfix, if people want to discuss the tests more.

…page

…uggestions

netlify · 2024-09-09T22:52:35Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`34e9bf4`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/66ecc55244f4540008051f4c
😎 Deploy Preview	https://deploy-preview-3412.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 · 2024-09-09T22:53:37Z

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.28 MB → 5.28 MB (+248 B)	+0.00%

Changeset

File	Δ	Size
`src/components/autocomplete/PayeeAutocomplete.tsx`	📈 +248 B (+1.65%)	14.66 kB → 14.9 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 (+248 B)	+0.01%

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/AppliedFilters.js	20.97 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/usePreviewTransactions.js	1.59 kB	0%
static/js/narrow.js	80.95 kB	0%
static/js/wide.js	225.37 kB	0%
static/js/ReportRouter.js	1.5 MB	0%

github-actions · 2024-09-09T22:53:38Z

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%

youngcw · 2024-09-11T15:44:33Z

Functionally it looks good. Can you update the branch and fix the failed checks?

qedi-r · 2024-09-15T02:56:32Z

Ok, test inconsistencies are addressed.

MikesGlitch · 2024-09-18T14:49:36Z

@coderabbitai review

coderabbitai · 2024-09-18T14:49:48Z

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2024-09-18T14:49:52Z

Walkthrough

The pull request introduces several enhancements across multiple files, focusing on the PayeeAutocomplete component and its associated tests. Key changes include improved logic for generating payee suggestions, modifications to the export status of certain types, and updates to the TransactionsTable test cases. Additionally, a new custom Jest matcher has been added to validate favorite payees in the rendered output. These changes aim to improve the clarity, efficiency, and robustness of the codebase.

Changes

Files	Change Summary
`packages/desktop-client/src/components/autocomplete/PayeeAutocomplete.tsx`	Modified payee suggestion logic, exporting types `PayeeAutocompleteItem` and `PayeeAutocompleteProps`, and refining filtering and sorting logic for payees.
`packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx`	Updated test cases with new payee entries, added a custom matcher for favorite stars, and ensured accurate display of payees in transaction creation and editing scenarios.

Assessment against linked issues

Objective	Addressed	Explanation
Payees should sort favorite payees before other suggested payees. ( #3331)	✅

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.

matt-fidd · 2024-09-19T22:45:08Z

Hi @qedi-r, it looks like VRT is still failing. Could you update the branch and see if it clears please?

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx (1)
676-694: Consider adding an assertion for favorite stars.

The test case dropdown payee displays on existing non-transfer transaction correctly verifies the rendered payee names in the dropdown for an existing transaction. However, to maintain consistency with the previous test case, consider adding an assertion to verify the presence of favorite stars for the appropriate payee items.

You can use the custom Jest matcher payeesToHaveFavoriteStars to assert the favorite stars, like this:
expect(renderedPayees).payeesToHaveFavoriteStars([
  'Alice-payee-item',
  'Bob-payee-item',
]);

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3d4f83f and 34e9bf4.

Files selected for processing (2)

packages/desktop-client/src/components/autocomplete/PayeeAutocomplete.tsx (2 hunks)
packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx (7 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/desktop-client/src/components/autocomplete/PayeeAutocomplete.tsx

Additional comments not posted (2)

packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx (2)

307-339: LGTM!

The custom Jest matcher function payeesToHaveFavoriteStars is implemented correctly. It properly validates the presence of favorite stars for the provided payee list in the rendered output and returns an appropriate pass/fail result object.

648-674: Test case looks good!

The test case dropdown payee displays on new transaction with account list column is implemented correctly. It properly sets up the component state for adding a new transaction, queries the rendered payee items from the dropdown, and makes appropriate assertions for payee names and favorite stars.

qedi-r added 3 commits September 1, 2024 12:17

add tests for payee dropdown bug on new transactions on all accounts …

430d8ec

…page

add tests for bugfixes

5238e57

sort favorite payees first, add tests for PayeeAutocomplete.getPayeeS…

05a708e

…uggestions

actual-github-bot bot changed the title ~~Fix Issue 3331, sort favorite payees before other frequently used payees~~ [WIP] Fix Issue 3331, sort favorite payees before other frequently used payees Sep 9, 2024

actual-github-bot bot added the 🚧 WIP label Sep 9, 2024

qedi-r added 2 commits September 9, 2024 19:00

lint and release notes

c7d74e7

fix release note number

8ec2cc8

qedi-r changed the title ~~[WIP] Fix Issue 3331, sort favorite payees before other frequently used payees~~ Fix Issue 3331, sort favorite payees before other frequently used payees Sep 10, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Sep 10, 2024

qedi-r added 3 commits September 12, 2024 18:11

lint fixes

75421bb

add missing file in previous lint fix

e2477a4

fix typecheck and linting errors

3d4f83f

Merge branch 'master' into issue-3331

34e9bf4

coderabbitai bot reviewed Sep 20, 2024

View reviewed changes

youngcw added this to the v24.10.0 milestone Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Issue 3331, sort favorite payees before other frequently used payees #3412

Fix Issue 3331, sort favorite payees before other frequently used payees #3412

qedi-r commented Sep 9, 2024 •

edited

Loading

netlify bot commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

youngcw commented Sep 11, 2024

qedi-r commented Sep 15, 2024

MikesGlitch commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

matt-fidd commented Sep 19, 2024

coderabbitai bot left a comment

Fix Issue 3331, sort favorite payees before other frequently used payees #3412

Are you sure you want to change the base?

Fix Issue 3331, sort favorite payees before other frequently used payees #3412

Conversation

qedi-r commented Sep 9, 2024 • edited Loading

netlify bot commented Sep 9, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Sep 9, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Sep 9, 2024 • edited Loading

Bundle Stats — loot-core

youngcw commented Sep 11, 2024

qedi-r commented Sep 15, 2024

MikesGlitch commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

matt-fidd commented Sep 19, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

qedi-r commented Sep 9, 2024 •

edited

Loading

netlify bot commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)