Send original update request back in response (temporalio#1480)

Server will use this value to reconstruct the update if it is lost in certain cases.
Quinn-With-Two-Ns · May 21, 2024 · fb06909 · fb06909
1 parent 222d4cf
commit fb06909
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/internal/internal_update.go b/internal/internal_update.go
@@ -91,6 +91,7 @@ type (
 	updateProtocol struct {
 		protoInstanceID string
 		clientIdentity  string
+		initialRequest  *updatepb.Request
 		requestMsgID    string
 		requestSeqID    int64
 		scheduleUpdate  func(name string, id string, args *commonpb.Payloads, header *commonpb.Header, callbacks UpdateCallbacks)
@@ -134,15 +135,16 @@ func (up *updateProtocol) requireState(action string, valid ...updateState) {
 }
 
 func (up *updateProtocol) HandleMessage(msg *protocolpb.Message) error {
-	var req updatepb.Request
-	if err := msg.Body.UnmarshalTo(&req); err != nil {
+	var request updatepb.Request
+	if err := msg.Body.UnmarshalTo(&request); err != nil {
 		return err
 	}
+	up.initialRequest = &request
 	up.requireState("update request", updateStateNew)
 	up.requestMsgID = msg.GetId()
 	up.requestSeqID = msg.GetEventId()
-	input := req.GetInput()
-	up.scheduleUpdate(input.GetName(), req.GetMeta().GetUpdateId(), input.GetArgs(), input.GetHeader(), up)
+	input := up.initialRequest.GetInput()
+	up.scheduleUpdate(input.GetName(), up.initialRequest.GetMeta().GetUpdateId(), input.GetArgs(), input.GetHeader(), up)
 	up.state = updateStateRequestInitiated
 	return nil
 }
@@ -157,8 +159,11 @@ func (up *updateProtocol) Accept() {
 		Body: protocol.MustMarshalAny(&updatepb.Acceptance{
 			AcceptedRequestMessageId:         up.requestMsgID,
 			AcceptedRequestSequencingEventId: up.requestSeqID,
+			AcceptedRequest:                  up.initialRequest,
 		}),
 	}, withExpectedEventPredicate(up.checkAcceptedEvent))
+	// Stop holding a reference to the initial request to allow it to be GCed
+	up.initialRequest = nil
 	up.state = updateStateAccepted
 }
 
@@ -171,8 +176,8 @@ func (up *updateProtocol) Reject(err error) {
 		Body: protocol.MustMarshalAny(&updatepb.Rejection{
 			RejectedRequestMessageId:         up.requestMsgID,
 			RejectedRequestSequencingEventId: up.requestSeqID,
+			RejectedRequest:                  up.initialRequest,
 			Failure:                          up.env.GetFailureConverter().ErrorToFailure(err),
-			// RejectedRequest field no longer read by server - will be removed from API soon
 		}),
 	})
 	up.state = updateStateCompleted

diff --git a/internal/internal_update_test.go b/internal/internal_update_test.go
@@ -574,8 +574,8 @@ func TestAcceptedEventPredicate(t *testing.T) {
 
 	var acptmsg updatepb.Acceptance
 	require.NoError(t, env.outbox[0].msg.Body.UnmarshalTo(&acptmsg))
-	require.Nil(t, acptmsg.AcceptedRequest,
-		"do not send the original request back - this field will be removed soon")
+	require.EqualExportedValues(t, &request, acptmsg.AcceptedRequest,
+		"Sent the original request back in the accepted message")
 
 	pred := env.outbox[0].eventPredicate
 	for _, tc := range [...]struct {