Skip to content

Remove orphaned PluginResolutionSource telemetry field #1784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vzhang-stripe merged 4 commits into from
Jul 15, 2026
+36 −52
Merged

Remove orphaned PluginResolutionSource telemetry field #1784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d0143f
Remove orphaned PluginResolutionSource telemetry field
vzhang-stripe Jul 13, 2026
eb657bc
format
vzhang-stripe Jul 15, 2026
fd71139
Merge branch 'master' into vzhang-remove-unused-telemetry
vzhang-stripe Jul 15, 2026
702f909
Merge branch 'master' into vzhang-remove-unused-telemetry
vzhang-stripe Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 14 additions & 20 deletions pkg/stripe/analytics_telemetry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,20 @@ const DefaultTelemetryEndpoint = "https://r.stripe.com/0"

// CLIAnalyticsEventMetadata is the structure that holds telemetry data context that is ultimately sent to the Stripe Analytics Service.
type CLIAnalyticsEventMetadata struct {
InvocationID string `url:"invocation_id"` // The invocation id is unique to each context object and represents all events coming from one command / gRPC method call
UserAgent string `url:"user_agent"` // the application that is used to create this request
CommandPath string `url:"command_path"` // the command or gRPC method that initiated this request
CommandFlags string `url:"command_flags"` // Comma-separated list of flags that were passed to the command (only includes flag names, not their values)
PluginName string `url:"plugin_name,omitempty"` // the plugin being installed, when relevant
PluginResolutionSource string `url:"plugin_resolution_source,omitempty"` // temporary source used to resolve plugin metadata
Merchant string `url:"merchant"` // the merchant ID: ex. acct_xxxx
CLIVersion string `url:"cli_version"` // the version of the CLI
OS string `url:"os"` // the OS of the system
GeneratedResource bool `url:"generated_resource"` // whether or not this was a generated resource
AIAgent string `url:"ai_agent,omitempty"` // the AI coding agent that invoked the CLI, if any
InstallMethod string `url:"install_method,omitempty"` // how the CLI was installed
InTmux bool `url:"in_tmux"` // whether the CLI was invoked from within tmux
InScreen bool `url:"in_screen"` // whether the CLI was invoked from within GNU Screen
TerminalProgram string `url:"terminal_program,omitempty"` // the terminal program that invoked the CLI, if any
InvocationID string `url:"invocation_id"` // The invocation id is unique to each context object and represents all events coming from one command / gRPC method call
UserAgent string `url:"user_agent"` // the application that is used to create this request
CommandPath string `url:"command_path"` // the command or gRPC method that initiated this request
CommandFlags string `url:"command_flags"` // Comma-separated list of flags that were passed to the command (only includes flag names, not their values)
PluginName string `url:"plugin_name,omitempty"` // the plugin being installed, when relevant
Merchant string `url:"merchant"` // the merchant ID: ex. acct_xxxx
CLIVersion string `url:"cli_version"` // the version of the CLI
OS string `url:"os"` // the OS of the system
GeneratedResource bool `url:"generated_resource"` // whether or not this was a generated resource
AIAgent string `url:"ai_agent,omitempty"` // the AI coding agent that invoked the CLI, if any
InstallMethod string `url:"install_method,omitempty"` // how the CLI was installed
InTmux bool `url:"in_tmux"` // whether the CLI was invoked from within tmux
InScreen bool `url:"in_screen"` // whether the CLI was invoked from within GNU Screen
TerminalProgram string `url:"terminal_program,omitempty"` // the terminal program that invoked the CLI, if any
}

// TelemetryClient is an interface that can send two types of events: an API request, and just general events.
Expand Down Expand Up @@ -162,11 +161,6 @@ func (e *CLIAnalyticsEventMetadata) SetPluginName(pluginName string) {
e.PluginName = pluginName
}

// SetPluginResolutionSource sets the source used to resolve plugin metadata on the CLIAnalyticsEventContext object.
func (e *CLIAnalyticsEventMetadata) SetPluginResolutionSource(pluginResolutionSource string) {
e.PluginResolutionSource = pluginResolutionSource
}

