feat: track cli command run events (#189)

launchdarkly · Apr 22, 2024 · fd98b42 · fd98b42
1 parent 2bfad63
commit fd98b42
Show file tree

Hide file tree

Showing 45 changed files with 1,955 additions and 80 deletions.
diff --git a/cmd/cliflags/flags.go b/cmd/cliflags/flags.go
@@ -1,6 +1,8 @@
 package cliflags
 
 const (
+	BaseURIDefault = "https://app.launchdarkly.com"
+
 	AccessTokenFlag = "access-token"
 	BaseURIFlag     = "base-uri"
 	DataFlag        = "data"

diff --git a/cmd/cmdtest.go b/cmd/cmdtest.go
@@ -16,10 +16,11 @@ var ValidResponse = `{"valid": true}`
 func CallCmd(
 	t *testing.T,
 	clients APIClients,
+	tracker analytics.Tracker,
 	args []string,
 ) ([]byte, error) {
 	rootCmd, err := NewRootCommand(
-		&analytics.NoopClient{},
+		tracker,
 		clients,
 		"test",
 		false,

diff --git a/cmd/config/config.go b/cmd/config/config.go
@@ -10,6 +10,8 @@ import (
 	"github.com/spf13/viper"
 	"gopkg.in/yaml.v3"
 
+	"ldcli/cmd/cliflags"
+	"ldcli/internal/analytics"
 	"ldcli/internal/config"
 )
 
@@ -19,12 +21,20 @@ const (
 	UnsetFlag = "unset"
 )
 
-func NewConfigCmd() *cobra.Command {
+func NewConfigCmd(analyticsTracker analytics.Tracker) *cobra.Command {
 	cmd := &cobra.Command{
 		Long:  "View and modify specific configuration values",
 		RunE:  run(),
 		Short: "View and modify specific configuration values",
 		Use:   "config",
+		PreRun: func(cmd *cobra.Command, args []string) {
+			analyticsTracker.SendEvent(
+				viper.GetString(cliflags.AccessTokenFlag),
+				viper.GetString(cliflags.BaseURIFlag),
+				"CLI Command Run",
+				analytics.CmdRunEventProperties(cmd, "config"),
+			)
+		},
 	}
 
 	cmd.Flags().Bool(ListFlag, false, "List configs")

diff --git a/cmd/config/config_test.go b/cmd/config/config_test.go
@@ -2,6 +2,7 @@ package config_test
 
 import (
 	"ldcli/cmd"
+	"ldcli/internal/analytics"
 	"os"
 	"testing"
 
@@ -16,7 +17,7 @@ func TestNoFlag(t *testing.T) {
 		"config",
 	}
 
-	output, err := cmd.CallCmd(t, cmd.APIClients{}, args)
+	output, err := cmd.CallCmd(t, cmd.APIClients{}, &analytics.NoopClient{}, args)
 
 	require.NoError(t, err)
 

diff --git a/cmd/environments/environments.go b/cmd/environments/environments.go
@@ -2,7 +2,9 @@ package environments
 
 import (
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 
+	"ldcli/cmd/cliflags"
 	"ldcli/internal/analytics"
 	"ldcli/internal/environments"
 )
@@ -15,13 +17,20 @@ func NewEnvironmentsCmd(
 		Use:   "environments",
 		Short: "Make requests (list, create, etc.) on environments",
 		Long:  "Make requests (list, create, etc.) on environments",
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			analyticsTracker.SendEvent(
+				viper.GetString(cliflags.AccessTokenFlag),
+				viper.GetString(cliflags.BaseURIFlag),
+				"CLI Command Run",
+				analytics.CmdRunEventProperties(cmd, "environments"),
+			)
+		},
 	}
 
-	getCmd, err := NewGetCmd(analyticsTracker, client)
+	getCmd, err := NewGetCmd(client)
 	if err != nil {
 		return nil, err
 	}
-
 	cmd.AddCommand(getCmd)
 
 	return cmd, nil

diff --git a/cmd/environments/get.go b/cmd/environments/get.go
@@ -9,18 +9,16 @@ import (
 
 	"ldcli/cmd/cliflags"
 	"ldcli/cmd/validators"
-	"ldcli/internal/analytics"
 	"ldcli/internal/environments"
 )
 
 func NewGetCmd(
-	analyticsTracker analytics.Tracker,
 	client environments.Client,
 ) (*cobra.Command, error) {
 	cmd := &cobra.Command{
 		Args:  validators.Validate(),
 		Long:  "Return an environment",
-		RunE:  runGet(analyticsTracker, client),
+		RunE:  runGet(client),
 		Short: "Return an environment",
 		Use:   "get",
 	}
@@ -50,7 +48,6 @@ func NewGetCmd(
 }
 
 func runGet(
-	analyticsTracker analytics.Tracker,
 	client environments.Client,
 ) func(*cobra.Command, []string) error {
 	return func(cmd *cobra.Command, args []string) error {
@@ -68,15 +65,6 @@ func runGet(
 			return err
 		}
 
-		analyticsTracker.SendEvent(
-			viper.GetString(cliflags.AccessTokenFlag),
-			viper.GetString(cliflags.BaseURIFlag),
-			"environment_get",
-			map[string]interface{}{
-				"key":        viper.GetString(cliflags.EnvironmentFlag),
-				"projectKey": viper.GetString(cliflags.ProjectFlag),
-			})
-
 		fmt.Fprintf(cmd.OutOrStdout(), string(response)+"\n")
 
 		return nil

diff --git a/cmd/environments/get_test.go b/cmd/environments/get_test.go
@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"ldcli/internal/analytics"
 	"ldcli/internal/environments"
 	"ldcli/internal/errors"
 )
@@ -36,7 +37,7 @@ func TestGet(t *testing.T) {
 			"--project", "test-proj",
 		}
 
-		output, err := cmd.CallCmd(t, clients, args)
+		output, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.NoError(t, err)
 		assert.JSONEq(t, `{"valid": true}`, string(output))
@@ -58,7 +59,7 @@ func TestGet(t *testing.T) {
 			"--project", "test-proj",
 		}
 
-		output, err := cmd.CallCmd(t, clients, args)
+		output, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.NoError(t, err)
 		assert.JSONEq(t, `{"valid": true}`, string(output))
@@ -80,7 +81,7 @@ func TestGet(t *testing.T) {
 			"--project", "test-proj",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.EqualError(t, err, "An error")
 	})
@@ -93,7 +94,7 @@ func TestGet(t *testing.T) {
 			"environments", "get",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `required flag(s) "access-token", "environment", "project" not set`+errorHelp)
 	})
@@ -107,7 +108,7 @@ func TestGet(t *testing.T) {
 			"-e",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `flag needs an argument: 'e' in -e`)
 	})
@@ -121,7 +122,7 @@ func TestGet(t *testing.T) {
 			"--environment",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `flag needs an argument: --environment`)
 	})
@@ -138,8 +139,39 @@ func TestGet(t *testing.T) {
 			"--project", "test-proj",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, "base-uri is invalid"+errorHelp)
 	})
