fix(json-schema): enhance array to map coercion to handle unique keys - #811
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
Bot
added
the
size:S
WalkthroughThe changes clarify documentation for the "Array → Map" conversion rule in the Smart Coercion Plugin, update the coercion logic to prevent converting arrays with duplicate keys into Maps, and add a test to verify this behavior. The implementation now checks for duplicate keys before converting arrays to Maps. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Coercer
User->>Coercer: Coerce array of key-value pairs to Map
Coercer->>Coercer: Check for duplicate keys
alt No duplicate keys
Coercer->>User: Return Map object
else Duplicate keys present
Coercer->>User: Return coerced array (not Map)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @unnoq, 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 addresses a potential data integrity issue in the JSON Schema coercer's array-to-map conversion. It introduces a safeguard to ensure that if an array intended for Map coercion contains duplicate keys, the coercion process does not silently drop entries. Instead, it now returns the original array, preventing data loss and making the behavior explicit. The documentation has also been updated to reflect this requirement for unique keys.
Highlights
- Data Integrity Fix: Implemented a crucial check within the JSON Schema coercer to prevent silent data loss when attempting to coerce arrays containing duplicate keys into
Mapobjects. Previously, duplicate entries would be silently dropped. - Coercion Behavior Enhancement: The array-to-map coercion now explicitly fails (by returning the original array) if the input array contains non-unique keys. This ensures that the resulting
Mapaccurately reflects the input's uniqueness expectation, or the original data is preserved if the expectation is violated. - Documentation Clarity: Updated the documentation for array-to-map coercion to clearly state that it expects arrays with unique keys, aligning the documentation with the enhanced coercion logic.
- Test Coverage: Added a new test case to validate the updated coercion behavior, specifically confirming that an array with duplicate keys is returned unchanged when
x-native-type: 'map'coercion is applied.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request enhances the array-to-map coercion logic to handle arrays with duplicate keys. The implementation in coercer.ts prevents the creation of a map if duplicate keys are found, returning the original array instead. The documentation in smart-coercion.md has been updated to reflect this change, and a test case has been added to verify the new logic. The review includes a suggestion to refine the test case for better clarity.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-event-iterator
@orpc/hey-api
@orpc/json-schema
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/react
@orpc/react-query
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 participant
Summary by CodeRabbit
Bug Fixes
Documentation
Tests