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: any rule not accounting for empty filter #4051

Merged
merged 5 commits into from
Jan 8, 2025

Conversation

douugdev
Copy link
Contributor

Fixes #3982, that bug didn't only occur in the summary report, it also ocurred everywhere where there are filters that allow you to switch from "all" to "any" clauses.

For example in custom reports:

When you started filtering, switched to the "any" clause and then removed the conditions, the report would "crash" and never display any value because the compiler was inserting a AND 0 statement in the WHERE condition of the SQL. See:
https://github.com/user-attachments/assets/6e02f703-bb52-4b0c-88a3-ffe2c7e66a43

The bug was in the condition not accounting for empty arrays, it checked if(!cond) but if an empty array was passed, it was seem as a truthy value, because, for some reason, !![] is a truthy value in JavaScript 🤷.

After the fix:
https://github.com/user-attachments/assets/3d656330-3c6f-4243-a961-ad4f92aa5343

@actual-github-bot actual-github-bot bot changed the title fix: any rule not accounting for empty filter [WIP] fix: any rule not accounting for empty filter Dec 28, 2024
Copy link

netlify bot commented Dec 28, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 5134d69
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/677d636ff5c1bd0008cb66f2
😎 Deploy Preview https://deploy-preview-4051.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.

Copy link
Contributor

github-actions bot commented Dec 28, 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.64 MB → 5.64 MB (-237 B) -0.00%
Changeset
File Δ Size
node_modules/define-data-property/index.js 📉 -9 B (-0.39%) 2.25 kB → 2.24 kB
node_modules/call-bind/index.js 📉 -9 B (-0.84%) 1.05 kB → 1.04 kB
node_modules/has-property-descriptors/index.js 📉 -9 B (-1.55%) 582 B → 573 B
node_modules/es-define-property/index.js 📉 -210 B (-37.50%) 560 B → 350 B
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 3.71 MB → 3.71 MB (-237 B) -0.01%

Unchanged

Asset File Size % Changed
static/js/workbox-window.prod.es5.js 5.69 kB 0%
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 84.22 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 10.24 kB 0%
static/js/wide.js 104.11 kB 0%
static/js/ReportRouter.js 1.58 MB 0%

Copy link
Contributor

github-actions bot commented Dec 28, 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.33 MB → 1.33 MB (+33 B) +0.00%
Changeset
File Δ Size
packages/loot-core/src/server/aql/compiler.ts 📈 +44 B (+0.12%) 35.39 kB → 35.43 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

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

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@mgrigoriev8109
Copy link

@douugdev just curious - I started looking at this one but couldn't track it down on time. Mind me asking how you narrowed the issue down to being inside packages/loot-core/src/server/aql/compiler.ts ?

@douugdev
Copy link
Contributor Author

douugdev commented Dec 31, 2024

@douugdev just curious - I started looking at this one but couldn't track it down on time. Mind me asking how you narrowed the issue down to being inside packages/loot-core/src/server/aql/compiler.ts ?

Sure, it was a real rabbit hole!

I realized when the default conditionOp "$and" was selected, and you cleared the filters, the bug didn't occur, so at first I tried changing everywhere to check for the length of the conditions array before selecting "$or" as such:
image

It worked. But it was probably lots of places to change and it wouldn't fix the root problem if someone else created another query elsewhere.

So I just logged the generated SQL (after understanding how it was generated by actual, pretty clever btw!) when changing the conditionOp:

Without the fix, this was the generated where clause for a filter with the clauses "cleared == true && amount < 0"

WHERE ((v_transactions_internal_alive.cleared = 1
  AND v_transactions_internal_alive.amount < 0)
  AND (CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) >= 202406
  AND CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) <= 202412)
  AND v_transactions_internal_alive.amount < 0)

and this was for the clauses "cleared == true || amount < 0"

WHERE ((v_transactions_internal_alive.cleared = 1
  OR v_transactions_internal_alive.amount < 0)
  AND (CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) >= 202406
  AND CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) <= 202412)
  AND v_transactions_internal_alive.amount < 0)

All fine here.

But when deleting the clauses:

WHERE (0
  AND (CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) >= 202406
  AND CAST(SUBSTR(v_transactions_internal_alive.date, 1, 6) AS integer) <= 202412)
  AND v_transactions_internal_alive.amount < 0)

Suddenly there is a 0 in there, and 0 AND anything will always be falsy.

These are the functions that handle the generating OR and AND operators:
image

With this being the part of the "compileConditions" function that chooses which function to use:
image

At last I saw that instead of the object being passed being $or: undefined or $or: null like it is when you don't have any filters selected, after deleting the filters, the object passed was $or: [] (or rather in this context as an key-value pair array [$or, []]).

And the condition !field was ignored because ![] is false.

So backtracking a bit: first the compileAnd was called and started joining statements (FOO AND BAR AND BAZ) but one of those statements is an empty array of conditions compileOr which by the function returns a 0, see below.
image

So the final compiled WHERE was: (0 AND ... AND ...) which never finds anything.

Thanks for coming to my ted talk!

@mgrigoriev8109
Copy link

@douugdev holy crap I did not expect it to be that complicated! Thanks for walking me through that.

@douugdev douugdev changed the title [WIP] fix: any rule not accounting for empty filter fix: any rule not accounting for empty filter Jan 3, 2025
Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

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/loot-core/src/server/aql/compiler.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.

Walkthrough

The pull request introduces a modification in the compileConditions function within the packages/loot-core/src/server/aql/compiler.ts file. The change focuses on enhancing the handling of the $or condition by adding a check for falsy conditions or empty arrays. When such conditions are encountered, the function now returns null, which prevents unnecessary processing of empty or invalid conditions. This modification aims to improve the robustness of condition compilation in the AQL (Actual Query Language) compiler, ensuring more precise and efficient condition evaluation.

Assessment against linked issues

Objective Addressed Explanation
Filter type reset behavior [#3982] Unable to definitively determine if this change directly addresses the filter reset issue described in the bug report
Prevent empty summary values [#3982] Insufficient context to confirm if the AQL compiler change resolves the summary value problem

The assessment reveals that while the code change modifies the condition compilation logic, there is insufficient evidence to conclusively link it to the specific bug reported in issue #3982. The changes appear to be more related to internal compiler logic rather than directly addressing the filter and summary value issues described in the bug report. Further investigation or additional context would be needed to establish a direct connection.


📜 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 d894281 and 318a12f.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4051.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/server/aql/compiler.ts (1 hunks)
🔇 Additional comments (1)
packages/loot-core/src/server/aql/compiler.ts (1)

760-762: Properly handles empty arrays in $or conditions
This check ensures that an empty array does not erroneously generate a 0 condition, which previously prevented any matching results. Returning null instead of '0' avoids adding an always-false condition.

You may want to add test coverage for the $or scenario with no conditions to confirm it yields the intended behavior.


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.

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.

Thanks for this, looks like quite the debugging rabbit hole

@matt-fidd matt-fidd merged commit 3fbe6d0 into actualbudget:master Jan 8, 2025
20 checks passed
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.

[Bug]: Summary shows wrong value
3 participants