fix(api): refactor color parameter validations to use transforms and fallbacks#6127
Closed
hardik-bhalekar wants to merge 1 commit into
Closed
fix(api): refactor color parameter validations to use transforms and fallbacks#6127hardik-bhalekar wants to merge 1 commit into
hardik-bhalekar wants to merge 1 commit into
Conversation
Contributor
|
@hardik-bhalekar is attempting to deploy a commit to the jhasourav07's projects Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
👋 Hey @hardik-bhalekar! Thanks for your contribution! 🎉 Unfortunately, this PR has been automatically closed because it is not linked to any open issue. To resolve this, please do the following:
We look forward to reviewing your PR once an issue is linked! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refactors Zod validation schemas in
lib/validations.tsto use inline.transform()with regex guards instead of.refine()for color hex parameters (bgStart,bgEnd,border) and thethemefield. Malformed values are now silently dropped to safe defaults rather than throwingZodError, preventing 400-level API failures for end users embedding streak cards.Problem
The
/api/streakroute uses Zod schemas to validate query parameters. When users supply malformed hex colors (e.g.,bgStart=xyz) or invalid theme names, the.refine()validators throw aZodError, surfacing a 400 error instead of gracefully falling back. This is a poor UX for a card-embedding endpoint where parameters are often hand-edited in URLs.Changes
lib/validations.tstheme.refine()threw if theme name was invalid.transform()falls back to'dark'for unknown theme namesbgStart.refine()threw if not valid hex.transform()returnsundefinedfor non-hex input (uses theme default)bgEnd.refine()threw if not valid hex.transform()returnsundefinedfor non-hex input (uses theme default)border.refine()+.transform()pipeline threw on bad hex.transform()returnsundefinedfor non-hex inputapp/api/streak/route.ts??) fallbacks forbgStart,bgEnd, andborderso thatundefinedvalues (from dropped malformed input) resolve to the selected theme's defaults instead of propagating asundefined.Design Decision
Using
.transform()over.refine()is intentional: it converts the validation step into a pure mapping function that always succeeds, making the API maximally lenient for URL-embedded use cases while still sanitizing inputs.Testing
npx tsc --noEmitpasses with zero errors'dark'