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

🔧 upgrade better-sqlite3 #524

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Conversation

FliegendeWurst
Copy link
Contributor

@FliegendeWurst FliegendeWurst commented Dec 15, 2024

This version has better support for recent (v22+) Node versions.

@actual-github-bot actual-github-bot bot changed the title 🔧 upgrade better-sqlite3 [WIP] 🔧 upgrade better-sqlite3 Dec 15, 2024
@FliegendeWurst FliegendeWurst force-pushed the master branch 2 times, most recently from 9cf884a to b5da47a Compare December 15, 2024 05:57
@FliegendeWurst FliegendeWurst changed the title [WIP] 🔧 upgrade better-sqlite3 🔧 upgrade better-sqlite3 Dec 15, 2024
Copy link
Contributor

coderabbitai bot commented Dec 15, 2024

Walkthrough

The pull request involves an update to the package.json file, specifically addressing changes in the dependencies and devDependencies sections. The version of the better-sqlite3 package has been upgraded from ^9.6.0 to ^11.7.0. Additionally, the version of the @types/better-sqlite3 package has been updated from ^7.6.7 to ^7.6.12. No other modifications to dependencies, scripts, or other sections of the file have been made. The overall structure and content of the package.json remain intact, with only these specific dependency version changes noted.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


📜 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 b5da47a and f2de20b.

⛔ Files ignored due to path filters (2)
  • upcoming-release-notes/524.md is excluded by !**/*.md
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (1)
  • package.json (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 645958b and b5da47a.

⛔ Files ignored due to path filters (2)
  • upcoming-release-notes/524.md is excluded by !**/*.md
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (1)
  • package.json (1 hunks)
🔇 Additional comments (2)
package.json (2)

26-26: Consider updating @types/better-sqlite3

The type definitions package might need to be updated to match the new better-sqlite3 version.

Also applies to: 44-44


Line range hint 67-69: Consider updating the minimum Node.js version

Since this upgrade is specifically for better Node.js v22+ support, consider updating the engines field to reflect the minimum supported Node.js version required by better-sqlite3 v11.

@@ -23,7 +23,7 @@
"@actual-app/crdt": "2.1.0",
"@actual-app/web": "24.12.0",
"bcrypt": "^5.1.1",
"better-sqlite3": "^9.6.0",
"better-sqlite3": "^11.7.0",
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 15, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

Update @types/better-sqlite3 and verify Node.js compatibility

The codebase uses standard better-sqlite3 patterns (prepare, transaction, exec) that are stable across versions. However, two items need attention:

  • The @types/better-sqlite3 package is at v7.6.7 while better-sqlite3 is being upgraded to v11.7.0. Update @types/better-sqlite3 to a compatible version (^9.0.0).
  • Your package.json requires Node.js >= 18.0.0, which is compatible with better-sqlite3 v11.7.0.

Usage patterns in your codebase:

  • Basic SQL operations (prepare, run, all)
  • Transactions
  • No usage of deprecated or removed features
🔗 Analysis chain

Verify compatibility with the major version upgrade

The upgrade from better-sqlite3 v9 to v11 involves breaking changes. Let's verify the compatibility:

Additionally, please review the breaking changes in the better-sqlite3 changelog to ensure your usage patterns are compatible.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check compatibility and breaking changes

# Check better-sqlite3's package.json for Node.js version requirements
curl -s https://registry.npmjs.org/better-sqlite3/11.7.0 | jq -r '.engines.node'

# Search for SQL-related code that might be affected by breaking changes
rg -l "\.prepare\(|\.transaction\(|\.pragma\(" --type js --type ts

# Check if there are any migration files that might need updates
fd -e sql

Length of output: 331


Script:

#!/bin/bash
# Let's check the actual SQL usage patterns in the files to verify compatibility

# Check db.js for database initialization and core patterns
echo "=== db.js ==="
rg -A 5 "\.prepare\(|\.transaction\(|\.pragma\(" src/db.js

# Check SQL patterns in migration file
echo -e "\n=== migrations/1719409568000-multiuser.js ==="
rg -A 5 "\.prepare\(|\.transaction\(|\.pragma\(" migrations/1719409568000-multiuser.js

# Check content of SQL file
echo -e "\n=== src/sql/messages.sql ==="
cat src/sql/messages.sql

# Check current @types/better-sqlite3 version
echo -e "\n=== @types/better-sqlite3 in package.json ==="
rg "@types/better-sqlite3" package.json

Length of output: 1242

Copy link
Contributor Author

Choose a reason for hiding this comment

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

types updated to 7.6.12. Version 9.0.0 was hallucinated.

Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

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!

I've been running it for a couple of days on my instance and it's been completely fine, there are no electron concerns here either because it's the server.

@matt-fidd matt-fidd merged commit efb50ed into actualbudget:master Dec 18, 2024
8 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.

2 participants