Added-json-header

Author: basel1322

commands/curation/curationaudit.go

@@ -84,10 +84,28 @@ const (
 	waiverHeader = "X-Artifactory-Curation-Request-Waiver"
 )
 
-// generateWaiverHeaderValue creates a header value with a unique batch ID
 func generateWaiverHeaderValue() string {
-	batchID := fmt.Sprintf("batch_%s", uuid.New().String()[:8])
-	return fmt.Sprintf("syn_JFrog-Curation-Client_%s", batchID)
+	batchID := uuid.New().String()
+	headerData := map[string]string{
+		"batch_id": batchID,
+	}
+	jsonData, _ := json.Marshal(headerData)
+	return string(jsonData)
+}
+
+// addFieldToWaiverHeader adds a field to the existing waiver header JSON and returns the updated JSON string
+func addFieldToWaiverHeader(fieldName string, fieldValue interface{}) (string, error) {
+	// Parse the existing header
+	var headerData map[string]interface{}
+	if err := json.Unmarshal([]byte(waiverHeaderValue), &headerData); err != nil {
+		return "", fmt.Errorf("failed to parse waiver header: %v", err)
+	}
+	headerData[fieldName] = fieldValue
+	updatedHeaderData, err := json.Marshal(headerData)
+	if err != nil {
+		return "", fmt.Errorf("failed to marshal updated header: %v", err)
+	}
+	return string(updatedHeaderData), nil
 }
 
 // createRequestDetails creates a copy of httpClientDetails for thread-safe header modification