+
+	t.Run("will track analytics for CLI Command Run event", func(t *testing.T) {
+		tracker := analytics.MockedTracker(
+			"environments",
+			"get",
+			[]string{
+				"access-token",
+				"base-uri",
+				"environment",
+				"project",
+			})
+
+		client := environments.MockClient{}
+		client.
+			On("Get", mockArgs...).
+			Return([]byte(cmd.ValidResponse), nil)
+		clients := cmd.APIClients{
+			EnvironmentsClient: &client,
+		}
+
+		args := []string{
+			"environments", "get",
+			"--access-token", "testAccessToken",
+			"--base-uri", "http://test.com",
+			"--environment", "test-env",
+			"--project", "test-proj",
+		}
+
+		_, err := cmd.CallCmd(t, clients, tracker, args)
+		require.NoError(t, err)
+	})
 }
diff --git a/cmd/flags/create_test.go b/cmd/flags/create_test.go
@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"ldcli/cmd"
+	"ldcli/internal/analytics"
 	"ldcli/internal/errors"
 	"ldcli/internal/flags"
 )
@@ -37,7 +38,7 @@ func TestCreate(t *testing.T) {
 			"--project", "test-proj-key",
 		}
 
-		output, err := cmd.CallCmd(t, clients, args)
+		output, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.NoError(t, err)
 		assert.JSONEq(t, `{"valid": true}`, string(output))
