feat: migrate experiments config from array to bools #398
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,9 @@ package config | |
| import ( | ||
| "context" | ||
| "fmt" | ||
| "maps" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| "github.com/slackapi/slack-cli/internal/experiment" | ||
| "github.com/slackapi/slack-cli/internal/slackerror" | ||
|
|
@@ -29,47 +31,73 @@ func (c *Config) LoadExperiments( | |
| ctx context.Context, | ||
| printDebug func(ctx context.Context, format string, a ...interface{}), | ||
| ) { | ||
| experiments := map[string]bool{} | ||
| // Load from flags | ||
| for _, flagValue := range c.ExperimentsFlag { | ||
| experiments[flagValue] = true | ||
| } | ||
|
Member
There was a problem hiding this comment. 👁️🗨️ thought: The order of experiment parsing might need to be reversed so that project and user configurations can be overridden with a flag if the lower settings use a "false" value?
Member
Author
There was a problem hiding this comment. @zimeg 🙇🏻 Very good catch! Commit f0c8bc3 updates the order to be:
question: Not sure where Permanently enabled should be. I feel we would be better served to rename it to "Enabled by Default" and allow developers to opt-out in case there is a known bug. If we keep it as Permanently enabled, then we may want it to be after Flags to override all other settings.
Member
There was a problem hiding this comment.
@mwbrooks Thanks! I'm a big fan of this approach! I understand flag experimental flag values to be |
||
| printDebug(ctx, fmt.Sprintf("active flag experiments: %s", formatExperimentMap(experiments))) | ||
| // Load from project config file | ||
| projectConfig, err := ReadProjectConfigFile(ctx, c.fs, c.os) | ||
| if err != nil && slackerror.ToSlackError(err).Code != slackerror.ErrInvalidAppDirectory { | ||
| printDebug(ctx, fmt.Sprintf("failed to parse project-level config file: %s", err)) | ||
| } else if err == nil { | ||
| printDebug(ctx, fmt.Sprintf("active project experiments: %s", formatExperimentMap(projectConfig.Experiments))) | ||
| maps.Copy(experiments, projectConfig.Experiments) | ||
| } | ||
| // Load from system config file | ||
| userConfig, err := c.SystemConfig.UserConfig(ctx) | ||
| if err != nil { | ||
| printDebug(ctx, fmt.Sprintf("failed to parse system-level config file: %s", err)) | ||
| } else { | ||
| printDebug(ctx, fmt.Sprintf("active system experiments: %s", formatExperimentMap(userConfig.Experiments))) | ||
| maps.Copy(experiments, userConfig.Experiments) | ||
| } | ||
| // Load from permanently enabled list | ||
| for _, exp := range experiment.EnabledExperiments { | ||
| experiments[string(exp)] = true | ||
| } | ||
| printDebug(ctx, fmt.Sprintf("active permanently enabled experiments: %s", experiment.EnabledExperiments)) | ||
| // Audit the experiments | ||
| c.experiments = experiments | ||
| for name := range c.experiments { | ||
| if !experiment.Includes(experiment.Experiment(name)) { | ||
| printDebug(ctx, fmt.Sprintf("invalid experiment found: %s", name)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // GetExperiments returns the set of active experiments | ||
| func (c *Config) GetExperiments() []experiment.Experiment { | ||
| result := make([]experiment.Experiment, 0, len(c.experiments)) | ||
| for name, enabled := range c.experiments { | ||
| if enabled { | ||
| result = append(result, experiment.Experiment(name)) | ||
| } | ||
| } | ||
| sort.Slice(result, func(i, j int) bool { | ||
| return result[i] < result[j] | ||
| }) | ||
| return result | ||
| } | ||
|
|
||
| // WithExperimentOn checks whether an experiment is currently toggled on | ||
| func (c *Config) WithExperimentOn(experimentToCheck experiment.Experiment) bool { | ||
| return c.experiments[string(experimentToCheck)] | ||
| } | ||
|
|
||
| // formatExperimentMap returns a string representation of the experiments map | ||
| // for debug logging, formatted similar to the old slice format. | ||
| func formatExperimentMap(m map[string]bool) string { | ||
| if len(m) == 0 { | ||
| return "[]" | ||
| } | ||
| names := make([]string, 0, len(m)) | ||
| for name, enabled := range m { | ||
| if enabled { | ||
| names = append(names, name) | ||
| } | ||
| } | ||
| sort.Strings(names) | ||
| return "[" + strings.Join(names, " ") + "]" | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // Copyright 2022-2026 Salesforce, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package config | ||
|
|
||
| import "encoding/json" | ||
|
|
||
| // unmarshalExperimentsField handles backwards-compatible unmarshaling of the | ||
| // experiments field. It accepts both the old array format (["charm", "sandboxes"]) | ||
| // and the new map format ({"charm": true, "sandboxes": true}). | ||
| func unmarshalExperimentsField(raw json.RawMessage) map[string]bool { | ||
| if len(raw) == 0 { | ||
| return nil | ||
| } | ||
|
|
||
| // Try new map format first | ||
| var mapFormat map[string]bool | ||
| if err := json.Unmarshal(raw, &mapFormat); err == nil { | ||
| return mapFormat | ||
| } | ||
|
|
||
| // Fall back to old array format | ||
| var arrayFormat []string | ||
| if err := json.Unmarshal(raw, &arrayFormat); err == nil { | ||
| if len(arrayFormat) == 0 { | ||
| return nil | ||
| } | ||
| result := make(map[string]bool, len(arrayFormat)) | ||
| for _, exp := range arrayFormat { | ||
| result[exp] = true | ||
| } | ||
| return result | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🪬 question: Can we continue to use strict types of
experimentor is this not allowed as a key?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@zimeg Great suggestion and I should have caught that myself. I think we can use
map[experiment.Experiment]bool, so let me look into refactoring it 💻There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commit a70d3ee uses the strict types:
A helper method had to be created to copy from the JSON format to the strict type.