feature/issue 59 (#69)

* [issue59] Added Passivation Strategy options and adapted to new TCK tests. Passes with 186/186. * [issue59] added optional comma in aggregated prototext value; to be inline with the main repository. * [issue59] aligned with minor differences in *.proto files regarding formatting and small differences like options.
cloudstateio · Jan 13, 2021 · 1169391 · 1169391
1 parent 005c956
commit 1169391
Show file tree

Hide file tree

Showing 28 changed files with 815 additions and 134 deletions.
diff --git a/cloudstate/cloudstate.go b/cloudstate/cloudstate.go
@@ -61,7 +61,8 @@ func New(c protocol.Config) (*CloudState, error) {
 }
 
 // RegisterEventSourced registers an event sourced entity.
-func (cs *CloudState) RegisterEventSourced(entity *eventsourced.Entity, config protocol.DescriptorConfig) error {
+func (cs *CloudState) RegisterEventSourced(entity *eventsourced.Entity, config protocol.DescriptorConfig, options ...eventsourced.Option) error {
+	entity.Options(options...)
 	if err := cs.eventSourcedServer.Register(entity); err != nil {
 		return err
 	}
@@ -72,7 +73,8 @@ func (cs *CloudState) RegisterEventSourced(entity *eventsourced.Entity, config p
 }
 
 // RegisterCRDT registers a CRDT entity.
-func (cs *CloudState) RegisterCRDT(entity *crdt.Entity, config protocol.DescriptorConfig) error {
+func (cs *CloudState) RegisterCRDT(entity *crdt.Entity, config protocol.DescriptorConfig, options ...crdt.Option) error {
+	entity.Options(options...)
 	if err := cs.crdtServer.Register(entity); err != nil {
 		return err
 	}
@@ -94,7 +96,8 @@ func (cs *CloudState) RegisterAction(entity *action.Entity, config protocol.Desc
 }
 
 // RegisterValueEntity registers a Value entity.
-func (cs *CloudState) RegisterValueEntity(entity *value.Entity, config protocol.DescriptorConfig) error {
+func (cs *CloudState) RegisterValueEntity(entity *value.Entity, config protocol.DescriptorConfig, options ...value.Option) error {
+	entity.Options(options...)
 	if err := cs.valueServer.Register(entity); err != nil {
 		return err
 	}

diff --git a/cloudstate/crdt/entity.go b/cloudstate/crdt/entity.go
@@ -16,6 +16,9 @@
 package crdt
 
 import (
+	"time"
+
+	"github.com/cloudstateio/go-support/cloudstate/protocol"
 	"github.com/golang/protobuf/proto"
 	"github.com/golang/protobuf/ptypes/any"
 )
@@ -27,7 +30,28 @@ type Entity struct {
 	// this entities interface. Setting it is mandatory.
 	ServiceName ServiceName
 	// EntityFunc creates a new entity.
-	EntityFunc func(id EntityID) EntityHandler
+	EntityFunc          func(id EntityID) EntityHandler
+	PassivationStrategy protocol.EntityPassivationStrategy
+}
+
+type Option func(s *Entity)
+
+func (e *Entity) Options(options ...Option) {
+	for _, opt := range options {
+		opt(e)
+	}
+}
+
+func WithPassivationStrategyTimeout(duration time.Duration) Option {
+	return func(e *Entity) {
+		e.PassivationStrategy = protocol.EntityPassivationStrategy{
+			Strategy: &protocol.EntityPassivationStrategy_Timeout{
+				Timeout: &protocol.TimeoutPassivationStrategy{
+					Timeout: duration.Milliseconds(),
+				},
+			},
+		}
+	}
 }
 
 // EntityHandler has to be implemented by any type that wants to get

diff --git a/cloudstate/discovery/server.go b/cloudstate/discovery/server.go
@@ -127,11 +127,15 @@ func (s *EntityDiscoveryServer) RegisterEventSourcedEntity(entity *eventsourced.
 	if err := s.resolveFileDescriptors(config); err != nil {
 		return fmt.Errorf("failed to resolve FileDescriptor for DescriptorConfig: %+v: %w", config, err)
 	}
-	s.entitySpec.Entities = append(s.entitySpec.Entities, &protocol.Entity{
+	e := &protocol.Entity{
 		EntityType:    protocol.EventSourced,
 		ServiceName:   entity.ServiceName.String(),
 		PersistenceId: entity.PersistenceID,
-	})
+	}
+	if entity.PassivationStrategy.Strategy != nil {
+		e.PassivationStrategy = &entity.PassivationStrategy
+	}
+	s.entitySpec.Entities = append(s.entitySpec.Entities, e)
 	return s.updateSpec()
 }
 
@@ -141,12 +145,16 @@ func (s *EntityDiscoveryServer) RegisterCRDTEntity(entity *crdt.Entity, config p
 	if err := s.resolveFileDescriptors(config); err != nil {
 		return fmt.Errorf("failed to resolveFileDescriptor for DescriptorConfig: %+v: %w", config, err)
 	}
-	s.entitySpec.Entities = append(s.entitySpec.Entities, &protocol.Entity{
-		EntityType:    protocol.CRDT,
-		ServiceName:   entity.ServiceName.String(),
-		PersistenceId: entity.ServiceName.String(), // make sure CRDT entities have unique keys per service
-
-	})
+	e := &protocol.Entity{
+		EntityType:  protocol.CRDT,
+		ServiceName: entity.ServiceName.String(),
+		// TODO: as per https://github.com/cloudstateio/go-support/pull/67#issuecomment-749838999 this is temporary.
+		PersistenceId: entity.ServiceName.String(), // make sure CRDT entities have unique keys per service.
+	}
+	if entity.PassivationStrategy.GetStrategy() != nil {
+		e.PassivationStrategy = &entity.PassivationStrategy
+	}
+	s.entitySpec.Entities = append(s.entitySpec.Entities, e)
 	return s.updateSpec()
 }
 
@@ -169,11 +177,15 @@ func (s *EntityDiscoveryServer) RegisterValueEntity(entity *value.Entity, config
 	if err := s.resolveFileDescriptors(config); err != nil {
 		return fmt.Errorf("failed to resolveFileDescriptor for DescriptorConfig: %+v: %w", config, err)
 	}
-	s.entitySpec.Entities = append(s.entitySpec.Entities, &protocol.Entity{
+	e := &protocol.Entity{
 		EntityType:    protocol.Value,
 		ServiceName:   entity.ServiceName.String(),
 		PersistenceId: entity.PersistenceID,
-	})
+	}
+	if entity.PassivationStrategy.GetStrategy() != nil {
+		e.PassivationStrategy = &entity.PassivationStrategy
+	}
+	s.entitySpec.Entities = append(s.entitySpec.Entities, e)
 	return s.updateSpec()
 }
 

diff --git a/cloudstate/eventsourced/entity.go b/cloudstate/eventsourced/entity.go
@@ -16,6 +16,9 @@
 package eventsourced
 
 import (
+	"time"
+
+	"github.com/cloudstateio/go-support/cloudstate/protocol"
 	"github.com/golang/protobuf/proto"
 )
 
@@ -40,6 +43,28 @@ type Entity struct {
 	SnapshotEvery int64
 	// EntityFunc is a factory method which generates a new Entity.
 	EntityFunc func(id EntityID) EntityHandler
+
+	PassivationStrategy protocol.EntityPassivationStrategy
+}
+
+type Option func(s *Entity)
+
+func (e *Entity) Options(options ...Option) {
+	for _, opt := range options {
+		opt(e)
+	}
+}
+
+func WithPassivationStrategyTimeout(duration time.Duration) Option {
+	return func(e *Entity) {
+		e.PassivationStrategy = protocol.EntityPassivationStrategy{
+			Strategy: &protocol.EntityPassivationStrategy_Timeout{
+				Timeout: &protocol.TimeoutPassivationStrategy{
+					Timeout: duration.Milliseconds(),
+				},
+			},
+		}
+	}
 }
 
 type (