Files
Michael SnowdenandGitHub d167c90162 Implement AdminService.PurgeDLQTasks (#4972)
<!-- Describe what has changed in this PR -->
**What changed?**
This PR adds the `PurgeDLQTasks` RPC to the history service. This RPC
allows users to delete tasks from the new history task DLQ.

<!-- Tell your future self why have you made these changes -->
**Why?**
We want this so that users can delete DLQ'd tasks once they've dealt
with them (e.g. re-enqueued them, decided they're poison pills, etc.).

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
There's a large suite of tests that covers the following:
1. All error branches (100% test coverage)
2. When arguments are invalid, we return a non-retryable error
3. When the service returns an "Unavailable" error, the workflow returns
a retryable error
4. We validate the request parameters
5. Integration tests against the actual admin and history service

<!-- 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-18 02:06:16 +00:00

94 lines
3.2 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 addsearchattributes
import (
"context"
sdkworker "go.temporal.io/sdk/worker"
"go.temporal.io/sdk/workflow"
"go.uber.org/fx"
"go.temporal.io/server/common/headers"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
esclient "go.temporal.io/server/common/persistence/visibility/store/elasticsearch/client"
"go.temporal.io/server/common/primitives"
"go.temporal.io/server/common/searchattribute"
workercommon "go.temporal.io/server/service/worker/common"
)
type (
// addSearchAttributes represent background work needed for adding search attributes
addSearchAttributes struct {
initParams
}
initParams struct {
fx.In
EsClient esclient.Client
Manager searchattribute.Manager
MetricsHandler metrics.Handler
Logger log.Logger
}
)
var Module = workercommon.AnnotateWorkerComponentProvider(newComponent)
func newComponent(params initParams) workercommon.WorkerComponent {
return &addSearchAttributes{initParams: params}
}
func (wc *addSearchAttributes) RegisterWorkflow(registry sdkworker.Registry) {
registry.RegisterWorkflowWithOptions(AddSearchAttributesWorkflow, workflow.RegisterOptions{Name: WorkflowName})
}
func (wc *addSearchAttributes) DedicatedWorkflowWorkerOptions() *workercommon.DedicatedWorkerOptions {
// use default worker
return nil
}
func (wc *addSearchAttributes) RegisterActivities(registry sdkworker.Registry) {
registry.RegisterActivity(wc.activities())
}
func (wc *addSearchAttributes) DedicatedActivityWorkerOptions() *workercommon.DedicatedWorkerOptions {
return &workercommon.DedicatedWorkerOptions{
TaskQueue: primitives.AddSearchAttributesActivityTQ,
Options: sdkworker.Options{
BackgroundActivityContext: headers.SetCallerType(context.Background(), headers.CallerTypeAPI),
},
}
}
func (wc *addSearchAttributes) activities() *activities {
return &activities{
esClient: wc.EsClient,
saManager: wc.Manager,
metricsHandler: wc.MetricsHandler.WithTags(metrics.OperationTag(metrics.AddSearchAttributesWorkflowScope)),
logger: wc.Logger,
}
}