Allow configuration of analytics pixel URL

internal/analytics/analytics.go

@@ -17,4 +17,5 @@ type Dispatcher interface {
 
 func init() {
 	configMediator.RegisterOption(constants.ReportAnalyticsConfig, configMediator.Bool, true)
+	configMediator.RegisterOption(constants.AnalyticsPixelOverrideConfig, configMediator.String, "")
 }

internal/analytics/client/sync/client.go

@@ -120,15 +120,16 @@ func New(source string, cfg *config.Instance, auth *authentication.Auth, out out
 
 	a.customDimensions = customDimensions
 
+	url := a.cfg.GetString(constants.AnalyticsPixelOverrideConfig)
 	// Register reporters
 	if condition.InTest() {
 		logging.Debug("Using test reporter")
-		a.NewReporter(reporters.NewTestReporter(reporters.TestReportFilepath()))
+		a.NewReporter(reporters.NewTestReporter(reporters.TestReportFilepath(), url))
 		logging.Debug("Using test reporter as instructed by env")
 	} else if v := os.Getenv(constants.AnalyticsLogEnvVarName); v != "" {
-		a.NewReporter(reporters.NewTestReporter(v))
+		a.NewReporter(reporters.NewTestReporter(v, url))
 	} else {
-		a.NewReporter(reporters.NewPixelReporter())
+		a.NewReporter(reporters.NewPixelReporter(url))
 	}
 
 	return a

internal/analytics/client/sync/reporters/pixel.go

@@ -15,13 +15,17 @@ type PixelReporter struct {
 	url string
 }
 
-func NewPixelReporter() *PixelReporter {
+func NewPixelReporter(url string) *PixelReporter {
 	var pixelUrl string
 
-	// Attempt to get the value for the pixel URL from the environment.  Fall back to default if that fails
-	if pixelUrl = os.Getenv(constants.AnalyticsPixelOverrideEnv); pixelUrl == "" {
+	// If a host is provided, use it. Otherwise, use the environment variable.
+	// Fall back to default if that fails.
+	if url != "" {
+		pixelUrl = url
+	} else if pixelUrl = os.Getenv(constants.AnalyticsPixelOverrideEnv); pixelUrl != "" {
 		pixelUrl = constants.DefaultAnalyticsPixel
 	}
+
 	return &PixelReporter{pixelUrl}
 }
 

internal/analytics/client/sync/reporters/test.go

@@ -13,6 +13,7 @@ import (
 
 type TestReporter struct {
 	path string
+	host string
 }
 
 const TestReportFilename = "analytics.log"
@@ -23,8 +24,8 @@ func TestReportFilepath() string {
 	return filepath.Join(appdata, TestReportFilename)
 }
 
-func NewTestReporter(path string) *TestReporter {
-	return &TestReporter{path}
+func NewTestReporter(path, host string) *TestReporter {
+	return &TestReporter{path, host}
 }
 
 func (r *TestReporter) ID() string {
@@ -36,11 +37,12 @@ type TestLogEntry struct {
 	Action     string
 	Source     string
 	Label      string
+	URL        string
 	Dimensions *dimensions.Values
 }
 
 func (r *TestReporter) Event(category, action, source, label string, d *dimensions.Values) error {
-	b, err := json.Marshal(TestLogEntry{category, action, source, label, d})
+	b, err := json.Marshal(TestLogEntry{category, action, source, label, r.host, d})
 	if err != nil {
 		return errs.Wrap(err, "Could not marshal test log entry")
 	}

internal/constants/constants.go

@@ -409,6 +409,9 @@ const SecurityPromptConfig = "security.prompt.enabled"
 // SecurityPromptLevelConfig is the config key used to determine the level of security prompts
 const SecurityPromptLevelConfig = "security.prompt.level"
 
+// AnalyticsPixelOverrideConfig is the config key used to override the analytics pixel url
+const AnalyticsPixelOverrideConfig = "report.analytics.endpoint"
+
 // SvcAppName is the name we give our state-svc application
 const SvcAppName = "State Service"
 

test/integration/analytics_int_test.go

@@ -644,6 +644,42 @@ func (suite *AnalyticsIntegrationTestSuite) TestCIAndInteractiveDimensions() {
 	}
 }
 
+func (suite *AnalyticsIntegrationTestSuite) TestAnalyticsPixelOverride() {
+	suite.OnlyRunForTags(tagsuite.Analytics)
+
+	ts := e2e.New(suite.T(), false)
+	defer ts.Close()
+
+	cp := ts.Spawn("config", "set", constants.AnalyticsPixelOverrideConfig, "https://example.com")
+	cp.Expect("Successfully set config key")
+	cp.ExpectExitCode(0)
+
+	// Stop the service so that the next command will pick up the new config values.
+	// We need to do this because the analytics reporting instance will have values set that will
+	// be used until a new instance is created.
+	cp = ts.SpawnCmd(ts.SvcExe, "stop")
+	cp.ExpectExitCode(0)
+
+	cp = ts.Spawn("--version")
+	cp.Expect("ActiveState CLI")
+	cp.ExpectExitCode(0)
+
+	suite.eventsfile = filepath.Join(ts.Dirs.Config, reporters.TestReportFilename)
+	events := parseAnalyticsEvents(suite, ts)
+	suite.Require().NotEmpty(events)
+
+	foundCount := 0
+	for _, e := range events {
+		if e.URL == "https://example.com" {
+			foundCount++
+		}
+	}
+
+	// Because the service has already reported some events with the default configuration values,
+	// we expect to find at least one event with the new configuration values after the service is restarted.
+	suite.Greater(foundCount, 1)
+}
+
 func TestAnalyticsIntegrationTestSuite(t *testing.T) {
 	suite.Run(t, new(AnalyticsIntegrationTestSuite))
 }