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

update sql regexp to default to empty string when field is null #3480

Merged
merged 8 commits into from
Sep 22, 2024

Conversation

qedi-r
Copy link
Contributor

@qedi-r qedi-r commented Sep 21, 2024

Fixes issue #3479

Note that:

RegExp('null').test(null) ? 1 : 0;

resolves to 1 in JS. 😢

@actual-github-bot actual-github-bot bot changed the title update sql regexp to default to empty string when field is null [WIP] update sql regexp to default to empty string when field is null Sep 21, 2024
Copy link

netlify bot commented Sep 21, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 7953850
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/66f0466891855b00083817b9
😎 Deploy Preview https://deploy-preview-3480.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

coderabbitai bot commented Sep 21, 2024

Walkthrough

The changes involve modifications to the regexp function in two files to handle potential null values for the text parameter by defaulting to an empty string. Additionally, a new table named textstrings is introduced in the SQLite database schema. The test cases are updated to ensure proper type handling and include a new test case to verify regex functionality on the textstrings table.

Changes

Files Change Summary
packages/loot-core/src/platform/server/sqlite/index.electron.ts, packages/loot-core/src/platform/server/sqlite/index.web.ts Modified the regexp function to check if the text parameter is null or undefined, defaulting to an empty string to prevent errors during regex testing.
packages/loot-core/src/platform/server/sqlite/index.web.test.ts Introduced a new textstrings table in the SQLite schema, updated test cases to consistently use TypeScript's @ts-expect-error directive for type errors, and added a new test case for regex functionality on the textstrings table.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a8b3fda and 7953850.

Files selected for processing (1)
  • packages/loot-core/src/platform/server/sqlite/index.web.test.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/loot-core/src/platform/server/sqlite/index.web.test.ts

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

github-actions bot commented Sep 21, 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
9 5.29 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/usePreviewTransactions.js 1.59 kB 0%
static/js/AppliedFilters.js 20.97 kB 0%
static/js/narrow.js 80.95 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/wide.js 225.37 kB 0%
static/js/ReportRouter.js 1.5 MB 0%
static/js/index.js 3.31 MB 0%

Copy link
Contributor

github-actions bot commented Sep 21, 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.19 MB → 1.19 MB (+4 B) +0.00%
Changeset
File Δ Size
packages/loot-core/src/platform/server/sqlite/index.web.ts 📈 +6 B (+0.11%) 5.37 kB → 5.38 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

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

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@qedi-r qedi-r changed the title [WIP] update sql regexp to default to empty string when field is null update sql regexp to default to empty string when field is null Sep 21, 2024
@youngcw youngcw linked an issue Sep 21, 2024 that may be closed by this pull request
2 tasks
Copy link
Member

@MatissJanis MatissJanis left a comment

Choose a reason for hiding this comment

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

Overall LGTM. Lets just patch the typings.

Comment on lines 30 to 41
// @ts-expect-error Property 'number' does not exist on type 'unknown'
expect(rows[0].number).toBe(4);
expect((rows[0] as NumberRowType).number).toBe(4);
Copy link
Member

Choose a reason for hiding this comment

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

🔨 warning: ‏manual type coercions hide the type issue rather than address it. Furthermore: they can and do often lead to subtle, hard-to-catch bugs.

If we cannot patch this properly (i.e. by explicitly stating the runQuery return type), then the previous solution of using @ts-expect-error is actually better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh. I disagree that expect-error is better, adding linter exceptions creates a culture of accepting the problem, instead of fixing it at the level you are able, as well as having other issues. But, I also understand it's not my call, and code consistency matters, so I'll revert those changes.

