Don't consider payees used in rules as orphaned #3609

matt-fidd · 2024-10-08T23:32:56Z

Found as part of reviewing #3507

netlify · 2024-10-08T23:33:11Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`22c76e1`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/6706a15ae647c700087e0435
😎 Deploy Preview	https://deploy-preview-3609.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.

coderabbitai · 2024-10-08T23:34:38Z

Walkthrough

The pull request introduces changes to the packages/loot-core/src/server/db/index.ts file, focusing on the management of payees, particularly orphaned payees. A new SQL query named orphanedPayeesQuery is created to identify payees that lack links to transactions and associated rules. This query is integrated into two functions: syncGetOrphanedPayees and getOrphanedPayees, replacing previous inline SQL statements to enhance readability and maintainability. The syncGetOrphanedPayees function is modified to return results based on the new query, while the getOrphanedPayees function also adopts this query for streamlined implementation. Minor adjustments to comments and formatting are included to ensure clarity and consistency in the code. Overall, the changes aim to improve the structure of database management functions related to orphaned payees without altering existing functionality.

Assessment against linked issues

Objective	Addressed	Explanation
Exclude payees used in any rules from being considered orphaned (3608)	❌	The changes do not address the exclusion of payees used in rules.

Suggested labels

sparkles: Merged

Suggested reviewers

youngcw

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between de45e1b and f7dd313.

📒 Files selected for processing (1)

packages/loot-core/src/server/db/index.ts (1 hunks)

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

packages/loot-core/src/server/db/index.ts

🧰 Additional context used

📓 Learnings (1)

📓 Common learnings

Learnt from: matt-fidd
PR: actualbudget/actual#3609
File: packages/loot-core/src/server/db/index.ts:583-598
Timestamp: 2024-10-08T23:41:32.134Z
Learning: In `packages/loot-core/src/server/db/index.ts`, the `orphanedPayeesQuery` uses a subquery with `json_each(r.conditions) AS cond` to loop through JSON conditions because the "description" field may not be the first index. This implementation must remain as is to ensure correct functionality.

Additionally, table aliases are already used consistently in the SQL queries within this file.

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.

github-actions · 2024-10-08T23:35:22Z

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.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
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/narrow.js	82.55 kB	0%
static/js/usePreviewTransactions.js	1.64 kB	0%
static/js/AppliedFilters.js	20.96 kB	0%
static/js/wide.js	224.88 kB	0%
static/js/ReportRouter.js	1.51 MB	0%
static/js/index.js	3.34 MB	0%

github-actions · 2024-10-08T23:35:23Z

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.26 MB → 1.26 MB (+57 B)	+0.00%

Changeset

File	Δ	Size
`packages/loot-core/src/server/db/index.ts`	📈 +194 B (+0.99%)	19.13 kB → 19.32 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
kcab.worker.js	1.26 MB → 1.26 MB (+57 B)	+0.00%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

packages/loot-core/src/server/db/index.ts (1)
603-606: LGTM: Updated getOrphanedPayees function with minor optimization suggestion

The changes to getOrphanedPayees look good. The function now uses the new orphanedPayeesQuery and correctly maps the results to return an array of payee IDs. This aligns well with the PR objectives.

Consider a minor optimization to reduce unnecessary data transfer:
export async function getOrphanedPayees() {
  return all(`SELECT id FROM (${orphanedPayeesQuery})`);
}
This change would only select the id column from the subquery result, potentially improving performance for large datasets.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1485d9c and 3e62b30.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

packages/loot-core/src/server/db/index.ts (1 hunks)

🧰 Additional context used

🪛 GitHub Check: lint

packages/loot-core/src/server/db/index.ts

[warning] 595-595:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

[warning] 595-595:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

[warning] 595-595:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

[warning] 595-595:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

[warning] 596-596:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

