Update Usage

Author: EyalDelarea

general/token/oidctokenexchange.go

@@ -4,9 +4,11 @@ import (
 	"fmt"
 	rtUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
 	"github.com/jfrog/jfrog-client-go/access/services"
 	"github.com/jfrog/jfrog-client-go/auth"
 	"github.com/jfrog/jfrog-client-go/utils/log"
+	"os"
 	"strings"
 )
 
@@ -30,20 +32,27 @@ func (p OidcProviderType) String() string {
 }
 
 func OidcProviderTypeFromString(providerType string) (OidcProviderType, error) {
+	var oidcProviderType OidcProviderType
 	if providerType == "" {
 		// If no provider type is provided, return 0 (GitHub) as default
-		return 0, nil
+		oidcProviderType = 0
+	} else {
+		switch strings.ToLower(providerType) {
+		case strings.ToLower(GitHub.String()):
+			oidcProviderType = GitHub
+		case strings.ToLower(Azure.String()):
+			oidcProviderType = Azure
+		case strings.ToLower(GenericOidc.String()):
+			oidcProviderType = GenericOidc
+		default:
+			return 0, fmt.Errorf("unsupported oidc provider type: %s", providerType)
+		}
 	}
-	switch strings.ToLower(providerType) {
-	case strings.ToLower(GitHub.String()):
-		return GitHub, nil
-	case strings.ToLower(Azure.String()):
-		return Azure, nil
-	case strings.ToLower(GenericOidc.String()):
-		return GenericOidc, nil
-	default:
-		return 0, fmt.Errorf("unsupported oidc provider type: %s", providerType)
+	// This is used for usage reporting
+	if err := os.Setenv(coreutils.OidcProviderType, oidcProviderType.String()); err != nil {
+		log.Warn("Failed to set JFROG_CLI_OIDC_PROVIDER_TYPE environment variable")
 	}
+	return oidcProviderType, nil
 }
 
 type OidcTokenExchangeCommand struct {

utils/usage/visibility/commands_count_metric.go

@@ -10,6 +10,7 @@ type commandsCountLabels struct {
 	ProductID                            string `json:"product_id"`
 	ProductVersion                       string `json:"product_version"`
 	FeatureID                            string `json:"feature_id"`
+	ProviderType                         string `json:"provider_type"`
 	JobID                                string `json:"job_id"`
 	RunID                                string `json:"run_id"`
 	GitRepo                              string `json:"git_repo"`
@@ -24,9 +25,10 @@ func NewCommandsCountMetric(commandName string) services.VisibilityMetric {
 			ProductID:                            coreutils.GetCliUserAgentName(),
 			ProductVersion:                       coreutils.GetCliUserAgentVersion(),
 			FeatureID:                            commandName,
-			JobID:                                os.Getenv("JFROG_CLI_CI_JOB_ID"),
-			RunID:                                os.Getenv("JFROG_CLI_CI_RUN_ID"),
-			GitRepo:                              os.Getenv("JFROG_CLI_USAGE_GIT_REPO"),
+			ProviderType:                         os.Getenv(coreutils.OidcProviderType),
+			JobID:                                os.Getenv(coreutils.CIJobID),
+			RunID:                                os.Getenv(coreutils.CIRunID),
+			GitRepo:                              os.Getenv(coreutils.SourceCodeRepository),
 			GhTokenForCodeScanningAlertsProvided: os.Getenv("JFROG_CLI_USAGE_GH_TOKEN_FOR_CODE_SCANNING_ALERTS_PROVIDED"),
 		},
 	}

utils/usage/visibility/commands_count_metric_test.go

@@ -2,6 +2,7 @@ package visibility
 
 import (
 	"encoding/json"
+	"github.com/jfrog/jfrog-cli-core/v2/general/token"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
 	testsutils "github.com/jfrog/jfrog-client-go/utils/tests"
 	"github.com/stretchr/testify/assert"
@@ -11,9 +12,10 @@ import (
 func TestCreateCommandsCountMetric(t *testing.T) {
 	// Set environment variables for the test using SetEnvWithCallbackAndAssert
 	envVars := map[string]string{
-		"JFROG_CLI_CI_JOB_ID":      "job123",
-		"JFROG_CLI_CI_RUN_ID":      "run456",
-		"JFROG_CLI_USAGE_GIT_REPO": "test-repo",
+		coreutils.CIJobID:              "job123",
+		coreutils.CIRunID:              "run456",
+		coreutils.SourceCodeRepository: "test-repo",
+		coreutils.OidcProviderType:     token.GitHub.String(),
 		"JFROG_CLI_USAGE_GH_TOKEN_FOR_CODE_SCANNING_ALERTS_PROVIDED": "TRUE",
 	}
 	cleanupFuncs := []func(){}
@@ -40,6 +42,7 @@ func TestCreateCommandsCountMetric(t *testing.T) {
 			"product_id": "` + coreutils.GetCliUserAgentName() + `",
 			"product_version": "` + coreutils.GetCliUserAgentVersion() + `",
 			"feature_id": "testCommand",
+     		"provider_type": "GitHub",
 			"job_id": "job123",
 			"run_id": "run456",
 			"git_repo": "test-repo",