Merge pull request cli#13191 from cli/wm/add-telemetry-to-cli

Add sampled command telemetry

Author: williammartin

.gitignore

@@ -39,3 +39,7 @@
 
 vendor/
 gh
+
+# Test coverage artifacts
+coverage.out
+lcov.info

Makefile

@@ -38,6 +38,10 @@ completions: bin/gh$(EXE)
 	bin/gh$(EXE) completion -s fish > ./share/fish/vendor_completions.d/gh.fish
 	bin/gh$(EXE) completion -s zsh > ./share/zsh/site-functions/_gh
 
+.PHONY: lint
+lint:
+	golangci-lint run ./...
+
 # just convenience tasks around `go test`
 .PHONY: test
 test:

acceptance/acceptance_test.go

@@ -182,6 +182,15 @@ func TestWorkflows(t *testing.T) {
 	testscript.Run(t, testScriptParamsFor(tsEnv, "workflow"))
 }
 
+func TestTelemetry(t *testing.T) {
+	var tsEnv testScriptEnv
+	if err := tsEnv.fromEnv(); err != nil {
+		t.Fatal(err)
+	}
+
+	testscript.Run(t, testScriptParamsFor(tsEnv, "telemetry"))
+}
+
 func testScriptParamsFor(tsEnv testScriptEnv, command string) testscript.Params {
 	var files []string
 	if tsEnv.script != "" {
@@ -226,6 +235,8 @@ func sharedSetup(tsEnv testScriptEnv) func(ts *testscript.Env) error {
 
 		ts.Setenv("RANDOM_STRING", randomString(10))
 
+		ts.Setenv("GH_TELEMETRY", "false")
+
 		// The sandbox overrides HOME, so git cannot find the user's global
 		// config. Write a minimal identity so commits inside the sandbox
 		// don't fail with "Author identity unknown".

acceptance/testdata/telemetry/command-invocation.txtar

@@ -0,0 +1,9 @@
+# Telemetry log mode outputs command invocation event to stderr
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=log
+env GH_TELEMETRY_SAMPLE_RATE=100
+
+exec gh version
+stderr 'Telemetry payload:'
+stderr '"type": "command_invocation"'
+stderr '"command": "gh version"'

acceptance/testdata/telemetry/no-telemetry-for-completion.txtar

@@ -0,0 +1,7 @@
+# The completion command should not generate a telemetry event
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=log
+env GH_TELEMETRY_SAMPLE_RATE=100
+
+exec gh completion -s bash
+! stderr 'Telemetry payload:'

acceptance/testdata/telemetry/no-telemetry-for-extension.txtar

@@ -0,0 +1,27 @@
+# Extensions should not generate telemetry events
+[!exec:bash] skip
+
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=log
+env GH_TELEMETRY_SAMPLE_RATE=100
+
+# Create a local shell extension repository
+exec git init gh-hello
+cp gh-hello.sh gh-hello/gh-hello
+chmod 755 gh-hello/gh-hello
+exec git -C gh-hello add gh-hello
+exec git -C gh-hello commit -m 'init'
+
+# Install it locally
+cd gh-hello
+exec gh ext install .
+cd $WORK
+
+# Run the extension and verify no telemetry is logged
+exec gh hello
+stdout 'hello from extension'
+! stderr 'Telemetry payload:'
+
+-- gh-hello.sh --
+#!/usr/bin/env bash
+echo "hello from extension"

acceptance/testdata/telemetry/no-telemetry-for-ghes-user.txtar

@@ -0,0 +1,8 @@
+# GHES users should not get telemetry even when telemetry is enabled
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=log
+env GH_TELEMETRY_SAMPLE_RATE=100
+env GH_ENTERPRISE_TOKEN=fake-enterprise-token
+
+exec gh version
+! stderr 'Telemetry payload:'

acceptance/testdata/telemetry/no-telemetry-for-send-telemetry.txtar

@@ -0,0 +1,14 @@
+# The send-telemetry command should not itself generate a telemetry event
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=log
+env GH_TELEMETRY_SAMPLE_RATE=100
+env GH_TELEMETRY_ENDPOINT_URL=http://localhost:1
+
+# Provide a minimal valid payload on stdin so the command can run.
+# It will fail to connect but that's fine — we only care about telemetry logging.
+stdin payload.json
+! exec gh send-telemetry
+! stderr 'Telemetry payload:'
+
+-- payload.json --
+{"events":[{"type":"test","dimensions":{},"measures":{}}]}

acceptance/testdata/telemetry/telemetry-failure-does-not-break-command.txtar

@@ -0,0 +1,8 @@
+# Command completes successfully even when telemetry endpoint is unreachable
+env GH_PRIVATE_ENABLE_TELEMETRY=1
+env GH_TELEMETRY=enabled
+env GH_TELEMETRY_SAMPLE_RATE=100
+env GH_TELEMETRY_ENDPOINT_URL=http://localhost:1
+
+exec gh version
+stdout 'gh version'

api/http_client.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/cli/cli/v2/internal/gh/ghtelemetry"
 	"github.com/cli/cli/v2/utils"
 	ghAPI "github.com/cli/go-gh/v2/pkg/api"
 	ghauth "github.com/cli/go-gh/v2/pkg/auth"
@@ -26,6 +27,7 @@ type HTTPClientOptions struct {
 	LogColorize        bool
 	LogVerboseHTTP     bool
 	SkipDefaultHeaders bool
+	TelemetryDisabler  ghtelemetry.Disabler
 }
 
 func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) {
@@ -74,6 +76,13 @@ func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) {
 		client.Transport = AddAuthTokenHeader(client.Transport, opts.Config)
 	}
 
+	if opts.TelemetryDisabler != nil {
+		client.Transport = telemetryDisablerTransport{
+			wrappedTransport:  client.Transport,
+			telemetryDisabler: opts.TelemetryDisabler,
+		}
+	}
+
 	return client, nil
 }
 
@@ -147,3 +156,15 @@ func getHost(r *http.Request) string {
 	}
 	return r.URL.Host
 }
+
+type telemetryDisablerTransport struct {
+	wrappedTransport  http.RoundTripper
+	telemetryDisabler ghtelemetry.Disabler
+}
+
+func (t telemetryDisablerTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	if ghauth.IsEnterprise(getHost(req)) {
+		t.telemetryDisabler.Disable()
+	}
+	return t.wrappedTransport.RoundTrip(req)
+}