feat: track help cmd (#245)

Track help actions for "CLI Command Run" and "CLI Command Completed" events
launchdarkly · May 7, 2024 · 1ebc398 · 1ebc398
1 parent 417aba2
commit 1ebc398
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 17 deletions.
diff --git a/cmd/analytics/analytics.go b/cmd/analytics/analytics.go
@@ -8,7 +8,11 @@ import (
 	"github.com/spf13/viper"
 )
 
-func CmdRunEventProperties(cmd *cobra.Command, name string) map[string]interface{} {
+func CmdRunEventProperties(
+	cmd *cobra.Command,
+	name string,
+	overrides map[string]interface{},
+) map[string]interface{} {
 	baseURI := viper.GetString(cliflags.BaseURIFlag)
 	var flags []string
 	cmd.Flags().Visit(func(f *pflag.Flag) {
@@ -23,5 +27,10 @@ func CmdRunEventProperties(cmd *cobra.Command, name string) map[string]interface
 	if baseURI != cliflags.BaseURIDefault {
 		properties["baseURI"] = baseURI
 	}
+
+	for k, v := range overrides {
+		properties[k] = v
+	}
+
 	return properties
 }
diff --git a/cmd/config/config.go b/cmd/config/config.go
@@ -31,12 +31,15 @@ func NewConfigCmd(analyticsTracker analytics.Tracker) *cobra.Command {
 		Short: "View and modify specific configuration values",
 		Use:   "config",
 		PreRun: func(cmd *cobra.Command, args []string) {
-			analyticsTracker.SendCommandRunEvent(
-				viper.GetString(cliflags.AccessTokenFlag),
-				viper.GetString(cliflags.BaseURIFlag),
-				viper.GetBool(cliflags.AnalyticsOptOut),
-				cmdAnalytics.CmdRunEventProperties(cmd, "config"),
-			)
+			// only track event if there are flags
+			if len(os.Args[1:]) > 1 {
+				analyticsTracker.SendCommandRunEvent(
+					viper.GetString(cliflags.AccessTokenFlag),
+					viper.GetString(cliflags.BaseURIFlag),
+					viper.GetBool(cliflags.AnalyticsOptOut),
+					cmdAnalytics.CmdRunEventProperties(cmd, "config", nil),
+				)
+			}
 		},
 	}
 
@@ -53,6 +56,19 @@ func NewConfigCmd(analyticsTracker analytics.Tracker) *cobra.Command {
 			sb.WriteString(fmt.Sprintf("- `%s`: %s\n", s, cliflags.AllFlagsHelp()[s]))
 		}
 		cmd.Long += sb.String()
+
+		analyticsTracker.SendCommandRunEvent(
+			viper.GetString(cliflags.AccessTokenFlag),
+			viper.GetString(cliflags.BaseURIFlag),
+			viper.GetBool(cliflags.AnalyticsOptOut),
+			cmdAnalytics.CmdRunEventProperties(cmd,
+				"config",
+				map[string]interface{}{
+					"action": "help",
+				},
+			),
+		)
+
 		helpFun(cmd, args)
 	})
 

diff --git a/cmd/members/members.go b/cmd/members/members.go
@@ -20,7 +20,7 @@ func NewMembersCmd(analyticsTracker analytics.Tracker, client members.Client) (*
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
 				viper.GetBool(cliflags.AnalyticsOptOut),
-				cmdAnalytics.CmdRunEventProperties(cmd, "members"),
+				cmdAnalytics.CmdRunEventProperties(cmd, "members", nil),
 			)
 		},
 	}

diff --git a/cmd/resources/resource_utils.go b/cmd/resources/resource_utils.go
@@ -54,7 +54,7 @@ func removeResourceFromOperationId(resourceName, operationId string) string {
 		// a lot of "list" operations say "GetFor{ResourceName}"
 		fmt.Sprintf("For%s", singularResourceName), "",
 		fmt.Sprintf("For%s", resourceName), "",
-		fmt.Sprint("ByProject"), "",
+		"ByProject", "",
 		resourceName, "",
 		singularResourceName, "",
 	)
