Orval generator POC

[Tymek]

About the changes

POC for #2715

Important files

• frontend/orval.config.js
• frontend/src/openapi/fetcher.ts

[vercel]

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

Name	Status	Preview	Comments	Updated
unleash-monorepo-frontend	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Jan 5, 2023 at 10:25AM (UTC)

1 Ignored Deployment

Name	Status	Preview	Comments	Updated
unleash-docs	⬜️ Ignored (Inspect)			Jan 5, 2023 at 10:25AM (UTC)

[kwasniew]

Can we put this (the actual usage) behind a feature flag so that we can turn it on/off at any time. This is a very dangerous change so I'd like to be on the safe side.

[FredrikOseberg]

I think this makes sense. For types I'm happy to start right away. For the API integration I think we should wait until we can validate properly and over time. We can for example try the fetchers on new features, put them behind feature flags and try it out as we are developing instead of modifying existing endpoints.

This way, we'll find edge cases while we are developing, and we can figure out if the generator provides a pleasant experience, or if we are just moving around the technical debt.

[Tymek]

@FredrikOseberg @kwasniew About putting it behind a flag: I only substituted 2 OpenAPI getters that where used before (get features and get features archive). All model/Schema names where compatible. We still have frontend/src/interfaces written by hand (that IMHO we should mostly deprecate).

Files that where using previous auto-generated fetcher that I refactored:

• frontend/src/component/archive/ProjectFeaturesArchiveTable.tsx
• frontend/src/hooks/api/actions/useFeatureApi/useFeatureApi.ts
• frontend/src/hooks/api/getters/useFeaturesArchive/useFeaturesArchive.ts

[kwasniew]

We tried this approach in change requests and it didn't work. Please check SWR recommended approach: https://swr.vercel.app/docs/conditional-fetching. We have our own hook useConditionalSWR encapsulating the logic.

[FredrikOseberg]

Nice! Can be merged after addressing comments.

[sjaanus]

Couple of questions to cover everything.

1. Do we have example how we regenerate the schema, when we add new endpoint to the backend?
2. If I understand correctly, for useFeatureApi we are now using Orval. When looking at that file, does this mean, we still need to know the path and http method by heart? Orval does not generate that?

[Tymek]

@sjaanus

Couple of questions to cover everything.

1. Do we have example how we regenerate the schema, when we add new endpoint to the backend?

There is a comment in orval.config.js. Scripts in package.json are fairly easy to understand:

"gen:api": "orval --config orval.config.js",
"gen:api:demo": "UNLEASH_OPENAPI_URL=https://app.unleash-hosted.com/demo/docs/openapi.json yarn run gen:api",

2. If I understand correctly, for useFeatureApi we are now using Orval. When looking at that file, does this mean, we still need to know the path and http method by heart? Orval does not generate that?

We don't use methods/actions yet. For now we only use generated types.