Files
tasks/service/history/queues/queuestest/fake_queue_writer.go
Prathyush PVandGitHub 35594955a6 Adding documentation for dealing with DLQ messages (#5139)
<!-- Describe what has changed in this PR -->
**What changed?**
Adding documentation on how to deal with messages that are added to
DLQs.

<!-- Tell your future self why have you made these changes -->
**Why?**
This will help operators to find messages in DLQ, the reason why it got
enqueued into DLQ etc.
It also has useful tdbg commands for deleting or re-enqueuing the
messages from DLQ

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**


<!-- 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-11-23 02:22:43 +00:00

57 lines
2.1 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 queuestest
import (
"context"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/service/history/queues"
)
// FakeQueueWriter is a [queues.QueueWriter] which records the requests it receives and returns the provided errors.
type FakeQueueWriter struct {
EnqueueTaskRequests []*persistence.EnqueueTaskRequest
EnqueueTaskErr error
CreateQueueErr error
}
var _ queues.QueueWriter = (*FakeQueueWriter)(nil)
func (d *FakeQueueWriter) EnqueueTask(
_ context.Context,
request *persistence.EnqueueTaskRequest,
) (*persistence.EnqueueTaskResponse, error) {
d.EnqueueTaskRequests = append(d.EnqueueTaskRequests, request)
return &persistence.EnqueueTaskResponse{Metadata: persistence.MessageMetadata{ID: 0}}, d.EnqueueTaskErr
}
func (d *FakeQueueWriter) CreateQueue(
context.Context,
*persistence.CreateQueueRequest,
) (*persistence.CreateQueueResponse, error) {
return nil, d.CreateQueueErr
}