-
Notifications
You must be signed in to change notification settings - Fork 911
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.
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
Async Updates and the Poll API #4309
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
11659f8
Fully implement the PollUpdate api
2a20bf1
Remove update outcome lazy fetching
9b717fd
Use ReadyFuture as the parameter type to update.newCompleted
956f9e6
combine validation with selecting the wait function
b3c11b8
buffer error channels in test to avoid leaking a goro
f9dad4f
Remove unused struct
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| // 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 pollupdate | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "go.temporal.io/api/serviceerror" | ||
| "go.temporal.io/api/workflowservice/v1" | ||
| "go.temporal.io/server/api/historyservice/v1" | ||
| "go.temporal.io/server/common/definition" | ||
| "go.temporal.io/server/service/history/api" | ||
| "go.temporal.io/server/service/history/workflow" | ||
| "go.temporal.io/server/service/history/workflow/update" | ||
| ) | ||
|
|
||
| func Invoke( | ||
| ctx context.Context, | ||
| req *historyservice.PollWorkflowExecutionUpdateRequest, | ||
| ctxLookup api.WorkflowConsistencyChecker, | ||
| ) (*historyservice.PollWorkflowExecutionUpdateResponse, error) { | ||
| updateRef := req.GetRequest().GetUpdateRef() | ||
| wfexec := updateRef.GetWorkflowExecution() | ||
| upd, ok, err := func() (*update.Update, bool, error) { | ||
| wfctx, err := ctxLookup.GetWorkflowContext( | ||
| ctx, | ||
| nil, | ||
| api.BypassMutableStateConsistencyPredicate, | ||
| definition.NewWorkflowKey( | ||
| req.GetNamespaceId(), | ||
| wfexec.GetWorkflowId(), | ||
| wfexec.GetRunId(), | ||
| ), | ||
| workflow.LockPriorityHigh, | ||
| ) | ||
| if err != nil { | ||
| return nil, false, err | ||
| } | ||
| release := wfctx.GetReleaseFn() | ||
| defer release(nil) | ||
| upd, found := wfctx.GetUpdateRegistry(ctx).Find(ctx, updateRef.UpdateId) | ||
| return upd, found, nil | ||
| }() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if !ok { | ||
| return nil, serviceerror.NewNotFound(fmt.Sprintf("update %q not found", updateRef.GetUpdateId())) | ||
| } | ||
| outcome, err := upd.WaitOutcome(ctx) | ||
mmcshane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &historyservice.PollWorkflowExecutionUpdateResponse{ | ||
| Response: &workflowservice.PollWorkflowExecutionUpdateResponse{ | ||
| Outcome: outcome, | ||
| }, | ||
| }, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| // 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 pollupdate_test | ||
MichaelSnowden marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| commonpb "go.temporal.io/api/common/v1" | ||
| failurepb "go.temporal.io/api/failure/v1" | ||
| "go.temporal.io/api/serviceerror" | ||
| updatepb "go.temporal.io/api/update/v1" | ||
| "go.temporal.io/api/workflowservice/v1" | ||
| clockspb "go.temporal.io/server/api/clock/v1" | ||
| "go.temporal.io/server/api/historyservice/v1" | ||
| "go.temporal.io/server/common/definition" | ||
| "go.temporal.io/server/service/history/api" | ||
| "go.temporal.io/server/service/history/api/pollupdate" | ||
| "go.temporal.io/server/service/history/workflow" | ||
| wcache "go.temporal.io/server/service/history/workflow/cache" | ||
| "go.temporal.io/server/service/history/workflow/update" | ||
| ) | ||
|
|
||
| type ( | ||
| mockWFConsistencyChecker struct { | ||
mmcshane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| api.WorkflowConsistencyChecker | ||
| GetWorkflowContextFunc func( | ||
| ctx context.Context, | ||
| reqClock *clockspb.VectorClock, | ||
| consistencyPredicate api.MutableStateConsistencyPredicate, | ||
| workflowKey definition.WorkflowKey, | ||
| lockPriority workflow.LockPriority, | ||
| ) (api.WorkflowContext, error) | ||
| } | ||
|
|
||
| mockAPICtx struct { | ||
| api.WorkflowContext | ||
| GetUpdateRegistryFunc func(context.Context) update.Registry | ||
| GetReleaseFnFunc func() wcache.ReleaseCacheFunc | ||
| } | ||
|
|
||
| mockReg struct { | ||
| update.Registry | ||
| FindFunc func(context.Context, string) (*update.Update, bool) | ||
| } | ||
|
|
||
| mockUpdateEventStore struct { | ||
| update.EventStore | ||
| } | ||
MichaelSnowden marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) | ||
|
|
||
| func (mockUpdateEventStore) OnAfterCommit(f func(context.Context)) { f(context.TODO()) } | ||
| func (mockUpdateEventStore) OnAfterRollback(f func(context.Context)) {} | ||
|
|
||
| func (m mockWFConsistencyChecker) GetWorkflowContext( | ||
| ctx context.Context, | ||
| clock *clockspb.VectorClock, | ||
| pred api.MutableStateConsistencyPredicate, | ||
| wfKey definition.WorkflowKey, | ||
| prio workflow.LockPriority, | ||
| ) (api.WorkflowContext, error) { | ||
| return m.GetWorkflowContextFunc(ctx, clock, pred, wfKey, prio) | ||
| } | ||
|
|
||
| func (m mockAPICtx) GetReleaseFn() wcache.ReleaseCacheFunc { | ||
| return m.GetReleaseFnFunc() | ||
| } | ||
|
|
||
| func (m mockAPICtx) GetUpdateRegistry(ctx context.Context) update.Registry { | ||
| return m.GetUpdateRegistryFunc(ctx) | ||
| } | ||
|
|
||
| func (m mockReg) Find(ctx context.Context, updateID string) (*update.Update, bool) { | ||
| return m.FindFunc(ctx, updateID) | ||
| } | ||
|
|
||
| func TestPollOutcome(t *testing.T) { | ||
| reg := mockReg{} | ||
| apiCtx := mockAPICtx{ | ||
| GetReleaseFnFunc: func() wcache.ReleaseCacheFunc { return func(error) {} }, | ||
| GetUpdateRegistryFunc: func(context.Context) update.Registry { | ||
| return reg | ||
| }, | ||
| } | ||
| wfcc := mockWFConsistencyChecker{ | ||
| GetWorkflowContextFunc: func( | ||
| ctx context.Context, | ||
| reqClock *clockspb.VectorClock, | ||
| consistencyPredicate api.MutableStateConsistencyPredicate, | ||
| workflowKey definition.WorkflowKey, | ||
| lockPriority workflow.LockPriority, | ||
| ) (api.WorkflowContext, error) { | ||
| return apiCtx, nil | ||
| }, | ||
| } | ||
|
|
||
| updateID := t.Name() + "-update-id" | ||
| req := historyservice.PollWorkflowExecutionUpdateRequest{ | ||
| Request: &workflowservice.PollWorkflowExecutionUpdateRequest{ | ||
| UpdateRef: &updatepb.UpdateRef{ | ||
| WorkflowExecution: &commonpb.WorkflowExecution{ | ||
| WorkflowId: t.Name() + "-workflow-id", | ||
| RunId: t.Name() + "-run-id", | ||
| }, | ||
| UpdateId: updateID, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| t.Run("update not found", func(t *testing.T) { | ||
| reg.FindFunc = func(ctx context.Context, updateID string) (*update.Update, bool) { | ||
| return nil, false | ||
| } | ||
| _, err := pollupdate.Invoke(context.TODO(), &req, wfcc) | ||
mmcshane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| var notfound *serviceerror.NotFound | ||
| require.ErrorAs(t, err, ¬found) | ||
MichaelSnowden marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }) | ||
| t.Run("future timeout", func(t *testing.T) { | ||
| reg.FindFunc = func(ctx context.Context, updateID string) (*update.Update, bool) { | ||
| return update.New(updateID, func() {}), true | ||
| } | ||
| ctx, cncl := context.WithTimeout(context.Background(), 5*time.Millisecond) | ||
| defer cncl() | ||
| _, err := pollupdate.Invoke(ctx, &req, wfcc) | ||
| require.Error(t, err) | ||
| }) | ||
| t.Run("get an outcome", func(t *testing.T) { | ||
| upd := update.New(updateID, func() {}) | ||
| reg.FindFunc = func(ctx context.Context, updateID string) (*update.Update, bool) { | ||
| return upd, true | ||
| } | ||
| reqMsg := updatepb.Request{ | ||
| Meta: &updatepb.Meta{UpdateId: updateID}, | ||
| Input: &updatepb.Input{Name: "not_empty"}, | ||
| } | ||
| fail := failurepb.Failure{Message: "intentional failure in " + t.Name()} | ||
| wantOutcome := updatepb.Outcome{Value: &updatepb.Outcome_Failure{Failure: &fail}} | ||
| rejMsg := updatepb.Rejection{ | ||
| RejectedRequestMessageId: updateID + "/request", | ||
| RejectedRequest: &reqMsg, | ||
| Failure: &fail, | ||
| } | ||
|
|
||
| errCh := make(chan error, 1) | ||
| respCh := make(chan *historyservice.PollWorkflowExecutionUpdateResponse, 1) | ||
| go func() { | ||
| resp, err := pollupdate.Invoke(context.TODO(), &req, wfcc) | ||
| errCh <- err | ||
| respCh <- resp | ||
mmcshane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }() | ||
|
|
||
| evStore := mockUpdateEventStore{} | ||
| require.NoError(t, upd.OnMessage(context.TODO(), &reqMsg, evStore)) | ||
| require.NoError(t, upd.OnMessage(context.TODO(), &rejMsg, evStore)) | ||
|
|
||
| require.NoError(t, <-errCh) | ||
| resp := <-respCh | ||
| require.Equal(t, &wantOutcome, resp.GetResponse().Outcome) | ||
| }) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this? To use
defer?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct, for defer.