Files
tasks/common/persistence/serializer_test.go
Stephan BehnkeandGitHub 9fd2383c0c Remove encodingType from Serializer interface (#7942)
## What changed?

Removes the `encodingType` from the `Serializer` interface.

## Why?

The parameter is superfluous since it always set to
`enumspb.ENCODING_TYPE_PROTO3`. There are no plans to move to a
different encoding scheme. An encoding parameter for existing/new
methods can be added (back) as needed.

The next steps will be:

1. a codec for the serializer to allow customizing the encoding globally
1. an env variable to customize the encoding to be JSON (for
debugging/developing purposes)

## How did you test it?
- [ ] built
- [ ] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)
2025-06-20 11:30:31 -07:00

125 lines
3.0 KiB
Go

package persistence
import (
"sync"
"testing"
"time"
"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/server/common"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/payloads"
"go.temporal.io/server/common/persistence/serialization"
"go.temporal.io/server/common/testing/protorequire"
"google.golang.org/protobuf/types/known/timestamppb"
)
type (
temporalSerializerSuite struct {
suite.Suite
// override suite.Suite.Assertions with require.Assertions; this means that s.NotNil(nil) will stop the test,
// not merely log an error
*require.Assertions
protorequire.ProtoAssertions
logger log.Logger
}
)
func TestTemporalSerializerSuite(t *testing.T) {
s := new(temporalSerializerSuite)
suite.Run(t, s)
}
func (s *temporalSerializerSuite) SetupTest() {
s.logger = log.NewTestLogger()
// Have to define our overridden assertions in the test setup. If we did it earlier, s.T() will return nil
s.Assertions = require.New(s.T())
s.ProtoAssertions = protorequire.New(s.T())
}
func (s *temporalSerializerSuite) TestSerializer() {
concurrency := 1
startWG := sync.WaitGroup{}
doneWG := sync.WaitGroup{}
startWG.Add(1)
doneWG.Add(concurrency)
serializer := serialization.NewSerializer()
eventType := enumspb.EVENT_TYPE_ACTIVITY_TASK_COMPLETED
event0 := &historypb.HistoryEvent{
EventId: 999,
EventTime: timestamppb.New(time.Date(2020, 8, 22, 0, 0, 0, 0, time.UTC)),
EventType: eventType,
Attributes: &historypb.HistoryEvent_ActivityTaskCompletedEventAttributes{
ActivityTaskCompletedEventAttributes: &historypb.ActivityTaskCompletedEventAttributes{
Result: payloads.EncodeString("result-1-event-1"),
ScheduledEventId: 4,
StartedEventId: 5,
Identity: "event-1",
},
},
}
history0 := &historypb.History{Events: []*historypb.HistoryEvent{event0, event0}}
for i := 0; i < concurrency; i++ {
go func() {
startWG.Wait()
defer doneWG.Done()
// serialize event
nilEvent, err := serializer.SerializeEvent(nil)
s.Nil(err)
s.Nil(nilEvent)
dProto, err := serializer.SerializeEvent(event0)
s.Nil(err)
s.NotNil(dProto)
// serialize batch events
nilEvents, err := serializer.SerializeEvents(nil)
s.Nil(err)
s.NotNil(nilEvents)
dsProto, err := serializer.SerializeEvents(history0.Events)
s.Nil(err)
s.NotNil(dsProto)
// deserialize event
dNilEvent, err := serializer.DeserializeEvent(nilEvent)
s.Nil(err)
s.Nil(dNilEvent)
event2, err := serializer.DeserializeEvent(dProto)
s.Nil(err)
s.ProtoEqual(event0, event2)
// deserialize events
dNilEvents, err := serializer.DeserializeEvents(nilEvents)
s.Nil(err)
s.Nil(dNilEvents)
events, err := serializer.DeserializeEvents(dsProto)
history2 := &historypb.History{Events: events}
s.Nil(err)
s.ProtoEqual(history0, history2)
}()
}
startWG.Done()
succ := common.AwaitWaitGroup(&doneWG, 10*time.Second)
s.True(succ, "test timed out")
}