@@ -27,7 +28,7 @@ describe('Web sqlite', () => {

let rows = runQuery(db, 'SELECT * FROM numbers', null, true);
expect(rows.length).toBe(1);
// @ts-expect-error Property 'number' does not exist on type 'unknown'
//@ts-expect-error: Property 'number' does not exist on type 'unknown'
Copy link
Member

Choose a reason for hiding this comment

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

🥜 nitpick: ‏would you mind undoing also these changes? Ideally the fingerprint of a PR should be as small as possible. And these comment changes are quite unnecessary. Thanks!

Suggested change
//@ts-expect-error: Property 'number' does not exist on type 'unknown'
// @ts-expect-error Property 'number' does not exist on type 'unknown'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, shoot, yep. Sorry.

Copy link
Member

@MatissJanis MatissJanis left a comment

Choose a reason for hiding this comment

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

Thanks! 🎉

@MatissJanis MatissJanis merged commit 634508a into actualbudget:master Sep 22, 2024
20 checks passed
matt-fidd added a commit that referenced this pull request Oct 3, 2024
* marked files for translation

* added release note

* fixed linting warnings

* 🐛 fix account filters being overridden (#3441)

* :electron: Reduce package size  (#3443)

* reduce package size of all packages

* release notes

* Update beforePackHook.ts

* [Maintenance] Cleanup react aria packages and dedupe (#3450)

* Cleanup react aria packages and dedupe

* Release notes

* ♻️ (synced-prefs) moving the prefs from metadata.json to the db (#3423)

* :electron: Restart server silently when adding self signed cert and add some logs (#3431)

* restart server silently on add self signed cert and add some logging

* release notes

* fix name

* updating names to be more specific

* removing setloading

* feedback

* ♻️ (synced-prefs) move budget type to synced prefs (#3427)

* update synced account balance in db if available (#3452)

* 🐛 (synced-prefs) fix bulk-reading not working in import modal (#3460)

* fix: csv import deduplication (#3456)

* ✨ release simplefin as a first-party feature (#3459)

Closes #2272

* Do not allow renaming to an empty category or group name (#3463)

* Do not allow renaming to an emoty category or group name

* Release notes

* [Mobile] Fix #3214 - Pull down to refresh triggering clicks on budget cells (#3374)

* Fix #3214

* Fix rollover indicator

* VRT

* Fix typecheck error

* VRT

* Release notes

* VRT

* Update style

* Fix budgeted

* VRT

* VRT

* Revert VRT

* VRT

* Fix style

* Revert usePreviewTransactions

* Fix error

* Fix reports form submit handlers (#3462)

* Fix form submit handlers

* Release notes

* :electron: Remove some old updater code (#3468)

* remove some old updater code

* remove old updater logic

* CSV import e2e tests (#3467)

* Fix React Aria Button hover styles  (#3453)

* Fiox hover styles and use className instead of inline to prepare for future css migration

* Release notes

* Cleanup

* Update edit rule hover style

* Undoable auto transfer notes + auto notes for cover (#3411)

* Undo auto transfer notes + auto notes for cover

* Release notes

* Fix notes

* Fix notes undo

* Do not show clicked category on transfer or cover menus

* Fix typecheck error

* typecheck

* Fix removeCategoriesFromGroups

* 🐛 (reports) deleting custom report should remove it from the dashboard (#3469)

* Revert "CSV import e2e tests (#3467)" (#3474)

This reverts commit 5e12d40.

* ♻️ (synced-prefs) separate metadata and local prefs out (#3458)

* :electron: Replace deprecated file protocol registration (#3475)

* replace deprecated file handler in electron

* release notes

* types eh

* types

* update sql regexp to default to empty string when field is null (#3480)

* ♻️ rename report/rollover budget to tracking/envelope (#3483)

* 🐛 (import) fix csv import checkboxes not working (#3478)

* Update tooltip and themes with better visibility (#3298)

* Update tooltip and themes with better visibility

* Rename merge request # into release notes

* rename release note

* update VRT

* tweak light theme

* dont put border on autocomplete menus

* update VRT

* tweak popover style

* simplify

* update VRT

* update VRT

---------

Co-authored-by: Dustin Conlon <[email protected]>
Co-authored-by: Dustin Conlon <[email protected]>
Co-authored-by: youngcw <[email protected]>

* fix modals on mobile BudgetTable (#3487)

* Fix privacy filter (#3472)

* Fix privacy filter

* Release notes

* Coderabbit suggestion

* VRT

* VRT

* Revert VRT

* VRT

* VRT

* VRT

* VRT

* Delete VRT

* VRT

* Revert VRT

* 🐛 fix custom reports crashing when opening table (#3484)

* 🧪 (tests) adding custom report e2e tests (#3493)

* ✨ (dashboards) ability to save filters & timeframes on spending widgets (#3432)

* marked files for translation

* Revert ":bug: fix account filters being overridden (#3441)"

This reverts commit 7336bad.

* Revert "Revert ":bug: fix account filters being overridden (#3441)""

This reverts commit 5cbadc4.

* Revert changes due to failed rebase

* removed import of t

* fixed lint warning

* added PayeeTableRow.tsx

* needed changes

* bugfix: pluralization

* variables adjustments

* removed doubled trans

---------

Co-authored-by: Matiss Janis Aboltins <[email protected]>
Co-authored-by: Michael Clark <[email protected]>
Co-authored-by: Joel Jeremy Marquez <[email protected]>
Co-authored-by: Matt Fiddaman <[email protected]>
Co-authored-by: Koen van Staveren <[email protected]>
Co-authored-by: Ryan Bianchi <[email protected]>
Co-authored-by: Robert Dyer <[email protected]>
Co-authored-by: Dustin Conlon <[email protected]>
Co-authored-by: Dustin Conlon <[email protected]>
Co-authored-by: youngcw <[email protected]>
Co-authored-by: Tim <[email protected]>
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]: regex sql function incorrectly matches against null strings
2 participants