Events

[aaazzam]

This PR does a few things:

• uses orval to generate zod models to complement our autogenerate types. This lets us skip defining searchSchemas on every route.
• uses openapi-ts-query which extends our getQueryService to a full $api object which auto generates queryOptions. I suspect we can eschew a lot of our custom queryKey factories if we like this pattern.
• turns on codesplitting by route
• does a POC on the /events page to feel the new DX.

this PR now also includes a backend change:

• in prefect server our graph endpoint has a type like list[tuple[uuid, Node]] whose jsonschema relies on prefixItems, which is currently bugged out on orval (see Incorrect Zod schema generation for OpenAPI 3.1 prefixItems/tuple structures orval-labs/orval#1961)
• so I added a tag to these routes on the server, so I could exclude them in orval for now.
• this is some form of intentional tech debt (I'm adding richer metadata so I can exclude it from something that's broken)

[pleek91]

What else might we use the generated zod types for besides search params? Because I'm not sure how often the search params actually 1:1 line up with the api requests.

@devinvillarosa love to hear your thoughts on this too.

[devinvillarosa]

We can use the generated zod types for our forms as well.

But I think one of root issues is that our typings from openAPI is not 100% accurate.

I've had to add some additional logic to work with the generated typings (such as adding fields that are marked as required, but they should be optional)

[pleek91]

Do you think managing the imperfections will get more difficult with these generated zod types? Or could we extend them with the changes we need?

[aaazzam]

they should be optional

yeah for me I feel like working with the generated client from the server forces the server to be good.

IMO most code we write on the front to account for server typing mistakes is a smell

[pleek91]

@aaazzam I don't disagree, but I wonder if it will be something we just have to do sometimes because of backwards compatibility and cross compatibility requirements. Ideally every type issue we find we could just fix api side (been doing that already) 🤞

[pleek91]

If this can eliminate the manual query keys that would be awesome 👨‍🍳

[codspeed-hq]

CodSpeed Performance Report

Merging #17402 will not alter performance

_{Comparing events (2a7c6fa) with main (70b052c)}

Summary

✅ 2 untouched benchmarks

[aaazzam]

heads up @pleek91 i'm breaking this up b/c it's a little big IMO

first one is #17413