@@ -98,7 +98,7 @@ func isListResponse(op *openapi3.Operation, spec *openapi3.T) bool {
 			return true
 		}
 	}
-	
+
 	return false
 }
 

diff --git a/cmd/resources/resources.go b/cmd/resources/resources.go
@@ -159,7 +159,7 @@ func NewResourceCmd(parentCmd *cobra.Command, analyticsTracker analytics.Tracker
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
 				viper.GetBool(cliflags.AnalyticsOptOut),
-				cmdAnalytics.CmdRunEventProperties(cmd, resourceName),
+				cmdAnalytics.CmdRunEventProperties(cmd, resourceName, nil),
 			)
 		},
 	}

diff --git a/cmd/root.go b/cmd/root.go
@@ -13,6 +13,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
+	cmdAnalytics "ldcli/cmd/analytics"
 	"ldcli/cmd/cliflags"
 	configcmd "ldcli/cmd/config"
 	resourcecmd "ldcli/cmd/resources"
@@ -66,6 +67,24 @@ func NewRootCommand(
 		SilenceUsage:  true,
 	}
 
+	hf := cmd.HelpFunc()
+	cmd.SetHelpFunc(func(c *cobra.Command, args []string) {
+		// get the resource for the tracking event, not the action
+		resourceCommand := getResourceCommand(c)
+		analyticsTracker.SendCommandRunEvent(
+			viper.GetString(cliflags.AccessTokenFlag),
+			viper.GetString(cliflags.BaseURIFlag),
+			viper.GetBool(cliflags.AnalyticsOptOut),
+			cmdAnalytics.CmdRunEventProperties(c,
+				resourceCommand.Name(),
+				map[string]interface{}{
+					"action": "help",
+				},
+			),
+		)
+		hf(c, args)
+	})
+
 	if useConfigFile {
 		setFlagsFromConfig()
 	}
@@ -174,3 +193,14 @@ func setFlagsFromConfig() {
 	viper.SetConfigFile(config.GetConfigFile())
 	_ = viper.ReadInConfig()
 }
+
+// getResourceCommand returns the command for a resource or an action's parent resource.
+// ldcli projects // returns projects command
+// ldcli projects list // returns projects command
+func getResourceCommand(c *cobra.Command) *cobra.Command {
+	if !c.HasParent() || c.Parent() == c.Root() {
+		return c
+	}
+
+	return getResourceCommand(c.Parent())
+}
diff --git a/internal/analytics/client.go b/internal/analytics/client.go
@@ -47,11 +47,12 @@ type Tracker interface {
 }
 
 type Client struct {
-	ID           string
-	HTTPClient   *http.Client
-	Version      string
-	sentRunEvent bool
-	wg           sync.WaitGroup
+	ID            string
+	HTTPClient    *http.Client
+	Version       string
+	sentHelpEvent bool
+	sentRunEvent  bool
+	wg            sync.WaitGroup
 }
 
 // SendEvent makes an async request to track the given event with properties.
@@ -127,6 +128,10 @@ func (c *Client) SendCommandRunEvent(
 	)
 	if !optOut {
 		c.sentRunEvent = true
+		action, ok := properties["action"]
+		if ok && action == "help" {
+			c.sentHelpEvent = true
+		}
 	}
 }
 
@@ -137,6 +142,10 @@ func (c *Client) SendCommandCompletedEvent(
 	outcome string,
 ) {
 	if c.sentRunEvent {
+		if c.sentHelpEvent {
+			outcome = HELP
+		}
+
 		c.sendEvent(
 			accessToken,
 			baseURI,

diff --git a/internal/analytics/events.go b/internal/analytics/events.go
@@ -1,8 +1,9 @@
 package analytics
 
 const (
-	SUCCESS = "success"
 	ERROR   = "error"
+	HELP    = "help"
+	SUCCESS = "success"
 )
 
 func MockedTracker(name string, action string, flags []string, outcome string) *MockTracker {