[warning] 596-596:
Avoid using straight quotes (' or ") in user-visible text. Use curly quotes (‘ ’ or “ ”) instead

🔇 Additional comments (1)

packages/loot-core/src/server/db/index.ts (1)

599-601: LGTM: Simplified syncGetOrphanedPayees function

The changes to syncGetOrphanedPayees look good. The function now uses the new orphanedPayeesQuery, which correctly identifies orphaned payees, including those used in rules or schedules. This change aligns well with the PR objectives and simplifies the function implementation.

packages/loot-core/src/server/db/index.ts

matt-fidd · 2024-10-08T23:50:40Z

packages/loot-core/src/server/db/index.ts

@@ -580,22 +580,31 @@ export function getCommonPayees() {
  `);
 }

+/* eslint-disable rulesdir/typography */


This shouldn't be necessary, but lint is complaining

youngcw · 2024-10-09T14:21:49Z

I don't think this ignores deleted rules

matt-fidd · 2024-10-09T14:25:10Z

I don't think this ignores deleted rules

Good catch

don't consider payees in rules as orphaned

8a4e56f

actual-github-bot bot changed the title ~~Don't consider payees in rules as orphaned~~ [WIP] Don't consider payees in rules as orphaned Oct 8, 2024

actual-github-bot bot added the 🚧 WIP label Oct 8, 2024

matt-fidd changed the title ~~[WIP] Don't consider payees in rules as orphaned~~ [WIP] Don't consider payees used in rules as orphaned Oct 8, 2024

release note

3e62b30

matt-fidd force-pushed the orphaned-payees branch from b0918ff to 3e62b30 Compare October 8, 2024 23:33

coderabbitai bot reviewed Oct 8, 2024

View reviewed changes

packages/loot-core/src/server/db/index.ts Outdated Show resolved Hide resolved

lint

de45e1b

matt-fidd changed the title ~~[WIP] Don't consider payees used in rules as orphaned~~ Don't consider payees used in rules as orphaned Oct 8, 2024

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

matt-fidd commented Oct 8, 2024

View reviewed changes

indentation

565aeeb

ignore deleted rules

f7dd313

youngcw approved these changes Oct 9, 2024

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Oct 9, 2024

Merge branch 'master' into orphaned-payees

22c76e1

matt-fidd merged commit e455369 into actualbudget:master Oct 9, 2024
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Oct 9, 2024

matt-fidd deleted the orphaned-payees branch October 9, 2024 15:47

coderabbitai bot mentioned this pull request Oct 9, 2024

feat: templating on payee_name #3619

Merged

coderabbitai bot mentioned this pull request Nov 21, 2024

Convert ManagePayees components to Typescript #3867

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't consider payees used in rules as orphaned #3609

Don't consider payees used in rules as orphaned #3609

matt-fidd commented Oct 8, 2024 •

edited

Loading

netlify bot commented Oct 8, 2024 •

edited

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Oct 8, 2024 •

edited

Loading

github-actions bot commented Oct 8, 2024 •

edited

Loading

coderabbitai bot left a comment

matt-fidd Oct 8, 2024

youngcw commented Oct 9, 2024

matt-fidd commented Oct 9, 2024

Don't consider payees used in rules as orphaned #3609

Don't consider payees used in rules as orphaned #3609

Conversation

matt-fidd commented Oct 8, 2024 • edited Loading

netlify bot commented Oct 8, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

coderabbitai bot commented Oct 8, 2024 • edited Loading

Walkthrough

Assessment against linked issues

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Oct 8, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Oct 8, 2024 • edited Loading

Bundle Stats — loot-core

coderabbitai bot left a comment

Choose a reason for hiding this comment

matt-fidd Oct 8, 2024

Choose a reason for hiding this comment

youngcw commented Oct 9, 2024

matt-fidd commented Oct 9, 2024

matt-fidd commented Oct 8, 2024 •

edited

Loading

netlify bot commented Oct 8, 2024 •

edited

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Oct 8, 2024 •

edited

Loading

github-actions bot commented Oct 8, 2024 •

edited

Loading