backend: Include status body in POST notification to ARM

Async Operation Callbacks protocol requires sending a status
payload in the request body of the notification callback.

https://eng.ms/docs/products/arm/api_contracts/asyncoperationcallback#callback-request-body

Author: Matthew Barnes

backend/operations_scanner.go

@@ -4,6 +4,7 @@ package main
 // Licensed under the Apache License 2.0.
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
@@ -357,7 +358,7 @@ func (s *OperationsScanner) updateOperationStatus(ctx context.Context, op operat
 // operation if the initial request included an "Azure-AsyncNotificationUri" header.
 func (s *OperationsScanner) maybePostAsyncNotification(ctx context.Context, op operation) {
 	if len(op.doc.NotificationURI) > 0 {
-		err := s.postAsyncNotification(ctx, op.doc.NotificationURI)
+		err := s.postAsyncNotification(ctx, op.id)
 		if err == nil {
 			op.logger.Info("Posted async notification")
 		} else {
@@ -366,13 +367,26 @@ func (s *OperationsScanner) maybePostAsyncNotification(ctx context.Context, op o
 	}
 }
 
-// postAsyncNotification submits an empty POST request to the given URL.
-func (s *OperationsScanner) postAsyncNotification(ctx context.Context, url string) error {
-	request, err := http.NewRequestWithContext(ctx, http.MethodPost, url, nil)
+// postAsyncNotification submits an POST request with status payload to the given URL.
+func (s *OperationsScanner) postAsyncNotification(ctx context.Context, operationID string) error {
+	// Refetch the operation document to provide the latest status.
+	doc, err := s.dbClient.GetOperationDoc(ctx, operationID)
 	if err != nil {
 		return err
 	}
 
+	data, err := arm.Marshal(doc.ToStatus())
+	if err != nil {
+		return err
+	}
+
+	request, err := http.NewRequestWithContext(ctx, http.MethodPost, doc.NotificationURI, bytes.NewBuffer(data))
+	if err != nil {
+		return err
+	}
+
+	request.Header.Set("Content-Type", "application/json")
+
 	response, err := s.notificationClient.Do(request)
 	if err != nil {
 		return err

backend/operations_scanner_test.go

@@ -70,6 +70,11 @@ func TestSetDeleteOperationAsCompleted(t *testing.T) {
 				t.Fatal(err)
 			}
 
+			operationID, err := azcorearm.ParseResourceID("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RedHatOpenShift/locations/oz/hcpOperationsStatus/operationID")
+			if err != nil {
+				t.Fatal(err)
+			}
+
 			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 				if r.Method == http.MethodPost {
 					request = r
@@ -83,11 +88,12 @@ func TestSetDeleteOperationAsCompleted(t *testing.T) {
 			}
 
 			operationDoc := database.NewOperationDocument(database.OperationRequestDelete, resourceID, internalID)
+			operationDoc.OperationID = operationID
 			operationDoc.NotificationURI = server.URL
 			operationDoc.Status = tt.operationStatus
 
 			op := operation{
-				id:     "this operation",
+				id:     operationID.Name,
 				doc:    operationDoc,
 				logger: slog.Default(),
 			}
@@ -104,6 +110,11 @@ func TestSetDeleteOperationAsCompleted(t *testing.T) {
 				DoAndReturn(func(ctx context.Context, operationID string, callback func(*database.OperationDocument) bool) (bool, error) {
 					return callback(operationDoc), nil
 				})
+			if tt.expectAsyncNotification {
+				mockDBClient.EXPECT().
+					GetOperationDoc(gomock.Any(), op.id).
+					Return(operationDoc, nil)
+			}
 
 			err = scanner.setDeleteOperationAsCompleted(ctx, op)
 
@@ -224,6 +235,11 @@ func TestUpdateOperationStatus(t *testing.T) {
 				t.Fatal(err)
 			}
 
+			operationID, err := azcorearm.ParseResourceID("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RedHatOpenShift/locations/oz/hcpOperationsStatus/operationID")
+			if err != nil {
+				t.Fatal(err)
+			}
+
 			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 				if r.Method == http.MethodPost {
 					request = r
@@ -237,11 +253,12 @@ func TestUpdateOperationStatus(t *testing.T) {
 			}
 
 			operationDoc := database.NewOperationDocument(database.OperationRequestCreate, resourceID, internalID)
+			operationDoc.OperationID = operationID
 			operationDoc.NotificationURI = server.URL
 			operationDoc.Status = tt.currentOperationStatus
 
 			op := operation{
-				id:     "this operation",
+				id:     operationID.Name,
 				doc:    operationDoc,
 				logger: slog.Default(),
 			}
@@ -272,6 +289,11 @@ func TestUpdateOperationStatus(t *testing.T) {
 						return false, database.ErrNotFound
 					}
 				})
+			if tt.expectAsyncNotification {
+				mockDBClient.EXPECT().
+					GetOperationDoc(gomock.Any(), op.id).
+					Return(operationDoc, nil)
+			}
 
 			err = scanner.updateOperationStatus(ctx, op, tt.updatedOperationStatus, nil)