feat: allow users to opt out of analytics tracking (#206)

* add analytics opt out flag and dont send tracking events if true

* update golden file

* update SendEvent to no-op vs pre-run

cmd/cliflags/flags.go

@@ -4,6 +4,7 @@ const (
 	BaseURIDefault = "https://app.launchdarkly.com"
 
 	AccessTokenFlag = "access-token"
+	AnalyticsOptOut = "analytics-opt-out"
 	BaseURIFlag     = "base-uri"
 	DataFlag        = "data"
 	EmailsFlag      = "emails"

cmd/config/config.go

@@ -32,6 +32,7 @@ func NewConfigCmd(analyticsTracker analytics.Tracker) *cobra.Command {
 			analyticsTracker.SendEvent(
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
+				viper.GetBool(cliflags.AnalyticsOptOut),
 				"CLI Command Run",
 				analytics.CmdRunEventProperties(cmd, "config"),
 			)

cmd/config/testdata/help.golden

@@ -11,5 +11,6 @@ Flags:
 
 Global Flags:
       --access-token string   LaunchDarkly API token with write-level access
+      --analytics-opt-out     Opt out of analytics tracking
       --base-uri string       LaunchDarkly base URI (default "https://app.launchdarkly.com")
   -o, --output string         Command response output format in either JSON or plain text (default "plaintext")

cmd/environments/environments.go

@@ -21,6 +21,7 @@ func NewEnvironmentsCmd(
 			analyticsTracker.SendEvent(
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
+				viper.GetBool(cliflags.AnalyticsOptOut),
 				"CLI Command Run",
 				analytics.CmdRunEventProperties(cmd, "environments"),
 			)

cmd/flags/flags.go

@@ -18,6 +18,7 @@ func NewFlagsCmd(analyticsTracker analytics.Tracker, client flags.Client) (*cobr
 			analyticsTracker.SendEvent(
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
+				viper.GetBool(cliflags.AnalyticsOptOut),
 				"CLI Command Run",
 				analytics.CmdRunEventProperties(cmd, "flags"),
 			)

cmd/members/members.go

@@ -18,6 +18,7 @@ func NewMembersCmd(analyticsTracker analytics.Tracker, client members.Client) (*
 			analyticsTracker.SendEvent(
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
+				viper.GetBool(cliflags.AnalyticsOptOut),
 				"CLI Command Run",
 				analytics.CmdRunEventProperties(cmd, "members"),
 			)

cmd/projects/projects.go

@@ -18,6 +18,7 @@ func NewProjectsCmd(analyticsTracker analytics.Tracker, client projects.Client)
 			analyticsTracker.SendEvent(
 				viper.GetString(cliflags.AccessTokenFlag),
 				viper.GetString(cliflags.BaseURIFlag),
+				viper.GetBool(cliflags.AnalyticsOptOut),
 				"CLI Command Run",
 				analytics.CmdRunEventProperties(cmd, "projects"),
 			)

cmd/root.go

@@ -99,6 +99,16 @@ func NewRootCommand(
 		return nil, err
 	}
 
+	cmd.PersistentFlags().Bool(
+		cliflags.AnalyticsOptOut,
+		false,
+		"Opt out of analytics tracking",
+	)
+	err = viper.BindPFlag(cliflags.AnalyticsOptOut, cmd.PersistentFlags().Lookup(cliflags.AnalyticsOptOut))
+	if err != nil {
+		return nil, err
+	}
+
 	cmd.PersistentFlags().StringP(
 		cliflags.OutputFlag,
 		"o",

internal/analytics/client.go

@@ -15,6 +15,7 @@ type Tracker interface {
 	SendEvent(
 		accessToken string,
 		baseURI string,
+		optOut bool,
 		eventName string,
 		properties map[string]interface{},
 	)
@@ -29,9 +30,13 @@ type Client struct {
 func (c *Client) SendEvent(
 	accessToken string,
 	baseURI string,
+	optOut bool,
 	eventName string,
 	properties map[string]interface{},
 ) {
+	if optOut {
+		return
+	}
 	input := struct {
 		Event      string                 `json:"event"`
 		Properties map[string]interface{} `json:"properties"`
@@ -87,6 +92,7 @@ type NoopClient struct{}
 func (c *NoopClient) SendEvent(
 	accessToken string,
 	baseURI string,
+	optOut bool,
 	eventName string,
 	properties map[string]interface{},
 ) {
@@ -100,6 +106,7 @@ type MockTracker struct {
 func (m *MockTracker) SendEvent(
 	accessToken string,
 	baseURI string,
+	optOut bool,
 	eventName string,
 	properties map[string]interface{},
 ) {

internal/config/config.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"fmt"
+	"strconv"
 
 	"github.com/mitchellh/go-homedir"
 
@@ -12,23 +13,30 @@ const Filename = ".ldcli-config.yml"
 
 // ConfigFile represents the data stored in the config file.
 type ConfigFile struct {
-	AccessToken string `json:"access-token,omitempty" yaml:"access-token,omitempty"`
-	BaseURI     string `json:"base-uri,omitempty" yaml:"base-uri,omitempty"`
+	AccessToken     string `json:"access-token,omitempty" yaml:"access-token,omitempty"`
+	AnalyticsOptOut bool   `json:"analytics-opt-out,omitempty" yaml:"analytics-opt-out,omitempty"`
+	BaseURI         string `json:"base-uri,omitempty" yaml:"base-uri,omitempty"`
 }
 
 func NewConfig(rawConfig map[string]interface{}) ConfigFile {
 	var accessToken string
 	if rawConfig[cliflags.AccessTokenFlag] != nil {
 		accessToken = rawConfig[cliflags.AccessTokenFlag].(string)
 	}
+	var analyticsOptOut bool
+	if rawConfig[cliflags.AnalyticsOptOut] != nil {
+		stringValue := rawConfig[cliflags.AnalyticsOptOut].(string)
+		analyticsOptOut, _ = strconv.ParseBool(stringValue)
+	}
 	var baseURI string
 	if rawConfig[cliflags.BaseURIFlag] != nil {
 		baseURI = rawConfig[cliflags.BaseURIFlag].(string)
 	}
 
 	return ConfigFile{
-		AccessToken: accessToken,
-		BaseURI:     baseURI,
+		AccessToken:     accessToken,
+		AnalyticsOptOut: analyticsOptOut,
+		BaseURI:         baseURI,
 	}
 }