mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-30 14:56:19 +00:00
Carly de FrondevilleandShahabT
d54ffa1263
## What changed? Use MutableSideEffect to access dynamic config from inside workflows. ## Why? To prevent non-determinism in the workflow code. To allow the workflows to use the latest dynamic config values at all times. ## How did you test it? Tests are failing for other reasons, so I'm unable to test until I pull in those changes. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## 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/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> --------- Co-authored-by: ShahabT <[email protected]>
122 lines
4.8 KiB
Go
122 lines
4.8 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 updateworkflowoptions
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
enumspb "go.temporal.io/api/enums/v1"
|
|
workflowpb "go.temporal.io/api/workflow/v1"
|
|
"google.golang.org/protobuf/proto"
|
|
"google.golang.org/protobuf/types/known/fieldmaskpb"
|
|
)
|
|
|
|
var (
|
|
emptyOptions = &workflowpb.WorkflowExecutionOptions{}
|
|
unpinnedOverrideOptions = &workflowpb.WorkflowExecutionOptions{
|
|
VersioningOverride: &workflowpb.VersioningOverride{
|
|
Behavior: enumspb.VERSIONING_BEHAVIOR_AUTO_UPGRADE,
|
|
},
|
|
}
|
|
pinnedOverrideOptionsA = &workflowpb.WorkflowExecutionOptions{
|
|
VersioningOverride: &workflowpb.VersioningOverride{
|
|
Behavior: enumspb.VERSIONING_BEHAVIOR_PINNED,
|
|
PinnedVersion: "X.A",
|
|
},
|
|
}
|
|
pinnedOverrideOptionsB = &workflowpb.WorkflowExecutionOptions{
|
|
VersioningOverride: &workflowpb.VersioningOverride{
|
|
Behavior: enumspb.VERSIONING_BEHAVIOR_PINNED,
|
|
PinnedVersion: "X.B",
|
|
},
|
|
}
|
|
)
|
|
|
|
func TestMergeOptions_VersionOverrideMask(t *testing.T) {
|
|
updateMask := &fieldmaskpb.FieldMask{Paths: []string{"versioning_override"}}
|
|
opts := &workflowpb.WorkflowExecutionOptions{}
|
|
|
|
// Merge unpinned into empty options
|
|
opts, err := applyWorkflowExecutionOptions(opts, unpinnedOverrideOptions, updateMask)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
assert.True(t, proto.Equal(unpinnedOverrideOptions, opts))
|
|
|
|
// Merge pinned_A into unpinned options
|
|
opts, err = applyWorkflowExecutionOptions(opts, pinnedOverrideOptionsA, updateMask)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
assert.True(t, proto.Equal(pinnedOverrideOptionsA, opts))
|
|
|
|
// Merge pinned_B into pinned_A options
|
|
opts, err = applyWorkflowExecutionOptions(opts, pinnedOverrideOptionsB, updateMask)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
assert.True(t, proto.Equal(pinnedOverrideOptionsB, opts))
|
|
|
|
// Unset versioning override
|
|
opts, err = applyWorkflowExecutionOptions(opts, emptyOptions, updateMask)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
assert.True(t, proto.Equal(emptyOptions, opts))
|
|
}
|
|
|
|
func TestMergeOptions_PartialUpdateMask(t *testing.T) {
|
|
bothUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{"versioning_override.behavior", "versioning_override.deployment"}}
|
|
behaviorOnlyUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{"versioning_override.behavior"}}
|
|
deploymentOnlyUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{"versioning_override.deployment"}}
|
|
_, err := applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, behaviorOnlyUpdateMask)
|
|
assert.Error(t, err)
|
|
_, err = applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, deploymentOnlyUpdateMask)
|
|
assert.Error(t, err)
|
|
opts, err := applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, bothUpdateMask)
|
|
assert.NoError(t, err)
|
|
assert.True(t, proto.Equal(unpinnedOverrideOptions, opts))
|
|
}
|
|
|
|
func TestMergeOptions_EmptyPathsMask(t *testing.T) {
|
|
emptyUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{}}
|
|
opts, err := applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, emptyUpdateMask)
|
|
assert.NoError(t, err)
|
|
assert.True(t, proto.Equal(emptyOptions, opts))
|
|
}
|
|
|
|
func TestMergeOptions_AsteriskMask(t *testing.T) {
|
|
asteriskUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{"*"}}
|
|
_, err := applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, asteriskUpdateMask)
|
|
assert.Error(t, err)
|
|
}
|
|
|
|
func TestMergeOptions_FooMask(t *testing.T) {
|
|
fooUpdateMask := &fieldmaskpb.FieldMask{Paths: []string{"foo"}}
|
|
_, err := applyWorkflowExecutionOptions(&workflowpb.WorkflowExecutionOptions{}, unpinnedOverrideOptions, fooUpdateMask)
|
|
assert.Error(t, err)
|
|
}
|