feat: use mysql2

[fengmk2]

cyjake/leoric#419

Summary by CodeRabbit

• Refactor
  • Updated the database management system to enhance performance and compatibility.
• Chores
  • Upgraded internal libraries to improve stability and security.

[coderabbitai]

Walkthrough

The recent updates involve transitioning from using the mysql library to mysql2 for database interactions in the project. Additionally, the ORM client leoric was upgraded. These changes are reflected in configuration settings, package dependencies, and import adjustments across various files.

Changes

Files	Change Summary
config/config.default.ts, package.json	Switched ORM client from mysql to mysql2; updated leoric and replaced mysql with mysql2.
test/TestUtil.ts	Updated the import statement to use mysql2 instead of mysql.

🐇✨
In the code garden, beneath the syntax trees,
A little rabbit hops with ease.
From mysql to mysql2, it leaps,
While the old code gently sleeps.
Cheers to updates, fresh and new,
Onwards we hop, to bugs we bid adieu! 🌟
🐇✨

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b94c8ef and d8676f7.

Files selected for processing (3)

• config/config.default.ts (1 hunks)
• package.json (1 hunks)
• test/TestUtil.ts (1 hunks)

Additional comments not posted (3)

package.json (1)

107-107: Replaced mysql with mysql2 version ^3.9.4. Confirm that all instances of mysql have been replaced across the project.

config/config.default.ts (1)

72-72: Updated ORM client to use mysql2. Ensure that the entire configuration is compatible with mysql2.

Verification successful

---

The output from the shell script confirms that the client: 'mysql2' setting is correctly implemented in the configuration file. Other mentions of "client" in the output are related to different configurations and do not pertain to the database client setting. Therefore, the change to use mysql2 as the ORM client is verified to be correctly implemented and there are no indications of incompatibility in the provided context.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the configuration settings are compatible with mysql2
rg --files-with-matches 'mysql2' --glob 'config.*.{js,ts}' | xargs grep 'client'

Length of output: 365

test/TestUtil.ts (1)

7-7: Updated import statement to use mysql2. Verify that all methods used in the tests are compatible with mysql2.

Verification successful

---

The verification process has confirmed that the file TestUtil.ts indeed uses the mysql2 library and contains multiple instances of the query method being used. This aligns with the updated import statement to use mysql2, as mentioned in the review comment. The presence of the query method in the context of mysql2 suggests that the necessary methods are being utilized correctly with the new library.

Given this information, the change to import mysql2 in TestUtil.ts is appropriate, and the methods used in the tests appear to be compatible with mysql2. Therefore, the review comment is consistent with the findings in the codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Check for any test methods that might not be compatible with mysql2
rg --files-with-matches 'mysql2' --glob 'TestUtil.*.{js,ts}' | xargs grep 'query'

Length of output: 228

---

---

Script:

#!/bin/bash
# Verify the existence of TestUtil.ts and check for the usage of mysql2 and query
fd 'TestUtil.ts' | xargs grep -E 'mysql2|query'

Length of output: 328

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher

🚮 Removed packages: npm/mysql@2.18.1, npm/npm-package-arg@10.1.0, npm/oss-cnpm@5.0.1, npm/p-map@4.0.0, npm/s3-cnpmcore@1.1.2, npm/semver@7.6.0, npm/ssri@8.0.1, npm/type-fest@2.19.0, npm/typescript@5.2.2, npm/ua-parser-js@1.0.37, npm/validate-npm-package-name@3.0.0

View full report↗︎

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Tip

Codebase Verification

The verification process did not yield relevant information regarding the compatibility of leoric with mysql2. The search results pertained to a different project, indicating that the necessary evidence to confirm compatibility was not found. Further investigation into leoric's official documentation or release notes specifically addressing mysql2 support might be required.

Analysis chain

Updated leoric to ^2.12.3. Ensure compatibility with mysql2 as part of this upgrade.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the new version of leoric supports mysql2
rg --files-with-matches 'mysql2' --glob '*.{js,ts}' | xargs grep 'leoric'

Length of output: 183

---

---

Script:

#!/bin/bash
# Search for mentions of mysql2 in the documentation or release notes of leoric
rg --files-with-matches 'mysql2' --glob '*.{md,txt}' | xargs grep -i 'support'

Length of output: 3729

[elrrrrrrr]

LGTM