|
| 1 | +package cmd |
| 2 | + |
| 3 | +import ( |
| 4 | + "os" |
| 5 | + "sort" |
| 6 | + "strconv" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "github.com/google/uuid" |
| 10 | + "github.com/spf13/cobra" |
| 11 | + "github.com/spf13/pflag" |
| 12 | + "github.com/supabase/cli/internal/telemetry" |
| 13 | + "github.com/supabase/cli/internal/utils" |
| 14 | + "github.com/supabase/cli/internal/utils/agent" |
| 15 | + "golang.org/x/term" |
| 16 | +) |
| 17 | + |
| 18 | +const ( |
| 19 | + telemetrySafeValueAnnotation = "supabase.com/telemetry-safe-value" |
| 20 | + redactedTelemetryValue = "<redacted>" |
| 21 | + maxTelemetryEnvValueLength = 80 |
| 22 | +) |
| 23 | + |
| 24 | +func commandAnalyticsContext(cmd *cobra.Command) telemetry.CommandContext { |
| 25 | + return telemetry.CommandContext{ |
| 26 | + RunID: uuid.NewString(), |
| 27 | + Command: commandName(cmd), |
| 28 | + Flags: changedFlagValues(cmd), |
| 29 | + } |
| 30 | +} |
| 31 | + |
| 32 | +func commandName(cmd *cobra.Command) string { |
| 33 | + path := strings.TrimSpace(cmd.CommandPath()) |
| 34 | + rootName := strings.TrimSpace(cmd.Root().Name()) |
| 35 | + if path == rootName || path == "" { |
| 36 | + return rootName |
| 37 | + } |
| 38 | + return strings.TrimSpace(strings.TrimPrefix(path, rootName)) |
| 39 | +} |
| 40 | + |
| 41 | +func changedFlagValues(cmd *cobra.Command) map[string]any { |
| 42 | + flags := changedFlags(cmd) |
| 43 | + if len(flags) == 0 { |
| 44 | + return nil |
| 45 | + } |
| 46 | + values := make(map[string]any, len(flags)) |
| 47 | + for _, flag := range flags { |
| 48 | + values[flag.Name] = telemetryFlagValue(flag) |
| 49 | + } |
| 50 | + return values |
| 51 | +} |
| 52 | + |
| 53 | +func changedFlags(cmd *cobra.Command) []*pflag.Flag { |
| 54 | + seen := make(map[string]struct{}) |
| 55 | + var result []*pflag.Flag |
| 56 | + collect := func(flags *pflag.FlagSet) { |
| 57 | + if flags == nil { |
| 58 | + return |
| 59 | + } |
| 60 | + flags.Visit(func(flag *pflag.Flag) { |
| 61 | + if _, ok := seen[flag.Name]; ok { |
| 62 | + return |
| 63 | + } |
| 64 | + seen[flag.Name] = struct{}{} |
| 65 | + result = append(result, flag) |
| 66 | + }) |
| 67 | + } |
| 68 | + for current := cmd; current != nil; current = current.Parent() { |
| 69 | + collect(current.PersistentFlags()) |
| 70 | + } |
| 71 | + collect(cmd.Flags()) |
| 72 | + sort.Slice(result, func(i, j int) bool { |
| 73 | + return result[i].Name < result[j].Name |
| 74 | + }) |
| 75 | + return result |
| 76 | +} |
| 77 | + |
| 78 | +func markFlagTelemetrySafe(flag *pflag.Flag) { |
| 79 | + if flag == nil { |
| 80 | + return |
| 81 | + } |
| 82 | + if flag.Annotations == nil { |
| 83 | + flag.Annotations = map[string][]string{} |
| 84 | + } |
| 85 | + flag.Annotations[telemetrySafeValueAnnotation] = []string{"true"} |
| 86 | +} |
| 87 | + |
| 88 | +func telemetryFlagValue(flag *pflag.Flag) any { |
| 89 | + if flag == nil { |
| 90 | + return nil |
| 91 | + } |
| 92 | + if isTelemetrySafeFlag(flag) || isBooleanFlag(flag) || isEnumFlag(flag) { |
| 93 | + return actualTelemetryFlagValue(flag) |
| 94 | + } |
| 95 | + return redactedTelemetryValue |
| 96 | +} |
| 97 | + |
| 98 | +func isTelemetrySafeFlag(flag *pflag.Flag) bool { |
| 99 | + if flag == nil || flag.Annotations == nil { |
| 100 | + return false |
| 101 | + } |
| 102 | + values, ok := flag.Annotations[telemetrySafeValueAnnotation] |
| 103 | + return ok && len(values) > 0 && values[0] == "true" |
| 104 | +} |
| 105 | + |
| 106 | +func isBooleanFlag(flag *pflag.Flag) bool { |
| 107 | + return flag != nil && flag.Value.Type() == "bool" |
| 108 | +} |
| 109 | + |
| 110 | +func isEnumFlag(flag *pflag.Flag) bool { |
| 111 | + if flag == nil { |
| 112 | + return false |
| 113 | + } |
| 114 | + _, ok := flag.Value.(*utils.EnumFlag) |
| 115 | + return ok |
| 116 | +} |
| 117 | + |
| 118 | +func actualTelemetryFlagValue(flag *pflag.Flag) any { |
| 119 | + if isBooleanFlag(flag) { |
| 120 | + value, err := strconv.ParseBool(flag.Value.String()) |
| 121 | + if err == nil { |
| 122 | + return value |
| 123 | + } |
| 124 | + } |
| 125 | + return flag.Value.String() |
| 126 | +} |
| 127 | + |
| 128 | +func telemetryIsCI() bool { |
| 129 | + return os.Getenv("CI") != "" || |
| 130 | + os.Getenv("GITHUB_ACTIONS") != "" || |
| 131 | + os.Getenv("BUILDKITE") != "" || |
| 132 | + os.Getenv("TF_BUILD") != "" || |
| 133 | + os.Getenv("JENKINS_URL") != "" || |
| 134 | + os.Getenv("GITLAB_CI") != "" |
| 135 | +} |
| 136 | + |
| 137 | +func telemetryIsTTY() bool { |
| 138 | + return term.IsTerminal(int(os.Stdout.Fd())) //nolint:gosec // G115: stdout fd is a small int on supported platforms |
| 139 | +} |
| 140 | + |
| 141 | +func telemetryIsAgent() bool { |
| 142 | + return agent.IsAgent() |
| 143 | +} |
| 144 | + |
| 145 | +func telemetryEnvSignals() map[string]any { |
| 146 | + return envSignals(telemetry.EnvSignalPresenceKeys[:], telemetry.EnvSignalValueKeys[:]) |
| 147 | +} |
| 148 | + |
| 149 | +func envSignals(presenceKeys []string, valueKeys []string) map[string]any { |
| 150 | + signals := make(map[string]any, len(presenceKeys)+len(valueKeys)) |
| 151 | + for _, key := range presenceKeys { |
| 152 | + if hasTelemetryEnvValue(key) { |
| 153 | + signals[key] = true |
| 154 | + } |
| 155 | + } |
| 156 | + for _, key := range valueKeys { |
| 157 | + if value := telemetryEnvValue(key); value != "" { |
| 158 | + signals[key] = value |
| 159 | + } |
| 160 | + } |
| 161 | + if len(signals) == 0 { |
| 162 | + return nil |
| 163 | + } |
| 164 | + return signals |
| 165 | +} |
| 166 | + |
| 167 | +func hasTelemetryEnvValue(key string) bool { |
| 168 | + return strings.TrimSpace(os.Getenv(key)) != "" |
| 169 | +} |
| 170 | + |
| 171 | +func telemetryEnvValue(key string) string { |
| 172 | + value := strings.TrimSpace(os.Getenv(key)) |
| 173 | + if value == "" { |
| 174 | + return "" |
| 175 | + } |
| 176 | + if len(value) > maxTelemetryEnvValueLength { |
| 177 | + return value[:maxTelemetryEnvValueLength] |
| 178 | + } |
| 179 | + return value |
| 180 | +} |
0 commit comments