Skip to content

mysql - feat: (breaking) moving from keySize to keyLength#1866

Merged
jaredwray merged 3 commits intomainfrom
mysql---feat-(breaking)-moving-from-keySize-to-keyLength
Feb 25, 2026
Merged

mysql - feat: (breaking) moving from keySize to keyLength#1866
jaredwray merged 3 commits intomainfrom
mysql---feat-(breaking)-moving-from-keySize-to-keyLength

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: (breaking) moving from keySize to keyLength

@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 introduces a significant refactoring within the MySQL storage adapter by renaming a core configuration property. The change from keySize to keyLength provides a more semantically accurate description of the property's function, which defines the maximum length for keys in the database. Additionally, it refines the type definition for the iterationLimit property, ensuring better type safety and consistency. These updates aim to improve clarity and maintainability for the adapter.

Highlights

  • Breaking Change: Property Rename: The keySize configuration option has been renamed to keyLength across the MySQL storage adapter. This is a breaking change as existing configurations using keySize will need to be updated.
  • Type Correction for iterationLimit: The iterationLimit option's type definition has been corrected from string | number to number, reflecting its intended usage.
  • Internal Code Refactoring: All internal references, getters, setters, and database schema creation logic related to key length have been updated to use keyLength instead of keySize.
  • Documentation and Test Updates: The README.md documentation and unit tests have been updated to reflect the new keyLength property name and the corrected iterationLimit type.
Changelog
  • storage/mysql/README.md
    • Updated property name from keySize to keyLength in the properties list and example code.
    • Corrected the type definition for iterationLimit from string | number to number.
  • storage/mysql/src/index.ts
    • Renamed the private property _keySize to _keyLength.
    • Updated the public getter and setter from keySize to keyLength.
    • Modified the keyvMysqlKeys Set to reflect the keyLength property.
    • Adjusted the CREATE TABLE SQL statement to use keyLength for the VARCHAR size.
    • Updated constructor logic to initialize _keyLength from options.keyLength.
  • storage/mysql/src/types.ts
    • Renamed the keySize property to keyLength in the KeyvMysqlOptions interface.
  • storage/mysql/test/test.ts
    • Updated test assertions to check for keyLength instead of keySize.
    • Modified test cases to pass keyLength in constructor options and opts setter.
Activity
  • No human activity has occurred on this pull request yet.
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
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 introduces a breaking change by renaming the keySize option to keyLength for better clarity and consistency. The change has been applied consistently across the codebase, including the main logic, type definitions, tests, and documentation. My review focuses on ensuring the correctness and consistency of these changes. I've found one minor opportunity for code cleanup.

@jaredwray jaredwray merged commit 1ad599d into main Feb 25, 2026
8 checks passed
@jaredwray jaredwray deleted the mysql---feat-(breaking)-moving-from-keySize-to-keyLength branch February 25, 2026 01:50
@codecov
Copy link

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.92%. Comparing base (c1bda65) to head (964b0fb).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1866   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          32       32           
  Lines        2694     2694           
  Branches      471      471           
=======================================
  Hits         2692     2692           
  Misses          2        2           

☔ 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.

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