@@ -919,9 +937,7 @@ func (nc *treeAnalyzer) fetchNodeStatus(node xrayUtils.GraphNode, p *sync.Map) e
 func (nc *treeAnalyzer) getBlockedPackageDetails(packageUrl string, name string, version string) (*PackageStatus, error) {
 	// Create a copy of httpClientDetails for this request to avoid modifying the shared one
 	requestDetails := nc.createRequestDetails()
-
-	// Set the header for regular GET request
-	requestDetails.Headers[waiverHeader] = waiverHeaderValue
+	requestDetails.Headers[waiverHeader] = "syn"
 
 	getResp, respBody, _, err := nc.rtManager.Client().SendGet(packageUrl, true, &requestDetails)
 	if err != nil {
@@ -963,16 +979,14 @@ func (nc *treeAnalyzer) getBlockedPackageDetails(packageUrl string, name string,
 	return nil, nil
 }
 
-// sendCompletedRequest sends a final request with the _completed header
 func (nc *treeAnalyzer) sendCompletedRequest(packageUrl string) error {
-	// Create a copy of httpClientDetails for this request
 	requestDetails := nc.createRequestDetails()
-
-	// Set the header with _completed suffix
-	requestDetails.Headers[waiverHeader] = waiverHeaderValue + "_completed"
-
-	// Send a HEAD request with the completed header
-	_, _, err := nc.rtManager.Client().SendHead(packageUrl, &requestDetails)
+	completedHeaderData, err := addFieldToWaiverHeader("completed", true)
+	if err != nil {
+		return err
+	}
+	requestDetails.Headers[waiverHeader] = completedHeaderData
+	_, _, err = nc.rtManager.Client().SendHead(packageUrl, &requestDetails)
 	return err
 }
 

commands/curation/curationaudit_test.go

@@ -488,10 +488,15 @@ func createTempHomeDirWithConfig(t *testing.T, basePathToTests string, testCase
 func TestCurationHeaders(t *testing.T) {
 	// Test that batch ID generation works correctly
 	headerValue := generateWaiverHeaderValue()
-	assert.True(t, strings.HasPrefix(headerValue, "syn_JFrog-Curation-Client_batch_"))
-	assert.Len(t, strings.Split(headerValue, "_"), 4) // syn_JFrog-Curation-Client_batch_<id>
 
-	// Test that completed request adds "_completed" suffix
+	// Verify it's valid JSON with batch_id
+	var headerData map[string]interface{}
+	err := json.Unmarshal([]byte(headerValue), &headerData)
+	require.NoError(t, err)
+	assert.Contains(t, headerData, "batch_id")
+	assert.NotEmpty(t, headerData["batch_id"])
+
+	// Test that completed request adds "completed" flag
 	var capturedHeader http.Header
 	testHandler := func(w http.ResponseWriter, r *http.Request) {
 		capturedHeader = r.Header.Clone()
@@ -506,22 +511,73 @@ func TestCurationHeaders(t *testing.T) {
 	require.NoError(t, err)
 	rtManager, err := rtUtils.CreateServiceManager(mockServerDetails, 2, 0, false)
 	require.NoError(t, err)
-
 	analyzer := &treeAnalyzer{
 		rtManager:         rtManager,
 		httpClientDetails: rtAuth.CreateHttpClientDetails(),
 	}
-
-	// Use real header format like: syn_JFrog-Curation-Client_batch_a3404ff3
-	waiverHeaderValue = "syn_JFrog-Curation-Client_batch_a3404ff3"
+	// Use JSON header format like: {"batch_id":"196c55b0-5724-4a94-aa45-9b0bfd658985"}
+	waiverHeaderValue = `{"batch_id":"196c55b0-5724-4a94-aa45-9b0bfd658985"}`
 	testUrl := mockServerDetails.GetArtifactoryUrl() + "/test/pkg"
 	err = analyzer.sendCompletedRequest(testUrl)
 	assert.NoError(t, err)
-
-	// Verify the header has "_completed" suffix
 	assert.NotNil(t, capturedHeader)
 	waiverHeader := capturedHeader["X-Artifactory-Curation-Request-Waiver"]
-	assert.Equal(t, "syn_JFrog-Curation-Client_batch_a3404ff3_completed", waiverHeader[0])
+
+	// Parse the completed header JSON
+	var completedHeaderData map[string]interface{}
+	err = json.Unmarshal([]byte(waiverHeader[0]), &completedHeaderData)
+	require.NoError(t, err)
+	assert.Equal(t, "196c55b0-5724-4a94-aa45-9b0bfd658985", completedHeaderData["batch_id"])
+	assert.Equal(t, true, completedHeaderData["completed"])
+}
+
+func TestCurationSynHeader(t *testing.T) {
+	// Test that syn field is added correctly to the header
+	headerValue := generateWaiverHeaderValue()
+
+	// Verify it's valid JSON with batch_id
+	var headerData map[string]interface{}
+	err := json.Unmarshal([]byte(headerValue), &headerData)
+	require.NoError(t, err)
+	assert.Contains(t, headerData, "batch_id")
+	assert.NotEmpty(t, headerData["batch_id"])
+
+	// Add syn field (simulating what happens in getBlockedPackageDetails)
+	headerData["syn"] = true
+	synHeaderData, err := json.Marshal(headerData)
+	require.NoError(t, err)
+
+	// Verify the final JSON contains both batch_id and syn
+	var finalHeaderData map[string]interface{}
+	err = json.Unmarshal(synHeaderData, &finalHeaderData)
+	require.NoError(t, err)
+	assert.Equal(t, true, finalHeaderData["syn"])
+	assert.Contains(t, finalHeaderData, "batch_id")
+}
+
+func TestAddFieldToWaiverHeader(t *testing.T) {
+	// Test the helper function directly
+	waiverHeaderValue = `{"batch_id":"test-batch-123"}`
+
+	// Add syn field
+	synHeader, err := addFieldToWaiverHeader("syn", true)
+	require.NoError(t, err)
+
+	var synData map[string]interface{}
+	err = json.Unmarshal([]byte(synHeader), &synData)
+	require.NoError(t, err)
+	assert.Equal(t, "test-batch-123", synData["batch_id"])
+	assert.Equal(t, true, synData["syn"])
+
+	// Add completed field
+	completedHeader, err := addFieldToWaiverHeader("completed", true)
+	require.NoError(t, err)
+
+	var completedData map[string]interface{}
+	err = json.Unmarshal([]byte(completedHeader), &completedData)
+	require.NoError(t, err)
+	assert.Equal(t, "test-batch-123", completedData["batch_id"])
+	assert.Equal(t, true, completedData["completed"])
 }
 
 func setCurationFlagsForTest(t *testing.T) func() {