fix: Allow overriding env variable names, restore CODER_TELEMETRY

mafredri · mafredri · commit 48d852b65468 · 2022-11-04T12:31:53.000+02:00
diff --git a/cli/deployment/config.go b/cli/deployment/config.go
@@ -239,6 +239,7 @@ func newConfig() *codersdk.DeploymentConfig {
 				Name:    "Telemetry Enable",
 				Usage:   "Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.",
 				Flag:    "telemetry",
+				Env:     "CODER_TELEMETRY", // Override default environment.
 				Default: flag.Lookup("test.v") == nil,
 			},
 			Trace: &codersdk.DeploymentConfigField[bool]{
@@ -396,22 +397,26 @@ func setConfig(prefix string, vip *viper.Viper, target interface{}) {
 	// otherwise Viper will get confused if the parent struct is
 	// assigned a value.
 	if strings.HasPrefix(typ.Name(), "DeploymentConfigField[") {
+		env := val.FieldByName("Env").String()
+		if env == "" {
+			env = formatEnv(prefix)
+		}
 		value := val.FieldByName("Value").Interface()
 		switch value.(type) {
 		case string:
-			vip.MustBindEnv(prefix, formatEnv(prefix))
+			vip.MustBindEnv(prefix, env)
 			val.FieldByName("Value").SetString(vip.GetString(prefix))
 		case bool:
-			vip.MustBindEnv(prefix, formatEnv(prefix))
+			vip.MustBindEnv(prefix, env)
 			val.FieldByName("Value").SetBool(vip.GetBool(prefix))
 		case int:
-			vip.MustBindEnv(prefix, formatEnv(prefix))
+			vip.MustBindEnv(prefix, env)
 			val.FieldByName("Value").SetInt(int64(vip.GetInt(prefix)))
 		case time.Duration:
-			vip.MustBindEnv(prefix, formatEnv(prefix))
+			vip.MustBindEnv(prefix, env)
 			val.FieldByName("Value").SetInt(int64(vip.GetDuration(prefix)))
 		case []string:
-			vip.MustBindEnv(prefix, formatEnv(prefix))
+			vip.MustBindEnv(prefix, env)
 			// As of October 21st, 2022 we supported delimiting a string
 			// with a comma, but Viper only supports with a space. This
 			// is a small hack around it!
@@ -569,15 +574,20 @@ func setFlags(prefix string, flagset *pflag.FlagSet, vip *viper.Viper, target in
 		if flg == "" {
 			return
 		}
+
+		env := val.FieldByName("Env").String()
+		if env == "" {
+			env = formatEnv(prefix)
+		}
 		usage := val.FieldByName("Usage").String()
-		usage = fmt.Sprintf("%s\n%s", usage, cliui.Styles.Placeholder.Render("Consumes $"+formatEnv(prefix)))
+		usage = fmt.Sprintf("%s\n%s", usage, cliui.Styles.Placeholder.Render("Consumes $"+env))
 		shorthand := val.FieldByName("Shorthand").String()
 		hidden := val.FieldByName("Hidden").Bool()
 		value := val.FieldByName("Default").Interface()
 
 		// Allow currently set environment variables
 		// to override default values in help output.
-		vip.MustBindEnv(prefix, formatEnv(prefix))
+		vip.MustBindEnv(prefix, env)
 
 		switch value.(type) {
 		case string:
diff --git a/cli/deployment/config_test.go b/cli/deployment/config_test.go
@@ -35,7 +35,7 @@ func TestConfig(t *testing.T) {
 			"CODER_PROVISIONER_DAEMONS":  "5",
 			"CODER_SECURE_AUTH_COOKIE":   "true",
 			"CODER_SSH_KEYGEN_ALGORITHM": "potato",
-			"CODER_TELEMETRY":            "false",
+			"CODER_TELEMETRY":            "true",
 			"CODER_TELEMETRY_TRACE":      "false",
 			"CODER_WILDCARD_ACCESS_URL":  "something-wildcard.com",
 		},
@@ -50,7 +50,7 @@ func TestConfig(t *testing.T) {
 			require.Equal(t, config.ProvisionerDaemons.Value, 5)
 			require.Equal(t, config.SecureAuthCookie.Value, true)
 			require.Equal(t, config.SSHKeygenAlgorithm.Value, "potato")
-			require.Equal(t, config.Telemetry.Enable.Value, false)
+			require.Equal(t, config.Telemetry.Enable.Value, true)
 			require.Equal(t, config.Telemetry.Trace.Value, false)
 			require.Equal(t, config.WildcardAccessURL.Value, "something-wildcard.com")
 		},
diff --git a/codersdk/deploymentconfig.go b/codersdk/deploymentconfig.go
@@ -131,6 +131,7 @@ type DeploymentConfigField[T Flaggable] struct {
 	Name       string `json:"name"`
 	Usage      string `json:"usage"`
 	Flag       string `json:"flag"`
+	Env        string `json:"env"`
 	Shorthand  string `json:"shorthand"`
 	Enterprise bool   `json:"enterprise"`
 	Hidden     bool   `json:"hidden"`
@@ -146,6 +147,7 @@ func (f *DeploymentConfigField[T]) MarshalJSON() ([]byte, error) {
 		Name       string `json:"name"`
 		Usage      string `json:"usage"`
 		Flag       string `json:"flag"`
+		Env        string `json:"env"`
 		Shorthand  string `json:"shorthand"`
 		Enterprise bool   `json:"enterprise"`
 		Hidden     bool   `json:"hidden"`
@@ -156,6 +158,7 @@ func (f *DeploymentConfigField[T]) MarshalJSON() ([]byte, error) {
 		Name:       f.Name,
 		Usage:      f.Usage,
 		Flag:       f.Flag,
+		Env:        f.Env,
 		Shorthand:  f.Shorthand,
 		Enterprise: f.Enterprise,
 		Hidden:     f.Hidden,
