mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Tim Deeb-SwihartandGitHub
95169a53c3
**What changed?** gogo/protobuf has been replaced with Google's official go compiler. **Why?** gogo/protobuf has been deprecated for some time and the community is moving on, building new tools (like vtproto) atop google's v2 compiler. **How did you test it?** `make test` **Potential risks** 1. The change from embedded gogo-generated-structs to google-generated-pointers-to-structs created a risk of nil pointer exceptions. I've fixed all the ones our tests found but it's possible there are more lurking in the new code. 2. This change may cause our performance to decrease. Certainly encoding/deconding of proto objects will become slower, but the overuse of pointers by the google compiler may negatively affect our overall performance. We'll need to keep an eye on the GC stats 3. This breaks the HTTP API. We will not support [shortand payload encoding](https://github.com/temporalio/proposals/blob/master/api/http-api.md#payload-formatting) in this first pass; that will come once this initial work is in testing. **Breaking changes for developers** - `*time.Time` in proto structs will now be [timestamppb.Timestamp](https://pkg.go.dev/google.golang.org/[email protected]/types/known/timestamppb#section-documentation) - `*time.Duration` will now be [durationpb.Duration](https://pkg.go.dev/google.golang.org/protobuf/types/known/durationpb) - V2-generated structs embed locks, so you cannot dereference them. `go vet` will scream at you about this. If you need a copy, use `proto.Clone`. - If the performance of this sucks then I will either update our code generator to add shallow-clone methods or hand-roll the ones we need - Proto enums will, when formatted to JSON, now be in `SCREAMING_SNAKE_CASE` rather than `PascalCase`. We decided (in discussion with the SDK team) that now was as good a time as any to rip the bandage off. - Proto objects, or objects embedding protos, cannot be compared using `reflect.DeepEqual` or _anything_ that uses it. This includes `testify` and `mock` equality testers! - You will need to use the `common/testing/protorequire`, `common/testing/protoassert`, or `common/testing/protomock` packages instead. I've implemented proto-compatible matchers and assertions there for all cases I've encountered - If you need `reflect.DeepEqual` for any reason you can use `go.temporal.io/api/temporalproto.DeepEqual` instead Note that history loading will not be impacted by the JSON changes: I rewrote history loading to dynamically fix incoming history JSON data (like all our other sdks); you can find this code in [my fork of our go API](https://github.com/tdeebswihart/temporal-api-go/blob/master/internal/temporalhistoryv1/load.go) alongside its tests. **🚨Sharp Edges Introduced🚨** Beware `*timestamppb.Timestamp.AsTime()`. If you need to extract a time value from a proto time (timestamppb) **always** make sure to check whether it's nil first. When the proto object is `nil` `AsTime()` will return a non-zero time at the proto epoch: UTC midnight on January 1, 1970. I've made this mistake multiple times during this transition and each time it's been a pain to debug **Is hotfix candidate?** No.
741 lines
24 KiB
Go
741 lines
24 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 archiver
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/golang/mock/gomock"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
enumspb "go.temporal.io/api/enums/v1"
|
|
historypb "go.temporal.io/api/history/v1"
|
|
"go.temporal.io/api/serviceerror"
|
|
taskqueuepb "go.temporal.io/api/taskqueue/v1"
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
|
|
archiverspb "go.temporal.io/server/api/archiver/v1"
|
|
"go.temporal.io/server/common"
|
|
"go.temporal.io/server/common/persistence"
|
|
)
|
|
|
|
const (
|
|
testNamespaceID = "test-namespace-id"
|
|
testNamespace = "test-namespace"
|
|
testWorkflowID = "test-workflow-id"
|
|
testRunID = "test-run-id"
|
|
testShardID = int32(1)
|
|
testNextEventID = 1800
|
|
testCloseFailoverVersion = 100
|
|
testDefaultPersistencePageSize = 250
|
|
testDefaultTargetHistoryBlobSize = 2 * 1024 * 124
|
|
testDefaultHistoryEventSize = 50
|
|
)
|
|
|
|
var (
|
|
testBranchToken = []byte{1, 2, 3}
|
|
)
|
|
|
|
type (
|
|
HistoryIteratorSuite struct {
|
|
*require.Assertions
|
|
suite.Suite
|
|
|
|
controller *gomock.Controller
|
|
mockExecutionMgr *persistence.MockExecutionManager
|
|
}
|
|
|
|
page struct {
|
|
firstbatchIdx int
|
|
numBatches int
|
|
firstEventFailoverVersion int64
|
|
lastEventFailoverVersion int64
|
|
}
|
|
|
|
testSizeEstimator struct{}
|
|
)
|
|
|
|
func (e *testSizeEstimator) EstimateSize(v interface{}) (int, error) {
|
|
historyBatch, ok := v.(*historypb.History)
|
|
if !ok {
|
|
return -1, errors.New("test size estimator only estimate the size of history batches")
|
|
}
|
|
return testDefaultHistoryEventSize * len(historyBatch.Events), nil
|
|
}
|
|
|
|
func newTestSizeEstimator() SizeEstimator {
|
|
return &testSizeEstimator{}
|
|
}
|
|
|
|
func TestHistoryIteratorSuite(t *testing.T) {
|
|
suite.Run(t, new(HistoryIteratorSuite))
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) SetupTest() {
|
|
s.Assertions = require.New(s.T())
|
|
s.controller = gomock.NewController(s.T())
|
|
s.mockExecutionMgr = persistence.NewMockExecutionManager(s.controller)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TearDownTest() {
|
|
s.controller.Finish()
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistory_Failed_EventsV2() {
|
|
s.mockExecutionMgr.EXPECT().ReadHistoryBranchByBatch(gomock.Any(), gomock.Any()).Return(nil, errors.New("got error reading history branch"))
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, testDefaultTargetHistoryBlobSize, nil)
|
|
history, err := itr.readHistory(context.Background(), common.FirstEventID)
|
|
s.Error(err)
|
|
s.Nil(history)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistory_Success_EventsV2() {
|
|
resp := persistence.ReadHistoryBranchByBatchResponse{
|
|
History: []*historypb.History{},
|
|
NextPageToken: []byte{},
|
|
}
|
|
s.mockExecutionMgr.EXPECT().ReadHistoryBranchByBatch(gomock.Any(), gomock.Any()).Return(&resp, nil)
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, testDefaultTargetHistoryBlobSize, nil)
|
|
history, err := itr.readHistory(context.Background(), common.FirstEventID)
|
|
s.NoError(err)
|
|
s.Len(history, 0)
|
|
}
|
|
|
|
// In the following test:
|
|
// batchInfo represents # of events for each history batch.
|
|
// page represents the metadata of the set of history batches that should be requested by the iterator
|
|
// and returned by the history manager. Each page specifies the index of the first history batch it should
|
|
// return, # of batches to return and first/last event failover version for the set of batches returned.
|
|
// Note that is possible that a history batch is contained in multiple pages.
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Fail_FirstCallToReadHistoryGivesError() {
|
|
batchInfo := []int{1}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, 0, false, pages...)
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, testDefaultTargetHistoryBlobSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
events, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.Error(err)
|
|
s.Nil(events)
|
|
s.False(nextIterState.FinishedIteration)
|
|
s.Zero(nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Fail_NonFirstCallToReadHistoryGivesError() {
|
|
batchInfo := []int{1, 1}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 1,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, 1, false, pages...)
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, testDefaultTargetHistoryBlobSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
events, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.Error(err)
|
|
s.Nil(events)
|
|
s.False(nextIterState.FinishedIteration)
|
|
s.Zero(nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Success_ReadToHistoryEnd() {
|
|
batchInfo := []int{1, 2, 1, 1, 1, 3, 3, 1, 3}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 5,
|
|
numBatches: 4,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
// ensure target history batches size is greater than total history length to ensure all of history is read
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 20*testDefaultHistoryEventSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
history, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.NoError(err)
|
|
s.NotNil(history)
|
|
s.Len(history, 9)
|
|
s.True(nextIterState.FinishedIteration)
|
|
s.Zero(nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Success_TargetSizeSatisfiedWithoutReadingToEnd() {
|
|
batchInfo := []int{1, 2, 1, 1, 1, 3, 3, 1, 3}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 5,
|
|
numBatches: 4,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, false, pages...)
|
|
// ensure target history batches is smaller than full length of history so that not all of history is read
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 11*testDefaultHistoryEventSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
history, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.NoError(err)
|
|
s.NotNil(history)
|
|
s.Len(history, 7)
|
|
s.False(nextIterState.FinishedIteration)
|
|
s.Equal(int64(13), nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Success_ReadExactlyToHistoryEnd() {
|
|
batchInfo := []int{1, 2, 1, 1, 1, 3, 3, 1, 3}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 5,
|
|
numBatches: 4,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
// ensure target history batches size is equal to the full length of history so that all of history is read
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 16*testDefaultHistoryEventSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
history, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.NoError(err)
|
|
s.NotNil(history)
|
|
s.Len(history, 9)
|
|
s.True(nextIterState.FinishedIteration)
|
|
s.Zero(nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestReadHistoryBatches_Success_ReadPageMultipleTimes() {
|
|
batchInfo := []int{1, 3, 2}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 2,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
// ensure target history batches is very small so that one page needs multiple read
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 2*testDefaultHistoryEventSize, nil)
|
|
startingIteratorState := s.copyIteratorState(itr)
|
|
history, nextIterState, err := itr.readHistoryBatches(context.Background(), common.FirstEventID)
|
|
s.NoError(err)
|
|
s.NotNil(history)
|
|
s.Len(history, 2)
|
|
s.False(nextIterState.FinishedIteration)
|
|
s.Equal(int64(5), nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
|
|
history, nextIterState, err = itr.readHistoryBatches(context.Background(), nextIterState.NextEventID)
|
|
s.NoError(err)
|
|
s.NotNil(history)
|
|
s.Len(history, 1)
|
|
s.True(nextIterState.FinishedIteration)
|
|
s.Zero(nextIterState.NextEventID)
|
|
s.assertStateMatches(startingIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestNext_Fail_IteratorDepleted() {
|
|
batchInfo := []int{1, 3, 2, 1, 2, 3, 4}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 2,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 2,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 4,
|
|
firstEventFailoverVersion: 2,
|
|
lastEventFailoverVersion: 5,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
// set target history batches such that a single call to next will read all of history
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 16*testDefaultHistoryEventSize, nil)
|
|
blob, err := itr.Next(context.Background())
|
|
s.Nil(err)
|
|
|
|
expectedIteratorState := historyIteratorState{
|
|
// when iteration is finished page token is not advanced
|
|
FinishedIteration: true,
|
|
NextEventID: 0,
|
|
}
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
s.NotNil(blob)
|
|
expectedHeader := &archiverspb.HistoryBlobHeader{
|
|
Namespace: testNamespace,
|
|
NamespaceId: testNamespaceID,
|
|
WorkflowId: testWorkflowID,
|
|
RunId: testRunID,
|
|
IsLast: true,
|
|
FirstFailoverVersion: 1,
|
|
LastFailoverVersion: 5,
|
|
FirstEventId: common.FirstEventID,
|
|
LastEventId: 16,
|
|
EventCount: 16,
|
|
}
|
|
s.Equal(expectedHeader, blob.Header)
|
|
s.Len(blob.Body, 7)
|
|
s.NoError(err)
|
|
s.False(itr.HasNext())
|
|
|
|
blob, err = itr.Next(context.Background())
|
|
s.Equal(err, errIteratorDepleted)
|
|
s.Nil(blob)
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestNext_Fail_ReturnErrOnSecondCallToNext() {
|
|
batchInfo := []int{1, 3, 2, 1, 3, 2}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 2,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 5,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, 3, false, pages...)
|
|
// set target blob size such that the first two pages are read for blob one without error, third page will return error
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 6*testDefaultHistoryEventSize, nil)
|
|
blob, err := itr.Next(context.Background())
|
|
s.NoError(err)
|
|
expectedIteratorState := historyIteratorState{
|
|
FinishedIteration: false,
|
|
NextEventID: 7,
|
|
}
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
s.NotNil(blob)
|
|
expectedHeader := &archiverspb.HistoryBlobHeader{
|
|
Namespace: testNamespace,
|
|
NamespaceId: testNamespaceID,
|
|
WorkflowId: testWorkflowID,
|
|
RunId: testRunID,
|
|
IsLast: false,
|
|
FirstFailoverVersion: 1,
|
|
LastFailoverVersion: 1,
|
|
FirstEventId: common.FirstEventID,
|
|
LastEventId: 6,
|
|
EventCount: 6,
|
|
}
|
|
s.Equal(expectedHeader, blob.Header)
|
|
s.NoError(err)
|
|
s.True(itr.HasNext())
|
|
|
|
blob, err = itr.Next(context.Background())
|
|
s.Error(err)
|
|
s.Nil(blob)
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestNext_Success_TenCallsToNext() {
|
|
var batchInfo []int
|
|
for i := 0; i < 100; i++ {
|
|
batchInfo = append(batchInfo, []int{1, 2, 3, 4, 4, 3, 2, 1}...)
|
|
}
|
|
var pages []page
|
|
for i := 0; i < 100; i++ {
|
|
p := page{
|
|
firstbatchIdx: i * 8,
|
|
numBatches: 8,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
}
|
|
pages = append(pages, p)
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
// set target blob size size such that every 10 persistence pages is one group of history batches
|
|
itr := s.constructTestHistoryIterator(s.mockExecutionMgr, 20*10*testDefaultHistoryEventSize, nil)
|
|
expectedIteratorState := historyIteratorState{
|
|
FinishedIteration: false,
|
|
NextEventID: common.FirstEventID,
|
|
}
|
|
for i := 0; i < 10; i++ {
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
s.True(itr.HasNext())
|
|
blob, err := itr.Next(context.Background())
|
|
s.NoError(err)
|
|
s.NotNil(blob)
|
|
expectedHeader := &archiverspb.HistoryBlobHeader{
|
|
Namespace: testNamespace,
|
|
NamespaceId: testNamespaceID,
|
|
WorkflowId: testWorkflowID,
|
|
RunId: testRunID,
|
|
IsLast: false,
|
|
FirstFailoverVersion: 1,
|
|
LastFailoverVersion: 1,
|
|
FirstEventId: common.FirstEventID + int64(i*200),
|
|
LastEventId: int64(200 + (i * 200)),
|
|
EventCount: 200,
|
|
}
|
|
if i == 9 {
|
|
expectedHeader.IsLast = true
|
|
}
|
|
s.Equal(expectedHeader, blob.Header)
|
|
|
|
if i < 9 {
|
|
expectedIteratorState.FinishedIteration = false
|
|
expectedIteratorState.NextEventID = int64(200*(i+1) + 1)
|
|
} else {
|
|
expectedIteratorState.NextEventID = 0
|
|
expectedIteratorState.FinishedIteration = true
|
|
}
|
|
}
|
|
s.assertStateMatches(expectedIteratorState, itr)
|
|
s.False(itr.HasNext())
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestNext_Success_SameHistoryDifferentPage() {
|
|
batchInfo := []int{2, 4, 4, 3, 2, 1, 1, 2}
|
|
pages := []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 2,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 2,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 4,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 5,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
eventsPerRead := 6
|
|
targetBlobSize := eventsPerRead * testDefaultHistoryEventSize
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
itr1 := s.constructTestHistoryIterator(s.mockExecutionMgr, targetBlobSize, nil)
|
|
|
|
pages = []page{
|
|
{
|
|
firstbatchIdx: 0,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 1,
|
|
numBatches: 3,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 2,
|
|
numBatches: 1,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 3,
|
|
numBatches: 5,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
{
|
|
firstbatchIdx: 4,
|
|
numBatches: 4,
|
|
firstEventFailoverVersion: 1,
|
|
lastEventFailoverVersion: 1,
|
|
},
|
|
}
|
|
s.initMockExecutionManager(batchInfo, -1, true, pages...)
|
|
itr2 := s.constructTestHistoryIterator(s.mockExecutionMgr, targetBlobSize, nil)
|
|
|
|
totalPages := 3
|
|
expectedFirstEventID := []int64{1, 7, 14}
|
|
for i := 0; i != totalPages; i++ {
|
|
s.True(itr1.HasNext())
|
|
history1, err := itr1.Next(context.Background())
|
|
s.NoError(err)
|
|
|
|
s.True(itr2.HasNext())
|
|
history2, err := itr2.Next(context.Background())
|
|
s.NoError(err)
|
|
|
|
s.Equal(history1.Header, history2.Header)
|
|
s.Equal(len(history1.Body), len(history2.Body))
|
|
s.Equal(expectedFirstEventID[i], history1.Body[0].Events[0].GetEventId())
|
|
s.Equal(expectedFirstEventID[i], history2.Body[0].Events[0].GetEventId())
|
|
}
|
|
expectedIteratorState := historyIteratorState{
|
|
NextEventID: 0,
|
|
FinishedIteration: true,
|
|
}
|
|
s.assertStateMatches(expectedIteratorState, itr1)
|
|
s.assertStateMatches(expectedIteratorState, itr2)
|
|
s.False(itr1.HasNext())
|
|
s.False(itr2.HasNext())
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) TestNewIteratorWithState() {
|
|
itr := s.constructTestHistoryIterator(nil, testDefaultTargetHistoryBlobSize, nil)
|
|
testIteratorState := historyIteratorState{
|
|
FinishedIteration: true,
|
|
NextEventID: 4,
|
|
}
|
|
itr.historyIteratorState = testIteratorState
|
|
stateToken, err := itr.GetState()
|
|
s.NoError(err)
|
|
|
|
newItr := s.constructTestHistoryIterator(nil, testDefaultTargetHistoryBlobSize, stateToken)
|
|
s.assertStateMatches(testIteratorState, newItr)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) initMockExecutionManager(batchInfo []int, returnErrorOnPage int, addNotExistCall bool, pages ...page) {
|
|
firstEventIDs := []int64{common.FirstEventID}
|
|
for i, batchSize := range batchInfo {
|
|
firstEventIDs = append(firstEventIDs, firstEventIDs[i]+int64(batchSize))
|
|
}
|
|
|
|
testShardId := testShardID
|
|
for i, p := range pages {
|
|
req := &persistence.ReadHistoryBranchRequest{
|
|
BranchToken: testBranchToken,
|
|
MinEventID: firstEventIDs[p.firstbatchIdx],
|
|
MaxEventID: common.EndEventID,
|
|
PageSize: testDefaultPersistencePageSize,
|
|
ShardID: testShardId,
|
|
}
|
|
if returnErrorOnPage == i {
|
|
s.mockExecutionMgr.EXPECT().ReadHistoryBranchByBatch(gomock.Any(), req).Return(nil, errors.New("got error getting workflow execution history"))
|
|
return
|
|
}
|
|
|
|
resp := &persistence.ReadHistoryBranchByBatchResponse{
|
|
History: s.constructHistoryBatches(batchInfo, p, firstEventIDs[p.firstbatchIdx]),
|
|
}
|
|
s.mockExecutionMgr.EXPECT().ReadHistoryBranchByBatch(gomock.Any(), req).Return(resp, nil).MaxTimes(2)
|
|
}
|
|
|
|
if addNotExistCall {
|
|
req := &persistence.ReadHistoryBranchRequest{
|
|
BranchToken: testBranchToken,
|
|
MinEventID: firstEventIDs[len(firstEventIDs)-1],
|
|
MaxEventID: common.EndEventID,
|
|
PageSize: testDefaultPersistencePageSize,
|
|
ShardID: testShardId,
|
|
}
|
|
s.mockExecutionMgr.EXPECT().ReadHistoryBranchByBatch(gomock.Any(), req).Return(nil, serviceerror.NewNotFound("Reach the end"))
|
|
}
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) copyIteratorState(itr *historyIterator) historyIteratorState {
|
|
return itr.historyIteratorState
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) assertStateMatches(expected historyIteratorState, itr *historyIterator) {
|
|
s.Equal(expected.NextEventID, itr.NextEventID)
|
|
s.Equal(expected.FinishedIteration, itr.FinishedIteration)
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) constructHistoryBatches(batchInfo []int, page page, firstEventID int64) []*historypb.History {
|
|
var batches []*historypb.History
|
|
eventsID := firstEventID
|
|
for batchIdx, numEvents := range batchInfo[page.firstbatchIdx : page.firstbatchIdx+page.numBatches] {
|
|
var events []*historypb.HistoryEvent
|
|
for i := 0; i < numEvents; i++ {
|
|
event := &historypb.HistoryEvent{
|
|
EventId: eventsID,
|
|
Version: page.firstEventFailoverVersion,
|
|
}
|
|
eventsID++
|
|
if batchIdx == page.numBatches-1 {
|
|
event.Version = page.lastEventFailoverVersion
|
|
}
|
|
events = append(events, event)
|
|
}
|
|
batches = append(batches, &historypb.History{
|
|
Events: events,
|
|
})
|
|
}
|
|
return batches
|
|
}
|
|
|
|
func (s *HistoryIteratorSuite) constructTestHistoryIterator(
|
|
mockExecutionMgr *persistence.MockExecutionManager,
|
|
targetHistoryBlobSize int,
|
|
initialState []byte,
|
|
) *historyIterator {
|
|
request := &ArchiveHistoryRequest{
|
|
ShardID: testShardID,
|
|
NamespaceID: testNamespaceID,
|
|
Namespace: testNamespace,
|
|
WorkflowID: testWorkflowID,
|
|
RunID: testRunID,
|
|
BranchToken: testBranchToken,
|
|
NextEventID: testNextEventID,
|
|
CloseFailoverVersion: testCloseFailoverVersion,
|
|
}
|
|
itr := newHistoryIterator(request, mockExecutionMgr, targetHistoryBlobSize)
|
|
if initialState != nil {
|
|
err := itr.reset(initialState)
|
|
s.NoError(err)
|
|
}
|
|
itr.sizeEstimator = newTestSizeEstimator()
|
|
return itr
|
|
}
|
|
func (s *HistoryIteratorSuite) TestJSONSizeEstimator() {
|
|
e := NewJSONSizeEstimator()
|
|
|
|
historyEvent := &historypb.HistoryEvent{
|
|
EventId: 1,
|
|
EventTime: timestamppb.New(time.Date(1978, 8, 22, 12, 59, 59, 999999, time.UTC)),
|
|
TaskId: 1,
|
|
Version: 1,
|
|
}
|
|
historyEvent.EventType = enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED
|
|
historyEvent.Attributes = &historypb.HistoryEvent_WorkflowTaskScheduledEventAttributes{WorkflowTaskScheduledEventAttributes: &historypb.WorkflowTaskScheduledEventAttributes{
|
|
TaskQueue: &taskqueuepb.TaskQueue{
|
|
Name: "taskQueue",
|
|
Kind: enumspb.TASK_QUEUE_KIND_NORMAL,
|
|
},
|
|
StartToCloseTimeout: durationpb.New(10 * time.Second),
|
|
Attempt: 1,
|
|
}}
|
|
|
|
h := &historypb.History{
|
|
Events: []*historypb.HistoryEvent{
|
|
historyEvent,
|
|
},
|
|
}
|
|
|
|
size, err := e.EstimateSize(h)
|
|
s.NoError(err)
|
|
|
|
// The size seems to fluctuate between compiles using google's protoc toolchain. I'd like to delete this altogether
|
|
s.Contains([]int{295, 303}, size)
|
|
}
|