Dynamic config resolver schemas and types #793
Conversation
This file contains 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
| 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
| @@ -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"
| } satisfies LoadedConfigs<typeof configs>); | ||
| }); | ||
|
|
||
| // should throw an error if the resolved value does not match the schema |
There was a problem hiding this comment.
Suggested change
| // should throw an error if the resolved value does not match the schema |
| }; | ||
|
|
||
| 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>
| @@ -21,7 +24,7 @@ export default async function getConfigValue<K extends ConfigKeysWithoutArgs>( | |||
|
|
|||
| export default async function getConfigValue<K extends keyof LoadedConfigs>( | |||
| key: K, | |||
| arg?: ArgOfConfigResolver<K> | |||
| arg?: ArgsOfLoadedConfigResolver<K> | |||
| ): Promise<LoadedConfigValue<K>> { | |||
| if (typeof window !== 'undefined') { | |||
There was a problem hiding this comment.
Is this line different from using 'server-only'?
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
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