fix: do not warn on valid known experiments #18514
Conversation
| export const isKnownExperiment = (experiment: string): boolean => { | ||
| return Experiments.includes(experiment as Experiment); | ||
| }; |
There was a problem hiding this comment.
Alternatively, we could have the FE return the list of known experiments, but it seems silly to do this when we can just use the auto-generated type.
| deploymentOptions: SerpentOption[]; | ||
| dailyActiveUsers: DAUsResponse | undefined; | ||
| readonly invalidExperiments: Experiments | string[]; | ||
| readonly safeExperiments: Experiments | string[]; | ||
| readonly invalidExperiments: readonly string[]; |
There was a problem hiding this comment.
review: this has to be a string because it might not be an Experiment
| @@ -118,7 +118,7 @@ export const invalidExperimentsEnabled: Story = { | |||
| hidden: false, | |||
| }, | |||
| ], | |||
| safeExperiments: ["shared-ports"], | |||
| safeExperiments: ["example"], | |||
There was a problem hiding this comment.
review: using the "example" experiment enum here instead
There was a problem hiding this comment.
Makes sense to me. Using a consistent experiment that we don't need to keep changing.
I wonder if example is the best name, but I do not have a better suggestion.
ExperimentPlaceholder, ExperimentDummy, idk.
| @@ -972,7 +972,7 @@ func New(options *Options) *API { | |||
| }) | |||
| r.Route("/experiments", func(r chi.Router) { | |||
| r.Use(apiKeyMiddleware) | |||
| r.Get("/available", handleExperimentsSafe) | |||
| r.Get("/available", handleExperimentsAvailable) | |||
There was a problem hiding this comment.
Kinda unfortunate we have /available that returns only the safe experiments. Ideally there would be a /available and /safe. Or just have /available return a map[string]bool where the bool is true for safe or something.
There was a problem hiding this comment.
Yeah I considered also returning all available experiments here but elected to keep the scope of this PR small.
| if !slice.Contains(codersdk.ExperimentsKnown, ex) { | ||
| log.Warn(context.Background(), "ignoring unknown experiment", slog.F("experiment", ex)) | ||
| } else if !slice.Contains(codersdk.ExperimentsSafe, ex) { |
Fixes #18024
handleExperimentsSafetohandleExperimentsAvailableto better match semanticscodersdk.ExperimentsKnownand updatesReadExperimentsto log on invalid experimentscodersdk.Experimentsso apitypings generates a valid enum list of possible values of experiment