Update XscGitInfoContext struct

artifactory/services/utils/tests/xray/consts.go

@@ -1440,14 +1440,18 @@ const XscGitInfoResponse = `{"multi_scan_id": "3472b4e2-bddc-11ee-a9c9-acde48001
 const XscGitInfoBadResponse = `"failed create git info request: git_repo_url field must contain value"`
 
 var GitInfoContextWithMinimalRequiredFields = xscServices.XscGitInfoContext{
-	GitRepoHttpsCloneUrl: "https://git.jfrog.info/projects/XSC/repos/xsc-service",
-	BranchName:           "feature/XRAY-123-cool-feature",
-	LastCommitHash:       "acc5e24e69a-d3c1-4022-62eb-69e4a1e5",
+	Source: xscServices.CommitContext{
+		GitRepoHttpsCloneUrl: "https://git.jfrog.info/projects/XSC/repos/xsc-service",
+		BranchName:           "feature/XRAY-123-cool-feature",
+		CommitHash:           "acc5e24e69a-d3c1-4022-62eb-69e4a1e5",
+	},
 }
 
 var GitInfoContextWithMissingFields = xscServices.XscGitInfoContext{
-	GitRepoHttpsCloneUrl: "https://git.jfrog.info/projects/XSC/repos/xsc-service",
-	BranchName:           "feature/XRAY-123-cool-feature",
+	Source: xscServices.CommitContext{
+		GitRepoHttpsCloneUrl: "https://git.jfrog.info/projects/XSC/repos/xsc-service",
+		BranchName:           "feature/XRAY-123-cool-feature",
+	},
 }
 
 const TestMultiScanId = "3472b4e2-bddc-11ee-a9c9-acde48001122"

tests/xscanalyticsevent_test.go

@@ -47,35 +47,53 @@ var finalEvent = services.XscAnalyticsGeneralEvent{XscAnalyticsBasicGeneralEvent
 
 func TestXscAddAndUpdateGeneralEvent(t *testing.T) {
 	initXscTest(t, services.LogErrorMinXscVersion, utils.MinXrayVersionXscTransitionToXray)
-	mockServer, analyticsService := createXscMockServerForGeneralEvent(t)
-	defer mockServer.Close()
 
-	msi, err := analyticsService.AddGeneralEvent(initialEvent)
-	assert.NoError(t, err)
-
-	// Validate that the event sent and saved properly in XSC.
-	resp, err := analyticsService.GetGeneralEvent(msi)
-	require.NoError(t, err)
-	assert.Equal(t, initialEvent, *resp)
-
-	finalizeEvent := services.XscAnalyticsGeneralEventFinalize{
-		MultiScanId: msi,
-		XscAnalyticsBasicGeneralEvent: services.XscAnalyticsBasicGeneralEvent{
-			EventStatus:          services.Completed,
-			TotalFindings:        10,
-			TotalIgnoredFindings: 5,
-			TotalScanDuration:    "15s",
+	testCases := []struct {
+		name        string
+		xrayVersion string
+	}{
+		{
+			name:        "Xray version with deprecated AddGeneralEvent",
+			xrayVersion: "3.115.0",
+		},
+		{
+			name:        "Xray version with new AddGeneralEvent",
+			xrayVersion: "3.116.0",
 		},
 	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			mockServer, analyticsService := createXscMockServerForGeneralEvent(t)
+			defer mockServer.Close()
 
-	err = analyticsService.UpdateGeneralEvent(finalizeEvent)
-	assert.NoError(t, err)
+			msi, err := analyticsService.AddGeneralEvent(initialEvent, tc.xrayVersion)
+			assert.NoError(t, err)
 
-	// Validate that the event's update sent and saved properly in XSC.
-	// We add suffix to the msi to enable the mock server to differentiate between the initial response to the final response
-	resp, err = analyticsService.GetGeneralEvent(msi + "-final")
-	assert.NoError(t, err)
-	assert.Equal(t, finalEvent, *resp)
+			// Validate that the event sent and saved properly in XSC.
+			resp, err := analyticsService.GetGeneralEvent(msi)
+			require.NoError(t, err)
+			assert.Equal(t, initialEvent, *resp)
+
+			finalizeEvent := services.XscAnalyticsGeneralEventFinalize{
+				MultiScanId: msi,
+				XscAnalyticsBasicGeneralEvent: services.XscAnalyticsBasicGeneralEvent{
+					EventStatus:          services.Completed,
+					TotalFindings:        10,
+					TotalIgnoredFindings: 5,
+					TotalScanDuration:    "15s",
+				},
+			}
+
+			err = analyticsService.UpdateGeneralEvent(finalizeEvent)
+			assert.NoError(t, err)
+
+			// Validate that the event's update sent and saved properly in XSC.
+			// We add suffix to the msi to enable the mock server to differentiate between the initial response to the final response
+			resp, err = analyticsService.GetGeneralEvent(msi + "-final")
+			assert.NoError(t, err)
+			assert.Equal(t, finalEvent, *resp)
+		})
+	}
 }
 
 func createXscMockServerForGeneralEvent(t *testing.T) (mockServer *httptest.Server, analyticsService *services.AnalyticsEventService) {

xray/services/xsc/xsc.go

@@ -24,10 +24,10 @@ func (xs *XscInnerService) GetVersion() (string, error) {
 	return versionService.GetVersion()
 }
 
-func (xs *XscInnerService) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error) {
+func (xs *XscInnerService) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent, xrayVersion string) (string, error) {
 	eventService := services.NewAnalyticsEventService(xs.client)
 	eventService.XrayDetails = xs.XrayDetails
-	return eventService.AddGeneralEvent(event)
+	return eventService.AddGeneralEvent(event, xrayVersion)
 }
 
 func (xs *XscInnerService) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error {

xsc/manager.go

@@ -50,10 +50,10 @@ func (sm *XscServicesManager) GetVersion() (string, error) {
 }
 
 // AddAnalyticsGeneralEvent will send an analytics metrics general event to Xsc and return MSI (multi scan id) generated by Xsc.
-func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error) {
+func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent, xrayVersion string) (string, error) {
 	eventService := services.NewAnalyticsEventService(sm.client)
 	eventService.XscDetails = sm.config.GetServiceDetails()
-	return eventService.AddGeneralEvent(event)
+	return eventService.AddGeneralEvent(event, xrayVersion)
 }
 
 func (sm *XscServicesManager) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error {

xsc/service.go

@@ -7,7 +7,7 @@ type XscService interface {
 	// GetVersion will return the Xsc version
 	GetVersion() (string, error)
 	// AddAnalyticsGeneralEvent will send an analytics metrics general event to Xsc and return MSI (multi scan id) generated by Xsc.
-	AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)
+	AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent, xrayVersion string) (string, error)
 	// SendXscLogErrorRequest will send an error log to Xsc
 	SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error
 	// UpdateAnalyticsGeneralEvent upon completion of the scan and we have all the results to report on,

xsc/services/analytics.go

@@ -3,13 +3,13 @@ package services
 import (
 	"encoding/json"
 	"fmt"
-	"net/http"
-
 	"github.com/jfrog/jfrog-client-go/auth"
 	"github.com/jfrog/jfrog-client-go/http/jfroghttpclient"
 	"github.com/jfrog/jfrog-client-go/utils"
 	"github.com/jfrog/jfrog-client-go/utils/errorutils"
+	servicesutils "github.com/jfrog/jfrog-client-go/xsc/services/utils"
 	xscutils "github.com/jfrog/jfrog-client-go/xsc/services/utils"
+	"net/http"
 )
 
 const (
@@ -66,10 +66,20 @@ func (vs *AnalyticsEventService) sendGetRequest(msi string) (resp *http.Response
 }
 
 // AddGeneralEvent add general event in Xsc and returns msi generated by Xsc.
-func (vs *AnalyticsEventService) AddGeneralEvent(event XscAnalyticsGeneralEvent) (string, error) {
-	requestContent, err := json.Marshal(event)
-	if err != nil {
-		return "", errorutils.CheckError(err)
+func (vs *AnalyticsEventService) AddGeneralEvent(event XscAnalyticsGeneralEvent, xrayVersion string) (string, error) {
+	var requestContent []byte
+	if err := utils.ValidateMinimumVersion(utils.Xray, xrayVersion, servicesutils.MinXrayVersionNewGitInfoContext); err != nil {
+		// use deprecated event struct
+		deprecatedEvent := convertToDeprecatedEventStruct(event)
+		requestContent, err = json.Marshal(deprecatedEvent)
+		if err != nil {
+			return "", errorutils.CheckError(err)
+		}
+	} else {
+		requestContent, err = json.Marshal(event)
+		if err != nil {
+			return "", errorutils.CheckError(err)
+		}
 	}
 	resp, body, err := vs.sendPostRequest(requestContent)
 	if err != nil {
@@ -113,24 +123,75 @@ func (vs *AnalyticsEventService) GetGeneralEvent(msi string) (*XscAnalyticsGener
 	return &response, errorutils.CheckError(err)
 }
 
+func convertToDeprecatedEventStruct(event XscAnalyticsGeneralEvent) XscAnalyticsGeneralEventDeprecated {
+	var deprecatedGitInfo XscGitInfoContextDeprecated
+	if event.GitInfo != nil {
+		deprecatedGitInfo = XscGitInfoContextDeprecated{
+			GitRepoUrl:    event.GitInfo.Source.GitRepoHttpsCloneUrl,
+			GitRepoName:   event.GitInfo.Source.GitRepoName,
+			GitProject:    event.GitInfo.Source.GitProject,
+			BranchName:    event.GitInfo.Source.BranchName,
+			CommitHash:    event.GitInfo.Source.CommitHash,
+			CommitMessage: event.GitInfo.Source.CommitMessage,
+			CommitAuthor:  event.GitInfo.Source.CommitAuthor,
+			GitProvider:   event.GitInfo.GitProvider,
+			Technologies:  event.GitInfo.Technologies,
+		}
+	}
+	return XscAnalyticsGeneralEventDeprecated{
+		XscAnalyticsBasicGeneralEvent: event.XscAnalyticsBasicGeneralEvent,
+		GitInfo:                       &deprecatedGitInfo,
+		IsGitInfoFlow:                 event.IsGitInfoFlow,
+	}
+}
+
 // XscAnalyticsGeneralEvent extend the basic struct with Frogbot related info.
+type XscAnalyticsGeneralEventDeprecated struct {
+	XscAnalyticsBasicGeneralEvent
+	GitInfo       *XscGitInfoContextDeprecated `json:"gitinfo,omitempty"`
+	IsGitInfoFlow bool                         `json:"is_gitinfo_flow,omitempty"`
+}
+
+type XscGitInfoContextDeprecated struct {
+	GitRepoUrl    string   `json:"git_repo_url"`
+	GitRepoName   string   `json:"git_repo_name,omitempty"`
+	GitProject    string   `json:"git_project,omitempty"`
+	GitProvider   string   `json:"git_provider,omitempty"`
+	Technologies  []string `json:"technologies,omitempty"`
+	BranchName    string   `json:"branch_name"`
+	LastCommit    string   `json:"last_commit,omitempty"`
+	CommitHash    string   `json:"commit_hash"`
+	CommitMessage string   `json:"commit_message,omitempty"`
+	CommitAuthor  string   `json:"commit_author,omitempty"`
+}
+
 type XscAnalyticsGeneralEvent struct {
 	XscAnalyticsBasicGeneralEvent
 	GitInfo       *XscGitInfoContext `json:"gitinfo,omitempty"`
 	IsGitInfoFlow bool               `json:"is_gitinfo_flow,omitempty"`
 }
 
 type XscGitInfoContext struct {
-	GitRepoHttpsCloneUrl string   `json:"git_repo_url"`
-	GitRepoName          string   `json:"git_repo_name,omitempty"`
-	GitProject           string   `json:"git_project,omitempty"`
-	GitProvider          string   `json:"git_provider,omitempty"`
-	Technologies         []string `json:"technologies,omitempty"`
-	BranchName           string   `json:"branch_name"`
-	LastCommitUrl        string   `json:"last_commit,omitempty"`
-	LastCommitHash       string   `json:"commit_hash"`
-	LastCommitMessage    string   `json:"commit_message,omitempty"`
-	LastCommitAuthor     string   `json:"commit_author,omitempty"`
+	Source       CommitContext       `json:"source,omitempty"`
+	PullRequest  *PullRequestContext `json:"pull_request,omitempty"`
+	GitProvider  string              `json:"git_provider,omitempty"`
+	Technologies []string            `json:"technologies,omitempty"`
+}
+
+type CommitContext struct {
+	GitRepoHttpsCloneUrl string `json:"git_repo_url"`
+	GitRepoName          string `json:"git_repo_name,omitempty"`
+	GitProject           string `json:"git_project,omitempty"`
+	BranchName           string `json:"branch_name"`
+	CommitHash           string `json:"commit_hash"`
+	CommitMessage        string `json:"commit_message,omitempty"`
+	CommitAuthor         string `json:"commit_author,omitempty"`
+}
+
+type PullRequestContext struct {
+	PullRequestId    int    `json:"pull_request_id,omitempty"`
+	PullRequestTitle string `json:"pull_request_title,omitempty"`
+	TargetBranchName string `json:"target_branch_name,omitempty"`
 }
 
 type XscAnalyticsGeneralEventFinalize struct {

xsc/services/utils/utils.go

@@ -14,6 +14,7 @@ const (
 	apiV1Suffix                       = "api/v1"
 	XscInXraySuffix                   = apiV1Suffix + xscSuffix
 	MinXrayVersionXscTransitionToXray = "3.107.13"
+	MinXrayVersionNewGitInfoContext   = "3.116.0"
 )
 
 // From Xray version 3.107.13, XSC is transitioning to Xray as inner service. This function will return compatible URL.