Dynamic config resolver schemas and types #793
Conversation
| COMPUTED: ConfigSyncResolverDefinition<[string], [string]>; | ||
| DYNAMIC: ConfigAsyncResolverDefinition<undefined, number>; | ||
| GRPC_SERVICES_NAMES: ConfigEnvDefinition<true>; | ||
| DYNAMIC: ConfigAsyncResolverDefinition<undefined, number, 'serverStart'>; |
There was a problem hiding this comment.
Since these are test configs, it would be good to add a comment above them like you did on Line 41.
There was a problem hiding this comment.
IMO the best option would be to have a separate config file specifically for tests
There was a problem hiding this comment.
I'm going to remove all of the unused/test configs in my second upcomming PR
| @@ -30,17 +36,32 @@ const dynamicConfigs: { | |||
| GRPC_SERVICES_NAMES: { | |||
| env: 'NEXT_PUBLIC_CADENCE_GRPC_SERVICES_NAMES', | |||
| default: 'cadence-frontend', | |||
| isPublic: true, | |||
| }, | |||
| // For testing purposes | |||
| DYNAMIC: { | |||
There was a problem hiding this comment.
Since these are test configs anyway, "ASYNC" and "SYNC" would be more meaningful than "DYNAMIC" and "COMPUTED"
There was a problem hiding this comment.
Removing it in my second upcoming PR
| }; | ||
|
|
||
| export type ConfigEnvDefinition = { | ||
| export type ConfigEnvDefinition<IsPublic extends boolean = false> = { |
There was a problem hiding this comment.
nit (as discussed): a union type would be nicer here, just so that we can write ConfigEnvDefinition<'public'> instead of ConfigEnvDefinition<true>
Co-authored-by: Adhitya Mamallan <adi1998is@gmail.com>
Summary
Adding validation schemas for config resolvers (args/return types) & use those schemas to validate the input/output of resolvers on runtime.
Add
evaluateOnflag to configs to define when resolvers are being executed. It supportsrequest&serverStart.Add
isPublicflag to configs to identify which configs are accessible from client code.Changes
getTransformedConfigstotransformConfigsfor better testing (doing the same forget-config-value.tsin upcomming PR)evaluateOn&isPublicflagsUpcoming plans
get-config-value.ts