Added metrics for package alias (#1527)

Author: bhanurp

common/commands/command.go

@@ -118,12 +118,14 @@ func reportUsageToVisibilitySystem(command Command, serverDetails *config.Server
 	var visibilityMetricsData *visibility.MetricsData
 	if metricsData != nil {
 		visibilityMetricsData = &visibility.MetricsData{
-			Flags:        metricsData.Flags,
-			Platform:     metricsData.Platform,
-			Architecture: metricsData.Architecture,
-			IsCI:         metricsData.IsCI,
-			CISystem:     metricsData.CISystem,
-			IsContainer:  metricsData.IsContainer,
+			Flags:          metricsData.Flags,
+			Platform:       metricsData.Platform,
+			Architecture:   metricsData.Architecture,
+			IsCI:           metricsData.IsCI,
+			CISystem:       metricsData.CISystem,
+			IsContainer:    metricsData.IsContainer,
+			PackageAlias:   metricsData.PackageAlias,
+			PackageManager: metricsData.PackageManager,
 		}
 	}
 	commandsCountMetric = visibility.NewCommandsCountMetricWithEnhancedData(commandName, visibilityMetricsData)

common/commands/metrics_collector.go

@@ -14,8 +14,9 @@ type MetricsData = metrics.MetricsData
 
 // metricsCollector provides thread-safe collection and storage of command metrics
 type metricsCollector struct {
-	mu          sync.RWMutex
-	metricsData map[string]*MetricsData
+	mu                  sync.RWMutex
+	metricsData         map[string]*MetricsData
+	packageAliasContext string
 }
 
 var contextFlags []string
@@ -32,6 +33,9 @@ func CollectMetrics(commandName string, flags []string) {
 	ciSystem := detectCISystem()
 	isCI := ciSystem != ""
 
+	pkgAliasTool := globalMetricsCollector.packageAliasContext
+	globalMetricsCollector.packageAliasContext = ""
+
 	metricsData := &MetricsData{
 		Flags:        flags,
 		Platform:     runtime.GOOS,
@@ -43,7 +47,9 @@ func CollectMetrics(commandName string, flags []string) {
 			}
 			return ""
 		}(),
-		IsContainer: isRunningInContainer(),
+		IsContainer:    isRunningInContainer(),
+		PackageAlias:   pkgAliasTool != "",
+		PackageManager: pkgAliasTool,
 	}
 
 	globalMetricsCollector.metricsData[commandName] = metricsData
@@ -61,12 +67,14 @@ func GetCollectedMetrics(commandName string) *MetricsData {
 	}
 
 	return &MetricsData{
-		Flags:        append([]string(nil), metrics.Flags...),
-		Platform:     metrics.Platform,
-		Architecture: metrics.Architecture,
-		IsCI:         metrics.IsCI,
-		CISystem:     metrics.CISystem,
-		IsContainer:  metrics.IsContainer,
+		Flags:          append([]string(nil), metrics.Flags...),
+		Platform:       metrics.Platform,
+		Architecture:   metrics.Architecture,
+		IsCI:           metrics.IsCI,
+		CISystem:       metrics.CISystem,
+		IsContainer:    metrics.IsContainer,
+		PackageAlias:   metrics.PackageAlias,
+		PackageManager: metrics.PackageManager,
 	}
 }
 
@@ -164,3 +172,12 @@ func GetContextFlags() []string {
 	contextFlags = nil
 	return flags
 }
+
+// SetPackageAliasContext records that the current command was invoked via a
+// package alias for the given package manager tool (e.g. "npm", "pip").
+// CollectMetrics reads and clears this value automatically.
+func SetPackageAliasContext(tool string) {
+	globalMetricsCollector.mu.Lock()
+	defer globalMetricsCollector.mu.Unlock()
+	globalMetricsCollector.packageAliasContext = tool
+}

common/commands/metrics_collector_test.go

@@ -832,6 +832,56 @@ func TestReportUsageToVisibilitySystemWithoutMetrics(t *testing.T) {
 	}
 }
 
+func TestSetPackageAliasContext(t *testing.T) {
+	ClearAllMetrics()
+	// Ensure context is clear before test
+	globalMetricsCollector.packageAliasContext = ""
+
+	commandName := "npm_install"
+	flags := []string{"save-dev"}
+
+	// Set the package alias context (simulates DispatchIfAlias -> runJFMode)
+	SetPackageAliasContext("npm")
+
+	// Collect metrics (simulates commands.Exec)
+	CollectMetrics(commandName, flags)
+
+	metrics := GetCollectedMetrics(commandName)
+	if metrics == nil {
+		t.Fatal("Expected metrics to be collected")
+	}
+	if !metrics.PackageAlias {
+		t.Error("Expected PackageAlias to be true")
+	}
+	if metrics.PackageManager != "npm" {
+		t.Errorf("Expected PackageManager 'npm', got '%s'", metrics.PackageManager)
+	}
+
+	// packageAliasContext must be cleared after CollectMetrics
+	if globalMetricsCollector.packageAliasContext != "" {
+		t.Errorf("Expected packageAliasContext to be cleared, got '%s'", globalMetricsCollector.packageAliasContext)
+	}
+}
+
+func TestCollectMetrics_WithoutPackageAlias(t *testing.T) {
+	ClearAllMetrics()
+	globalMetricsCollector.packageAliasContext = ""
+
+	commandName := "rt_upload"
+	CollectMetrics(commandName, nil)
+
+	metrics := GetCollectedMetrics(commandName)
+	if metrics == nil {
+		t.Fatal("Expected metrics to be collected")
+	}
+	if metrics.PackageAlias {
+		t.Error("Expected PackageAlias to be false when not set")
+	}
+	if metrics.PackageManager != "" {
+		t.Errorf("Expected PackageManager to be empty, got '%s'", metrics.PackageManager)
+	}
+}
+
 func TestMetricsIntegrationFlow(t *testing.T) {
 	// Clear any existing metrics
 	globalMetricsCollector.mu.Lock()

go.mod

@@ -36,6 +36,7 @@ require (
 	github.com/CycloneDX/cyclonedx-go v0.9.3 // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
 	github.com/ProtonMail/go-crypto v1.3.0 // indirect
+	github.com/ProtonMail/go-crypto v1.3.0 // indirect
 	github.com/VividCortex/ewma v1.2.0 // indirect
 	github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect
 	github.com/andybalholm/brotli v1.2.0 // indirect