@@ -59,7 +60,7 @@ func TestCreate(t *testing.T) {
 			"--project", "test-proj-key",
 		}
 
-		output, err := cmd.CallCmd(t, clients, args)
+		output, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.NoError(t, err)
 		assert.JSONEq(t, `{"valid": true}`, string(output))
@@ -81,7 +82,7 @@ func TestCreate(t *testing.T) {
 			"--project", "test-proj-key",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		require.EqualError(t, err, "An error")
 	})
@@ -94,7 +95,7 @@ func TestCreate(t *testing.T) {
 			"flags", "create",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `required flag(s) "access-token", "data", "project" not set`+errorHelp)
 	})
@@ -108,7 +109,7 @@ func TestCreate(t *testing.T) {
 			"-d",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `flag needs an argument: 'd' in -d`)
 	})
@@ -122,7 +123,7 @@ func TestCreate(t *testing.T) {
 			"--data",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, `flag needs an argument: --data`)
 	})
@@ -139,8 +140,39 @@ func TestCreate(t *testing.T) {
 			"--project", "test-proj-key",
 		}
 
-		_, err := cmd.CallCmd(t, clients, args)
+		_, err := cmd.CallCmd(t, clients, &analytics.NoopClient{}, args)
 
 		assert.EqualError(t, err, "base-uri is invalid"+errorHelp)
 	})
+
+	t.Run("will track analytics for CLI Command Run event", func(t *testing.T) {
+		tracker := analytics.MockedTracker(
+			"flags",
+			"create",
+			[]string{
+				"access-token",
+				"base-uri",
+				"data",
+				"project",
+			})
+
+		client := flags.MockClient{}
+		client.
+			On("Create", mockArgs...).
+			Return([]byte(cmd.ValidResponse), nil)
+		clients := cmd.APIClients{
+			FlagsClient: &client,
+		}
+
+		args := []string{
+			"flags", "create",
+			"--access-token", "testAccessToken",
+			"--base-uri", "http://test.com",
+			"-d", `{"key": "test-key", "name": "test-name"}`,
+			"--project", "test-proj-key",
+		}
+
+		_, err := cmd.CallCmd(t, clients, tracker, args)
+		require.NoError(t, err)
+	})
 }
diff --git a/cmd/flags/flags.go b/cmd/flags/flags.go
@@ -2,15 +2,26 @@ package flags
 
 import (
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 
+	"ldcli/cmd/cliflags"
+	"ldcli/internal/analytics"
 	"ldcli/internal/flags"
 )
 
-func NewFlagsCmd(client flags.Client) (*cobra.Command, error) {
+func NewFlagsCmd(analyticsTracker analytics.Tracker, client flags.Client) (*cobra.Command, error) {
 	cmd := &cobra.Command{
 		Use:   "flags",
 		Short: "Make requests (list, create, etc.) on flags",
 		Long:  "Make requests (list, create, etc.) on flags",
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			analyticsTracker.SendEvent(
+				viper.GetString(cliflags.AccessTokenFlag),
+				viper.GetString(cliflags.BaseURIFlag),
+				"CLI Command Run",
+				analytics.CmdRunEventProperties(cmd, "flags"),
+			)
+		},
 	}
 
 	createCmd, err := NewCreateCmd(client)