// SendAPIRequestEvent is a special function for API requests
func (a *AnalyticsTelemetryClient) SendAPIRequestEvent(ctx context.Context, requestID string, livemode bool) (*http.Response, error) {
a.wg.Add(1)
Expand Down
54 changes: 22 additions & 32 deletions pkg/stripe/analytics_telemetry_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,6 @@ func TestSetPluginName(t *testing.T) {
require.Equal(t, "apps", tel.PluginName)
}

func TestSetPluginResolutionSource(t *testing.T) {
tel := stripe.NewEventMetadata()
tel.SetPluginResolutionSource("metadata_endpoint")
require.Equal(t, "metadata_endpoint", tel.PluginResolutionSource)
}

// AnalyticsClient Tests
func TestSendAPIRequestEvent(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Expand All @@ -113,7 +107,6 @@ func TestSendAPIRequestEvent(t *testing.T) {
require.Contains(t, bodyString, "merchant=acct_1234")
require.Contains(t, bodyString, "os=darwin")
require.Contains(t, bodyString, "plugin_name=apps")
require.Contains(t, bodyString, "plugin_resolution_source=metadata_endpoint")
require.Contains(t, bodyString, "request_id=req_zzz")
require.Contains(t, bodyString, "terminal_program=iTerm.app")
require.Contains(t, bodyString, "user_agent=Unit+Test")
Expand All @@ -124,18 +117,17 @@ func TestSendAPIRequestEvent(t *testing.T) {
baseURL, _ := url.Parse(ts.URL)

telemetryMetadata := &stripe.CLIAnalyticsEventMetadata{
InvocationID: "123456",
UserAgent: "Unit Test",
CLIVersion: "master",
OS: "darwin",
CommandPath: "stripe test",
PluginName: "apps",
PluginResolutionSource: "metadata_endpoint",
Merchant: "acct_1234",
GeneratedResource: false,
InTmux: true,
InScreen: true,
TerminalProgram: "iTerm.app",
InvocationID: "123456",
UserAgent: "Unit Test",
CLIVersion: "master",
OS: "darwin",
CommandPath: "stripe test",
PluginName: "apps",
Merchant: "acct_1234",
GeneratedResource: false,
InTmux: true,
InScreen: true,
TerminalProgram: "iTerm.app",
}
processCtx := stripe.WithEventMetadata(context.Background(), telemetryMetadata)
analyticsClient := stripe.AnalyticsTelemetryClient{BaseURL: baseURL, HTTPClient: &http.Client{}}
Expand Down Expand Up @@ -179,7 +171,6 @@ func TestSendEvent(t *testing.T) {
require.Contains(t, bodyString, "merchant=acct_1234")
require.Contains(t, bodyString, "os=darwin")
require.Contains(t, bodyString, "plugin_name=apps")
require.Contains(t, bodyString, "plugin_resolution_source=metadata_endpoint")
require.Contains(t, bodyString, "terminal_program=iTerm.app")
require.Contains(t, bodyString, "user_agent=Unit+Test")
// ai_agent should not be present when empty (omitempty)
Expand All @@ -189,18 +180,17 @@ func TestSendEvent(t *testing.T) {
baseURL, _ := url.Parse(ts.URL)

telemetryMetadata := &stripe.CLIAnalyticsEventMetadata{
InvocationID: "123456",
UserAgent: "Unit Test",
CLIVersion: "master",
OS: "darwin",
CommandPath: "stripe test",
PluginName: "apps",
PluginResolutionSource: "metadata_endpoint",
Merchant: "acct_1234",
GeneratedResource: false,
InTmux: true,
InScreen: true,
TerminalProgram: "iTerm.app",
InvocationID: "123456",
UserAgent: "Unit Test",
CLIVersion: "master",
OS: "darwin",
CommandPath: "stripe test",
PluginName: "apps",
Merchant: "acct_1234",
GeneratedResource: false,
InTmux: true,
InScreen: true,
TerminalProgram: "iTerm.app",
}
processCtx := stripe.WithEventMetadata(context.Background(), telemetryMetadata)
analyticsClient := stripe.AnalyticsTelemetryClient{BaseURL: baseURL, HTTPClient: &http.Client{}}
Expand Down
Loading