Files
tasks/service/history/history_engine_factory.go
Michael SnowdenandGitHub 3e14baba63 Add a replication.DLQWriter interface (#5009)
<!-- Describe what has changed in this PR -->
**What changed?**
I added a `DLQWriter` interface to the `replication` package, which
takes a `WriteRequest` containing a `shard.Context`, a source cluster
name, and replication task info, and writes a task to the DLQ. I also
added a default implementation which uses our v1 queue supplied by the
shard.

I also refactored `replication/fx.go` in two ways:
1. **Don't use `fx.Options`**: Its usage is discouraged in its
documentation, and we can replace it by simply having a variadic call to
`fx.Provide`, and adding lifecycle hooks for the scheduler in the
provider instead of an `fx.Invoke` call.
2. **Keep providers un-exported**: I didn't see a reason for having
these exported, and I think it just bloats the footprint of this
package. It's clearer when you see that it just provides a few
constructors and a module.

<!-- Tell your future self why have you made these changes -->
**Why?**
We want to move away from using
`ExecutionManager.PutReplicationTaskToDLQ`; however, that method is
called in several places in the `replication` package. We're going to
fix this in stages:

1. Hide all calls to `ExecutionManager` behind a common interface, so
that it's really only called in one place
3. Add an alternate implementation based on `persistence.QueueV2` via
`queues.DLQWriter`
4. Roll out the alternate implementation
5. Remove the implementation that uses the `ExecutionManager`

This PR is just step one.

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
I added a unit test, and I also added an integration test for this in
https://github.com/temporalio/temporal/pull/5003.

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**


<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
2023-10-20 13:41:57 -07:00

106 lines
3.7 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 history
import (
"go.opentelemetry.io/otel/trace"
"go.uber.org/fx"
"go.temporal.io/server/client"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/serialization"
"go.temporal.io/server/common/persistence/visibility/manager"
"go.temporal.io/server/common/resource"
"go.temporal.io/server/common/sdk"
"go.temporal.io/server/service/history/api"
"go.temporal.io/server/service/history/configs"
"go.temporal.io/server/service/history/events"
"go.temporal.io/server/service/history/replication"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tasks"
wcache "go.temporal.io/server/service/history/workflow/cache"
)
type (
HistoryEngineFactoryParams struct {
fx.In
ClientBean client.Bean
MatchingClient resource.MatchingClient
SdkClientFactory sdk.ClientFactory
EventNotifier events.Notifier
Config *configs.Config
RawMatchingClient resource.MatchingRawClient
WorkflowCache wcache.Cache
NewCacheFn wcache.NewCacheFn
EventSerializer serialization.Serializer
QueueFactories []QueueFactory `group:"queueFactory"`
ReplicationTaskFetcherFactory replication.TaskFetcherFactory
ReplicationTaskExecutorProvider replication.TaskExecutorProvider
TracerProvider trace.TracerProvider
PersistenceVisibilityMgr manager.VisibilityManager
EventBlobCache persistence.XDCCache
TaskCategoryRegistry tasks.TaskCategoryRegistry
ReplicationDLQWriter replication.DLQWriter
}
historyEngineFactory struct {
HistoryEngineFactoryParams
}
)
func (f *historyEngineFactory) CreateEngine(
shard shard.Context,
) shard.Engine {
var wfCache wcache.Cache
if shard.GetConfig().EnableHostLevelHistoryCache() {
wfCache = f.WorkflowCache
} else {
wfCache = f.NewCacheFn(shard.GetConfig())
}
workflowConsistencyChecker := api.NewWorkflowConsistencyChecker(shard, wfCache)
return NewEngineWithShardContext(
shard,
f.ClientBean,
f.MatchingClient,
f.SdkClientFactory,
f.EventNotifier,
f.Config,
f.RawMatchingClient,
wfCache,
f.EventSerializer,
f.QueueFactories,
f.ReplicationTaskFetcherFactory,
f.ReplicationTaskExecutorProvider,
workflowConsistencyChecker,
f.TracerProvider,
f.PersistenceVisibilityMgr,
f.EventBlobCache,
f.TaskCategoryRegistry,
f.ReplicationDLQWriter,
)
}