Skip to content

mysql - feat: createKeyv helper and options cleanup#1868

Merged
jaredwray merged 6 commits intomainfrom
mysql---feat-createKeyv-helper-and-options-cleanup
Feb 25, 2026
Merged

mysql - feat: createKeyv helper and options cleanup#1868
jaredwray merged 6 commits intomainfrom
mysql---feat-createKeyv-helper-and-options-cleanup

Conversation

@jaredwray
Copy link
Owner

@jaredwray jaredwray commented Feb 25, 2026

Please check if the PR fulfills these requirements

  • Followed the Contributing and Code of Conduct guidelines.
  • Tests for the changes have been added (for bug fixes/features) with 100% code coverage.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
mysql - feat: createKeyv helper and options cleanup

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jaredwray, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the MySQL Keyv adapter's option handling mechanism to enhance type safety and streamline configuration. It introduces a clearer separation between Keyv-specific options and underlying mysql2 connection options, making the adapter's initialization and internal option management more robust and maintainable. The changes simplify the API by removing a dynamic options setter and explicitly defining method visibility.

Highlights

  • Improved Type Safety for MySQL Options: The _mysqlOptions property in KeyvMysql has been updated to use the ConnectionOptions type from mysql2, providing stricter type checking for MySQL connection configurations.
  • Refactored Option Handling: The constructor now directly processes KeyvMysqlOptions, explicitly setting Keyv-specific properties and delegating the extraction of mysql2 connection options to a new generateMySqlOptions helper function. This replaces the previous setOptions method and the keyvMysqlKeys filter.
  • Removed opts Setter: The opts setter, which allowed dynamic updates to adapter options, has been removed, simplifying the option management lifecycle.
  • Method Visibility Standardized: Several asynchronous methods within the KeyvMysql class, such as get, set, delete, and clear, have been explicitly marked as public.
Changelog
  • storage/mysql/src/index.ts
    • Imported ConnectionOptions type from mysql2 for improved type safety.
    • Removed the keyvMysqlKeys constant, which was previously used to filter Keyv-specific options.
    • Updated the _mysqlOptions property type from Record<string, unknown> to ConnectionOptions.
    • Changed the query method's visibility to public.
    • Removed the opts setter method.
    • Refactored the constructor to directly parse KeyvMysqlOptions and assign properties, introducing a new generateMySqlOptions helper.
    • Moved and reordered private helper methods (removeKeyPrefix, getNamespaceValue, getExpiresFromValue) to the end of the class definition.
    • Added a new private generateMySqlOptions method to extract mysql2 connection options using object destructuring.
    • Changed the visibility of get, getMany, set, setMany, delete, deleteMany, clear, iterator, has, hasMany, clearExpired, and disconnect methods to public.
  • storage/mysql/test/test.ts
    • Removed the test case for the opts setter, aligning with its removal from the KeyvMysql class.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 34f0743f3f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the options handling in the KeyvMysql adapter, introducing a new helper function generateMySqlOptions and cleaning up the constructor. The changes improve code clarity by making methods explicitly public and organizing private helpers. However, the new options filtering logic is incomplete and allows some Keyv-specific options to be passed to the mysql2 driver. I've suggested a fix to ensure all non-MySQL options are properly filtered.

@codecov
Copy link

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.96%. Comparing base (8012bdb) to head (0469a3a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1868      +/-   ##
==========================================
+ Coverage   99.92%   99.96%   +0.03%     
==========================================
  Files          32       32              
  Lines        2694     2694              
  Branches      471      472       +1     
==========================================
+ Hits         2692     2693       +1     
+ Misses          2        1       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jaredwray jaredwray merged commit 1655532 into main Feb 25, 2026
8 checks passed
@jaredwray jaredwray deleted the mysql---feat-createKeyv-helper-and-options-cleanup branch February 25, 2026 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant