Skip to content

Add missing request IDs #1458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2025
Merged

Add missing request IDs #1458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions internal/internal_task_handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import (
"time"

"github.com/opentracing/opentracing-go"
"github.com/pborman/uuid"
"github.com/uber-go/tally"
"go.uber.org/zap"

Expand Down Expand Up @@ -1627,6 +1628,7 @@ func signalWorkflow(
SignalName: common.StringPtr(signalName),
Input: signalInput,
Identity: common.StringPtr(identity),
RequestId: common.StringPtr(uuid.New()),
}

return backoff.Retry(ctx,
Expand Down
3 changes: 2 additions & 1 deletion internal/internal_workflow_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,8 @@ func (wc *workflowClient) CancelWorkflow(ctx context.Context, workflowID string,
WorkflowId: common.StringPtr(workflowID),
RunId: getRunID(runID),
},
Identity: common.StringPtr(wc.identity),
Identity: common.StringPtr(wc.identity),
RequestId: common.StringPtr(uuid.New()),
}

for _, opt := range opts {
Expand Down
89 changes: 59 additions & 30 deletions internal/internal_workflow_client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1047,6 +1047,31 @@ func (s *workflowClientTestSuite) TearDownSubTest() {
s.TearDownTest()
}

func (s *workflowClientTestSuite) TestSignalWorkflow() {
signalName := "my signal"
signalInput := []byte("my signal input")

s.service.EXPECT().SignalWorkflowExecution(gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(func(_ context.Context, request *shared.SignalWorkflowExecutionRequest, _ ...yarpc.CallOption) error {
s.NotNil(request.RequestId)
request.RequestId = nil
s.Equal(&shared.SignalWorkflowExecutionRequest{
Domain: common.StringPtr(domain),
WorkflowExecution: &shared.WorkflowExecution{
WorkflowId: common.StringPtr(workflowID),
RunId: common.StringPtr(runID),
},
SignalName: common.StringPtr(signalName),
Input: signalInput,
Identity: common.StringPtr(identity),
RequestId: nil,
}, request)
return nil
}).Times(1)

err := s.client.SignalWorkflow(context.Background(), workflowID, runID, signalName, signalInput)
s.NoError(err)
}

func (s *workflowClientTestSuite) TestSignalWithStartWorkflow() {
signalName := "my signal"
signalInput := []byte("my signal input")
Expand Down Expand Up @@ -1707,46 +1732,50 @@ func serializeEvents(events []*shared.HistoryEvent) *shared.DataBlob {
}

func (s *workflowClientTestSuite) TestCancelWorkflow() {
s.service.EXPECT().RequestCancelWorkflowExecution(gomock.Any(), newPartialCancelRequestMatcher(common.StringPtr("testWf"), common.StringPtr("test reason")), gomock.All(gomock.Any())).Return(nil)
s.service.EXPECT().RequestCancelWorkflowExecution(gomock.Any(), gomock.Any(), gomock.All(gomock.Any())).DoAndReturn(func(_ context.Context, request *shared.RequestCancelWorkflowExecutionRequest, _ ...yarpc.CallOption) error {
s.NotNil(request.RequestId)
request.RequestId = nil
s.Equal(&shared.RequestCancelWorkflowExecutionRequest{
Domain: common.StringPtr(domain),
WorkflowExecution: &shared.WorkflowExecution{
WorkflowId: common.StringPtr(workflowID),
RunId: common.StringPtr(runID),
},
Identity: common.StringPtr(identity),
RequestId: nil,
Cause: common.StringPtr("test reason"),
FirstExecutionRunID: nil,
}, request)
return nil
}).Times(1)

err := s.client.CancelWorkflow(context.Background(), "testWf", "testRun", WithCancelReason("test reason"))
err := s.client.CancelWorkflow(context.Background(), workflowID, runID, WithCancelReason("test reason"))

s.NoError(err)
}

func (s *workflowClientTestSuite) TestCancelWorkflowBackwardsCompatible() {
s.service.EXPECT().RequestCancelWorkflowExecution(gomock.Any(), newPartialCancelRequestMatcher(common.StringPtr("testWf"), nil), gomock.All(gomock.Any())).Return(nil)

err := s.client.CancelWorkflow(context.Background(), "testWf", "testRun")
s.service.EXPECT().RequestCancelWorkflowExecution(gomock.Any(), gomock.Any(), gomock.All(gomock.Any())).DoAndReturn(func(_ context.Context, request *shared.RequestCancelWorkflowExecutionRequest, _ ...yarpc.CallOption) error {
s.NotNil(request.RequestId)
request.RequestId = nil
s.Equal(&shared.RequestCancelWorkflowExecutionRequest{
Domain: common.StringPtr(domain),
WorkflowExecution: &shared.WorkflowExecution{
WorkflowId: common.StringPtr(workflowID),
RunId: common.StringPtr(runID),
},
Identity: common.StringPtr(identity),
RequestId: nil,
Cause: nil,
FirstExecutionRunID: nil,
}, request)
return nil
}).Times(1)
err := s.client.CancelWorkflow(context.Background(), workflowID, runID)

s.NoError(err)
}

type PartialCancelRequestMatcher struct {
wfID *string
cause *string
}

func newPartialCancelRequestMatcher(wfID *string, cause *string) gomock.Matcher {
return &PartialCancelRequestMatcher{
wfID: wfID,
cause: cause,
}
}

func (m *PartialCancelRequestMatcher) Matches(a interface{}) bool {
aEx, ok := a.(*shared.RequestCancelWorkflowExecutionRequest)
if !ok {
return false
}

return (aEx.Cause == m.cause || *aEx.Cause == *m.cause) && *aEx.WorkflowExecution.WorkflowId == *m.wfID
}

func (m *PartialCancelRequestMatcher) String() string {
return "partial cancellation request matcher matches cause and wfId fields"
}

func (s *workflowClientTestSuite) TestTerminateWorkflow() {
expectedRequest := &shared.TerminateWorkflowExecutionRequest{
Domain: common.StringPtr(domain),
Expand Down