Files
tasks/common/persistence/client/persistence_rate_limited_clients_test.go
zeekay 5a601d081b rebrand: go.temporal.io/server -> github.com/hanzoai/tasks
Full module path rebrand from Temporal to Hanzo Tasks:
- go.mod module: github.com/hanzoai/tasks
- All internal Go imports updated (1906 files)
- cmd/server renamed to cmd/tasksd
- Binary name: tasksd (was temporal-server)
- Docker images: hanzoai/tasks (was temporalio/server)
- README rewritten with Hanzo Tasks branding
- LLM.md created with integration notes
- Makefile, goreleaser, CI workflows updated
- go.temporal.io/sdk and go.temporal.io/api imports preserved (separate repos)

Fork of Temporal.io (MIT license).
2026-03-19 10:36:40 -07:00

258 lines
8.4 KiB
Go

package client_test
import (
"context"
"errors"
"fmt"
"testing"
"time"
"github.com/stretchr/testify/assert"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
"github.com/hanzoai/tasks/chasm"
"github.com/hanzoai/tasks/common/config"
"github.com/hanzoai/tasks/common/log"
"github.com/hanzoai/tasks/common/metrics"
"github.com/hanzoai/tasks/common/persistence"
"github.com/hanzoai/tasks/common/persistence/client"
"github.com/hanzoai/tasks/common/persistence/mock"
"github.com/hanzoai/tasks/common/persistence/serialization"
"github.com/hanzoai/tasks/common/quotas"
"go.uber.org/mock/gomock"
)
func TestRateLimitedPersistenceClients(t *testing.T) {
t.Parallel()
for _, tc := range []struct {
name string
err error
numRequests int
namespaceRPS int
systemRPS int
namespaceShardRPS int
expectRateLimit bool
expectedScope enumspb.ResourceExhaustedScope
expectedMessage string
}{
{
name: "Namespace limit allow",
err: nil,
numRequests: 10,
namespaceRPS: 10,
namespaceShardRPS: 100,
systemRPS: 100,
expectRateLimit: false,
},
{
name: "Namespace limit hit",
err: nil,
numRequests: 11,
namespaceRPS: 10,
namespaceShardRPS: 100,
systemRPS: 100,
expectRateLimit: true,
expectedScope: enumspb.RESOURCE_EXHAUSTED_SCOPE_NAMESPACE,
expectedMessage: "Namespace Persistence Max QPS Reached.",
},
{
name: "System limit allow",
err: nil,
numRequests: 10,
namespaceRPS: 100,
namespaceShardRPS: 100,
systemRPS: 10,
expectRateLimit: false,
},
{
name: "System limit hit",
err: nil,
numRequests: 11,
namespaceRPS: 100,
namespaceShardRPS: 100,
systemRPS: 10,
expectRateLimit: true,
expectedScope: enumspb.RESOURCE_EXHAUSTED_SCOPE_SYSTEM,
expectedMessage: "System Persistence Max QPS Reached.",
},
{
name: "Shard limit allow",
err: nil,
numRequests: 10,
namespaceRPS: 100,
namespaceShardRPS: 10,
systemRPS: 100,
expectRateLimit: false,
},
{
name: "Shard limit hit",
err: nil,
numRequests: 11,
namespaceRPS: 100,
namespaceShardRPS: 10,
systemRPS: 100,
expectRateLimit: true,
expectedScope: enumspb.RESOURCE_EXHAUSTED_SCOPE_NAMESPACE,
expectedMessage: "Namespace Per-Shard Persistence Max QPS Reached.",
},
} {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
ctr := gomock.NewController(t)
dataStoreFactory := mock.NewMockDataStoreFactory(ctr)
shardStore := mock.NewMockShardStore(ctr)
shardStore.EXPECT().AssertShardOwnership(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
dataStoreFactory.EXPECT().NewShardStore().AnyTimes().Return(shardStore, nil)
queue := mock.NewMockQueue(ctr)
queue.EXPECT().Init(gomock.Any(), gomock.Any()).Return(nil)
queue.EXPECT().DeleteMessageFromDLQ(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
dataStoreFactory.EXPECT().NewQueue(gomock.Any()).AnyTimes().Return(queue, nil)
executionStore := mock.NewMockExecutionStore(ctr)
executionStore.EXPECT().DeleteWorkflowExecution(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
dataStoreFactory.EXPECT().NewExecutionStore().AnyTimes().Return(executionStore, nil)
metadataStore := mock.NewMockMetadataStore(ctr)
metadataStore.EXPECT().DeleteNamespace(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
metadataStore.EXPECT().GetNamespace(gomock.Any(), gomock.Any()).AnyTimes().Return(nil, nil)
dataStoreFactory.EXPECT().NewMetadataStore().AnyTimes().Return(metadataStore, nil)
clusterMetadataStore := mock.NewMockClusterMetadataStore(ctr)
clusterMetadataStore.EXPECT().DeleteClusterMetadata(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
clusterMetadataStore.EXPECT().GetClusterMetadata(gomock.Any(), gomock.Any()).AnyTimes().Return(nil, nil)
dataStoreFactory.EXPECT().NewClusterMetadataStore().AnyTimes().Return(clusterMetadataStore, nil)
nexusStore := mock.NewMockNexusEndpointStore(ctr)
nexusStore.EXPECT().DeleteNexusEndpoint(gomock.Any(), gomock.Any()).AnyTimes().Return(nil)
nexusStore.EXPECT().ListNexusEndpoints(gomock.Any(), gomock.Any()).AnyTimes().Return(nil, nil)
dataStoreFactory.EXPECT().NewNexusEndpointStore().AnyTimes().Return(nexusStore, nil)
taskStore := mock.NewMockTaskStore(ctr)
taskStore.EXPECT().GetTasks(gomock.Any(), gomock.Any()).AnyTimes().Return(nil, nil)
dataStoreFactory.EXPECT().NewTaskStore().AnyTimes().Return(taskStore, nil)
burstRatioFn := func() float64 {
return 1.0
}
systemRequestRateLimiter := quotas.NewRequestRateLimiterAdapter(
quotas.NewDefaultRateLimiter(
func() float64 { return float64(tc.systemRPS) },
burstRatioFn,
),
)
namespaceRequestRateLimiter := quotas.NewRequestRateLimiterAdapter(
quotas.NewDefaultRateLimiter(
func() float64 { return float64(tc.namespaceRPS) },
burstRatioFn,
),
)
shardRequestRateLimiter := quotas.NewRequestRateLimiterAdapter(
quotas.NewDefaultRateLimiter(
func() float64 { return float64(tc.namespaceShardRPS) },
burstRatioFn,
),
)
serializer := serialization.NewSerializer()
factory := client.NewFactory(
dataStoreFactory,
&config.Persistence{
NumHistoryShards: 1,
},
systemRequestRateLimiter,
namespaceRequestRateLimiter,
shardRequestRateLimiter,
serializer,
nil,
"",
metrics.NoopMetricsHandler,
log.NewTestLogger(),
nil,
func() bool { return false },
func() bool { return false },
)
shardManager, _ := factory.NewShardManager()
executionManager, _ := factory.NewExecutionManager()
metadataManager, _ := factory.NewMetadataManager()
clusterMetadataManager, _ := factory.NewClusterMetadataManager()
nexusManager, _ := factory.NewNexusEndpointManager()
namespaceQueue, _ := factory.NewNamespaceReplicationQueue()
// Make calls to different manager objects to verify that RPS is enforced.
persistenceCalls := []struct {
name string
call func() error
}{
{
name: "AssertShardOwnership",
call: func() error {
return shardManager.AssertShardOwnership(context.Background(), &persistence.AssertShardOwnershipRequest{ShardID: 0})
},
},
{
name: "DeleteWorkflowExecution",
call: func() error {
return executionManager.DeleteWorkflowExecution(context.Background(), &persistence.DeleteWorkflowExecutionRequest{
ArchetypeID: chasm.WorkflowArchetypeID,
})
},
},
{
name: "DeleteNamespace",
call: func() error {
return metadataManager.DeleteNamespace(context.Background(), &persistence.DeleteNamespaceRequest{})
},
},
{
name: "DeleteClusterMetadata",
call: func() error {
return clusterMetadataManager.DeleteClusterMetadata(context.Background(), &persistence.DeleteClusterMetadataRequest{ClusterName: "test"})
},
},
{
name: "DeleteNexusEndpoint",
call: func() error {
return nexusManager.DeleteNexusEndpoint(context.Background(), &persistence.DeleteNexusEndpointRequest{})
},
},
{
name: "DeleteMessageFromDLQ",
call: func() error {
return namespaceQueue.DeleteMessageFromDLQ(context.Background(), 0)
},
},
}
var err error
for _, persistenceCall := range persistenceCalls {
t.Run(fmt.Sprintf("%s %s", tc.name, persistenceCall.name), func(t *testing.T) {
// Generate load by sending a number of requests.
for i := 0; i < tc.numRequests; i++ {
err = persistenceCall.call()
if err != nil {
// Assert resource exhausted at last request.
assert.Equal(t, tc.numRequests-1, i)
break
}
}
// Check if the rate limit is hit.
if tc.expectRateLimit {
var resourceExhausted *serviceerror.ResourceExhausted
errors.As(err, &resourceExhausted)
assert.Equal(t, enumspb.RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_LIMIT, resourceExhausted.Cause)
assert.Equal(t, tc.expectedScope, resourceExhausted.Scope)
assert.Equal(t, tc.expectedMessage, resourceExhausted.Message)
} else {
assert.NoError(t, err)
}
// Sleep for 1 second for the rate limits to reset.
time.Sleep(1 * time.Second)
})
}
})
}
}