feat: include output format in telemetry (#3481)

Author: Gustavo Bazan

internal/telemetry/event.go

@@ -290,6 +290,40 @@ func withOrgID(cmd CmdFlags, c OrgIDGetter) EventOpt {
 	}
 }
 
+type OutputGetter interface {
+	Output() string
+}
+
+func withOutput(cmd CmdFlags, c OutputGetter) EventOpt {
+	return func(event Event) {
+		if cmd.Flags().Changed(flag.Output) {
+			v, _ := cmd.Flags().GetString(flag.Output)
+			event.Properties["output"] = output(v)
+			return
+		}
+		event.Properties["output"] = output(c.Output())
+	}
+}
+
+const (
+	plaintextFormat = "plaintext"
+	jsonFormat      = "json"
+	jsonPath        = "json-path"
+	goTemplate      = "go-template"
+	goTemplateFile  = "go-template-file"
+)
+
+var templateFormats = []string{jsonFormat, goTemplate, goTemplateFile, jsonPath}
+
+func output(o string) string {
+	for _, f := range templateFormats {
+		if strings.HasPrefix(o, f) {
+			return f
+		}
+	}
+	return plaintextFormat
+}
+
 type Printer interface {
 	OutOrStdout() io.Writer
 }

internal/telemetry/event_test.go

@@ -18,6 +18,7 @@ package telemetry
 
 import (
 	"errors"
+	"fmt"
 	"runtime"
 	"testing"
 	"time"
@@ -262,9 +263,12 @@ func TestSanitizePrompt(t *testing.T) {
 		},
 	}
 
-	for _, testCase := range testCases {
-		got := sanitizePrompt(testCase.input)
-		assert.Equal(t, testCase.expected, got)
+	for i, tc := range testCases {
+		t.Run(fmt.Sprintf("case_%d", i), func(t *testing.T) {
+			t.Parallel()
+			got := sanitizePrompt(tc.input)
+			assert.Equal(t, tc.expected, got)
+		})
 	}
 }
 
@@ -283,9 +287,12 @@ func TestSanitizeSelectOption(t *testing.T) {
 		},
 	}
 
-	for _, testCase := range testCases {
-		got := sanitizeSelectOption(testCase.input)
-		assert.Equal(t, testCase.expected, got)
+	for i, tc := range testCases {
+		t.Run(fmt.Sprintf("case_%d", i), func(t *testing.T) {
+			t.Parallel()
+			got := sanitizeSelectOption(tc.input)
+			assert.Equal(t, tc.expected, got)
+		})
 	}
 }
 
@@ -384,6 +391,55 @@ func TestWithEmptySearchIndexType(t *testing.T) {
 	assert.Nil(t, e.Properties["search_index_type"])
 }
 
+func Test_withOutput(t *testing.T) {
+	tests := []struct {
+		name        string
+		flagValue   string
+		configValue string
+		want        string
+	}{
+		{
+			name:        "from flag",
+			flagValue:   "json",
+			configValue: "",
+			want:        "json",
+		},
+		{
+			name:        "from config",
+			flagValue:   "",
+			configValue: "json",
+			want:        "json",
+		},
+		{
+			name:        "no value",
+			flagValue:   "",
+			configValue: "",
+			want:        "plaintext",
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			cmd := &cobra.Command{
+				Use: "test-command",
+				Run: func(_ *cobra.Command, _ []string) {},
+			}
+			var p string
+			cmd.Flags().StringVar(&p, flag.Output, "", "")
+			if tc.flagValue != "" {
+				require.NoError(t, cmd.Flags().Set(flag.Output, tc.flagValue))
+			}
+			c := &configMock{}
+			if tc.configValue != "" {
+				c.out = tc.configValue
+			}
+			require.NoError(t, cmd.ExecuteContext(NewContext()))
+			e := newEvent(withOutput(cmd, c))
+			assert.Equal(t, tc.want, e.Properties["output"])
+		})
+	}
+}
+
 type configMock struct {
 	name        string
 	publicKey   string
@@ -393,6 +449,7 @@ type configMock struct {
 	url         string
 	project     string
 	org         string
+	out         string
 }
 
 var _ Authenticator = configMock{}
@@ -428,3 +485,7 @@ func (c configMock) PrivateAPIKey() string {
 func (c configMock) AccessToken() string {
 	return c.accessToken
 }
+
+func (c configMock) Output() string {
+	return c.out
+}

internal/telemetry/tracker.go

@@ -96,6 +96,7 @@ func (t *tracker) defaultCommandOptions() []EventOpt {
 		withService(config.Default()),
 		withProjectID(t.cmd, config.Default()),
 		withOrgID(t.cmd, config.Default()),
+		withOutput(t.cmd, config.Default()),
 		withTerminal(t.cmd),
 		withInstaller(t.installer),
 		withUserAgent(),