Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a pluggable ExecutableWrapper to our queue factories
- Loading branch information
1 parent
00ffdbf
commit 5e9ba7d
Showing
15 changed files
with
365 additions
and
262 deletions.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // 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 queues | ||
|
|
||
| import ( | ||
| "go.temporal.io/server/common/clock" | ||
| "go.temporal.io/server/common/cluster" | ||
| "go.temporal.io/server/common/log" | ||
| "go.temporal.io/server/common/metrics" | ||
| "go.temporal.io/server/common/namespace" | ||
| "go.temporal.io/server/service/history/tasks" | ||
| ) | ||
|
|
||
| type ( | ||
| // ExecutableFactory and the related interfaces here are needed to make it possible to extend the functionality of | ||
| // task processing without changing its core logic. This is similar to ExecutorWrapper. | ||
| ExecutableFactory interface { | ||
| NewExecutable(task tasks.Task, readerID int64) Executable | ||
| } | ||
| // ExecutableFactoryFn is a convenience type to avoid having to create a struct that implements ExecutableFactory. | ||
| ExecutableFactoryFn func(readerID int64, t tasks.Task) Executable | ||
| ExecutableWrapper interface { | ||
| Wrap(e Executable) Executable | ||
| } | ||
|
|
||
| executableFactoryImpl struct { | ||
| executor Executor | ||
| scheduler Scheduler | ||
| rescheduler Rescheduler | ||
| priorityAssigner PriorityAssigner | ||
| timeSource clock.TimeSource | ||
| namespaceRegistry namespace.Registry | ||
| clusterMetadata cluster.Metadata | ||
| logger log.Logger | ||
| metricsHandler metrics.Handler | ||
| } | ||
| executableFactoryWrapper struct { | ||
| factory ExecutableFactory | ||
| wrapper ExecutableWrapper | ||
| } | ||
| ) | ||
|
|
||
| func (f ExecutableFactoryFn) NewExecutable(task tasks.Task, readerID int64) Executable { | ||
| return f(readerID, task) | ||
| } | ||
|
|
||
| func NewExecutableFactory( | ||
| executor Executor, | ||
| scheduler Scheduler, | ||
| rescheduler Rescheduler, | ||
| priorityAssigner PriorityAssigner, | ||
| timeSource clock.TimeSource, | ||
| namespaceRegistry namespace.Registry, | ||
| clusterMetadata cluster.Metadata, | ||
| logger log.Logger, | ||
| metricsHandler metrics.Handler, | ||
| ) *executableFactoryImpl { | ||
| return &executableFactoryImpl{ | ||
| executor: executor, | ||
| scheduler: scheduler, | ||
| rescheduler: rescheduler, | ||
| priorityAssigner: priorityAssigner, | ||
| timeSource: timeSource, | ||
| namespaceRegistry: namespaceRegistry, | ||
| clusterMetadata: clusterMetadata, | ||
| logger: logger, | ||
| metricsHandler: metricsHandler, | ||
| } | ||
| } | ||
|
|
||
| // NewExecutableFactoryWrapper returns a new ExecutableFactory that wraps the executable created by the factory with the | ||
| // given wrapper. | ||
| func NewExecutableFactoryWrapper(factory ExecutableFactory, wrapper ExecutableWrapper) executableFactoryWrapper { | ||
| return executableFactoryWrapper{factory: factory, wrapper: wrapper} | ||
| } | ||
|
|
||
| func (f *executableFactoryImpl) NewExecutable(task tasks.Task, readerID int64) Executable { | ||
| return NewExecutable( | ||
| readerID, | ||
| task, | ||
| f.executor, | ||
| f.scheduler, | ||
| f.rescheduler, | ||
| f.priorityAssigner, | ||
| f.timeSource, | ||
| f.namespaceRegistry, | ||
| f.clusterMetadata, | ||
| f.logger, | ||
| f.metricsHandler, | ||
| ) | ||
| } | ||
|
|
||
| func (f executableFactoryWrapper) NewExecutable(task tasks.Task, readerID int64) Executable { | ||
| return f.wrapper.Wrap(f.factory.NewExecutable(task, readerID)) | ||
| } |
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,67 @@ | ||
| // 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 queues_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "go.temporal.io/server/common/clock" | ||
| "go.temporal.io/server/common/log" | ||
| "go.temporal.io/server/service/history/queues" | ||
| "go.temporal.io/server/service/history/tasks" | ||
| ) | ||
|
|
||
| type ( | ||
| testWrapper struct{} | ||
| wrappedExecutable struct { | ||
| queues.Executable | ||
| } | ||
| ) | ||
|
|
||
| func TestNewExecutableFactoryWrapper(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| wrapper := testWrapper{} | ||
| factory := queues.NewExecutableFactory( | ||
| nil, | ||
| nil, | ||
| nil, | ||
| queues.NewNoopPriorityAssigner(), | ||
| clock.NewEventTimeSource(), | ||
| nil, | ||
| nil, | ||
| log.NewNoopLogger(), | ||
| nil, | ||
| ) | ||
| wrappedFactory := queues.NewExecutableFactoryWrapper(factory, wrapper) | ||
| executable := wrappedFactory.NewExecutable(&tasks.WorkflowTask{}, 0) | ||
| _, ok := executable.(wrappedExecutable) | ||
| assert.True(t, ok, "expected executable to be wrapped") | ||
| } | ||
|
|
||
| func (t testWrapper) Wrap(e queues.Executable) queues.Executable { | ||
| return wrappedExecutable{e} | ||
| } |
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.