mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Alex ShtinandGitHub
69e3d20e76
## What changed? <!-- Describe what has changed in this PR --> Switch to code gen approach for extracting WorkflowId/RunId log tags. ## Why? <!-- Tell your future self why have you made these changes --> - Code gen approach is more performant and more verbose. - Some APIs on workflow service didn't log workflow tags (`UpdateWorkflowExecution`). - history and matching services didn't log workflow tags at all (because workflow tags not on the root level in request). Logging these fields is very important for debugging. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> Added unit tests. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> No risks. ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> No. ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No.
112 lines
4.1 KiB
Go
112 lines
4.1 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package main
|
|
|
|
import (
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"go.temporal.io/api/workflowservice/v1"
|
|
"go.temporal.io/server/api/historyservice/v1"
|
|
"go.temporal.io/server/api/matchingservice/v1"
|
|
)
|
|
|
|
func TestWorkflowTagGetters(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
reqT reflect.Type
|
|
workflowIDGetter string
|
|
runIDGetter string
|
|
taskTokenGetter string
|
|
}{
|
|
{
|
|
name: "Request with only workflowID",
|
|
reqT: reflect.TypeOf(&workflowservice.StartWorkflowExecutionRequest{}),
|
|
workflowIDGetter: "GetWorkflowId()",
|
|
},
|
|
{
|
|
name: "Request with workflowID and runID",
|
|
reqT: reflect.TypeOf(&workflowservice.RecordActivityTaskHeartbeatByIdRequest{}),
|
|
workflowIDGetter: "GetWorkflowId()",
|
|
runIDGetter: "GetRunId()",
|
|
},
|
|
{
|
|
name: "Request with execution",
|
|
reqT: reflect.TypeOf(&workflowservice.GetWorkflowExecutionHistoryRequest{}),
|
|
workflowIDGetter: "GetExecution().GetWorkflowId()",
|
|
runIDGetter: "GetExecution().GetRunId()",
|
|
},
|
|
{
|
|
name: "Request with workflow_execution",
|
|
reqT: reflect.TypeOf(&workflowservice.RequestCancelWorkflowExecutionRequest{}),
|
|
workflowIDGetter: "GetWorkflowExecution().GetWorkflowId()",
|
|
runIDGetter: "GetWorkflowExecution().GetRunId()",
|
|
},
|
|
{
|
|
name: "Request with task_token",
|
|
reqT: reflect.TypeOf(&workflowservice.RespondActivityTaskCompletedRequest{}),
|
|
taskTokenGetter: "GetTaskToken()",
|
|
},
|
|
{
|
|
name: "Special handling for RespondQueryTaskCompletedRequest",
|
|
reqT: reflect.TypeOf(&workflowservice.RespondQueryTaskCompletedRequest{}),
|
|
},
|
|
{
|
|
name: "Matching request",
|
|
reqT: reflect.TypeOf(&matchingservice.QueryWorkflowRequest{}),
|
|
workflowIDGetter: "GetQueryRequest().GetExecution().GetWorkflowId()",
|
|
runIDGetter: "GetQueryRequest().GetExecution().GetRunId()",
|
|
},
|
|
{
|
|
name: "History request",
|
|
reqT: reflect.TypeOf(&historyservice.SignalWorkflowExecutionRequest{}),
|
|
workflowIDGetter: "GetSignalRequest().GetWorkflowExecution().GetWorkflowId()",
|
|
runIDGetter: "GetSignalRequest().GetWorkflowExecution().GetRunId()",
|
|
},
|
|
{
|
|
name: "History request overrides",
|
|
reqT: reflect.TypeOf(&historyservice.ReplicateWorkflowStateRequest{}),
|
|
workflowIDGetter: "GetWorkflowState().GetExecutionInfo().GetWorkflowId()",
|
|
runIDGetter: "GetWorkflowState().GetExecutionState().GetRunId()",
|
|
},
|
|
}
|
|
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
rd := workflowTagGetters(tt.reqT, 0)
|
|
if tt.workflowIDGetter != "" {
|
|
assert.Equal(t, tt.workflowIDGetter, rd.WorkflowIdGetter)
|
|
}
|
|
if tt.runIDGetter != "" {
|
|
assert.Equal(t, tt.runIDGetter, rd.RunIdGetter)
|
|
}
|
|
if tt.taskTokenGetter != "" {
|
|
assert.Equal(t, tt.taskTokenGetter, rd.TaskTokenGetter)
|
|
}
|
|
})
|
|
}
|
|
}
|