Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

groq-builder: zod compatibility #257

Merged
merged 52 commits into from
Feb 5, 2024
Merged

groq-builder: zod compatibility #257

merged 52 commits into from
Feb 5, 2024

Conversation

scottrippey
Copy link
Member

@scottrippey scottrippey commented Jan 23, 2024 •
edited
Loading

What

Ensures full compatibility with Zod.
Ditches the "lite validation" that I had implemented.
If Zod is not used, it can still be tree-shaken with this approach, so it's still an "optional" dependency.

Additional changes:

  • Type improvements, documentation as per feedback from @bkonkle
  • Added validationRequired: true flag, for enforcing runtime validation if desired
  • Removed $ from q.conditional$ and q.select$ methods; these are now just q.conditional and q.select
  • Improved all projections, so that "optional" values are correctly mapped as | null types

@vercel Vercel
Copy link

vercel bot commented Jan 23, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
groqd ⬜️ Ignored (Inspect) Visit Preview Feb 4, 2024 0:52am

scottrippey added 15 commits January 24, 2024 10:44
feature(cleanup): renamed to InferResultItem
0a71280
feature(cleanup): moved type utils into a ResultItem namespace
5b9e735
feature(cleanup): use type-fest types, and removed unused types
faa43d7
feature(cleanup): removed useless $ convention
1728311
feature(infer): updated naked projections (.field, projection tuple…
42cb7e6 
…s) with mandatory parser
Merge branch 'infer' into gb/type-cleanup
beb9723 
# Conflicts:
#	packages/groq-builder/src/commands/projectField.ts
Revert "feature(infer): updated naked projections (.field, projecti…
edfce71 
…on tuples) with mandatory parser"

This reverts commit 42cb7e6
Revert "feature(infer): implemented q.infer() for inferred result t…
b5031ba 
…ypes"

This reverts commit ac59a43
feature(cleanup): allow q.field to accept a parser
8e2783c
feature(cleanup): updated tests to use zod
4adb1b2
feature(validationRequired): added validationRequired flag
c108584
feature(validationRequired): implemented validationRequired field for…
43f85b1 
… naked projections
feature(validationRequired): implemented validationRequired field for…
721bc46 
… projections
changeset
2f0d49c
Merge remote-tracking branch 'origin/main' into zod-again
87daeab 
# Conflicts:
#	packages/groq-builder/src/commands/select.ts
@scottrippey scottrippey marked this pull request as ready for review January 26, 2024 21:07
BrianWalters
BrianWalters approved these changes Jan 30, 2024
View reviewed changes
Copy link
Contributor

@BrianWalters BrianWalters left a comment

Choose a reason for hiding this comment

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

It looks good to me, although a lot of this is over my head. Making Zod tree-shakable is important.

scottrippey added 17 commits January 30, 2024 13:43
feature(zod): support Parser input widening
9ef6cfb
feature(projection): massively improved error messages for projections
f25000f
feature(projection): updated tests
9e7a08e
feature(projection): removed custom expectType, replaced with `expe…
9ac6394 
…ctTypeOf` from vitest
feature(zod): updated MIGRATION with updated Zod examples
649260f
feature(zod): added createGroqBuilderWithZod method to simplify API
050602e
feature(zod): moved nullToUndefined into zod namespacr
3d21527
feature(zod): when chaining methods, check to ensure parsers are not …
9a8553a 
…added before queries
feature(zod): implemented .nullable()
c747b36
feature(zod): moved q.slug into zod, since that's the only place it…
c4926e9 
…'s useful
feature(zod): make chain's parser optional
e847f75
feature(zod): removed unused validation/lite
538a6ba
feature(zod): ensure naked projection parsers are validated
6d73677
feature(zod): properly preserve null values in naked projections
8d30788
feature(zod): properly preserve null values in naked projections
62b8040
feature(zod): removed unused import
db6cfbe
feature(zod): updated changeset
a8da1a7
@scottrippey scottrippey merged commit a6e10ab into main Feb 5, 2024
5 checks passed
@scottrippey scottrippey deleted the zod-again branch February 5, 2024 15:13
@github-actions github-actions bot mentioned this pull request Feb 5, 2024
Merged
@scottrippey
Copy link
Member Author

I added like a hundred more commits :) I had a lot of things on the mind to fix and improve!

@heggemsnes
Copy link
Contributor

@scottrippey not sure if this is the right format but using Zod for all validation will certainly slow down the editors and possibly noticable runtime validations as queries become complex.

Added a bit context in #261 but after using Groqd for >10 production projects we are scrambling for an option as developer experience has become intolerable.

@scottrippey
Copy link
Member Author

I'd love to discuss!
For our next major release, we've made zod optional, so maybe that will help with your performance issues. However, we've added a lot more TypeScript in order to enable auto completion too.

I'd love to hear more about the kind of performance issues you've experienced. Are these run time issues? Or TypeScript + IDE performance issues?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BrianWalters BrianWalters BrianWalters approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@scottrippey @heggemsnes @BrianWalters