Update protobufs

Author: sleipnir

protobuf/eigr/actor.proto protobuf/eigr/functions/protocol/actors/actor.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-package eigr.actors;
+package eigr.functions.protocol.actors;
 
 import "google/protobuf/any.proto";
 
@@ -75,19 +75,56 @@ message Metadata {
     map<string, string> tags = 2;
 }
 
+// The type that defines the runtime characteristics of the Actor.
+// Regardless of the type of actor it is important that 
+// all actors are registered during the proxy and host initialization phase.
+enum Kind {
+    // When no type is informed, the default to be assumed will be the Singleton pattern.
+    UNKNOW_KIND = 0;
+
+    // Abstract actors are used to create children of this based actor at runtime
+    ABSTRACT = 1;
+
+    // Singleton actors as the name suggests have only one real instance of themselves running 
+    // during their entire lifecycle. That is, they are the opposite of the Abstract type Actors.
+    SINGLETON = 2;
+    
+    // Pooled Actors are similar to abstract actors, but unlike them, 
+    // their identifying name will always be the one registered at the system initialization stage. 
+    // The great advantage of Pooled actors is that they have multiple instances of themselves 
+    // acting as a request service pool.
+    // Pooled actors are also stateless actors, that is, they will not have their 
+    // in-memory state persisted via Statesstore. This is done to avoid problems 
+    // with the correctness of the stored state.
+    // Pooled Actors are generally used for tasks where the Actor Model would perform worse 
+    // than other concurrency models and for tasks that do not require state concerns. 
+    // Integration flows, data caching, proxies are good examples of use cases 
+    // for this type of Actor.
+    POOLED = 3;
+    
+    // Reserved for future use
+    PROXY = 4;
+}
+
 message ActorSettings {
 
-    // Indicates if actor´s is abstract or non abstract.
-    bool abstract = 1;
+    // Indicates the type of Actor to be configured.
+    Kind kind = 1;
 
     // Indicates whether an actor's state should be persisted in a definitive store.
-    bool persistent = 2;
+    bool stateful = 2;
 
     // Snapshot strategy
     ActorSnapshotStrategy snapshot_strategy = 3;
 
     // Deactivate strategy
     ActorDeactivationStrategy deactivation_strategy = 4;
+
+    // When kind is POOLED this is used to define minimun actor instances
+    int32 min_pool_size = 5;
+
+    // When kind is POOLED this is used to define maximum actor instances
+    int32 max_pool_size = 6;
 }
 
 message ActorId {
@@ -96,6 +133,10 @@ message ActorId {
 
     // Name of a ActorSystem
     string system = 2;
+
+    // When the Actor is of the Abstract type, 
+    // the name of the parent Actor must be informed here.
+    string parent = 3;
 }
 
 message Actor {

protobuf/eigr/functions/protocol/actors/protocol.proto

@@ -3,6 +3,4 @@ google-api>=0.1.12
 googleapis-common-protos>=1.56.4
 flask>=2.1.3
 protobuf>=3.20.0
-grpcio>=1.48.1
-grpcio-tools>=1.0.0
 pytest>=7.1.2

protobuf/eigr/protocol.proto

@@ -5,7 +5,7 @@ set -o errexit
 set -o pipefail
 
 # follow the basic steps here: https://grpc.io/docs/tutorials/basic/python/
-python3 -m grpc_tools.protoc -I ../protobuf/ --python_out=../spawn eigr/actor.proto
-python3 -m grpc_tools.protoc -I ../protobuf/ --python_out=../spawn eigr/protocol.proto
+protoc -I ../protobuf/ --python_out=../spawn eigr/functions/protocol/actors/actor.proto
+protoc -I ../protobuf/ --python_out=../spawn eigr/functions/protocol/actors/protocol.proto
 
-python3 -m grpc_tools.protoc -I ../example/protobuf/ --python_out=../example ../example/protobuf/domain/domain.proto
+protoc -I ../example/protobuf/ --python_out=../example ../example/protobuf/domain/domain.proto

requirements.txt

@@ -22,8 +22,6 @@ install_requires =
     attrs == 21.4.0
     google-api == 0.1.12
     googleapis-common-protos == 1.56.4
-    grpcio == 1.48.1
-    grpcio-tools == 1.0.0
     flask == 2.1.3
     protobuf == 3.20.0
     pytest == 7.1.2

scripts/compile-pb.sh

@@ -35,7 +35,7 @@ def run(self):
                     file_path = pathlib.Path(root) / file
                     destination = "."
                     print(f"compiling {file_path} to {destination}")
-                    command = f"python -m grpc_tools.protoc {' '.join([' -I ' + i for i in proto_roots + proto_lib_roots])} --python_out={destination} --grpc_python_out={destination} {file_path}"  # noqa
+                    command = f"protoc {' '.join([' -I ' + i for i in proto_roots + proto_lib_roots])} --python_out={destination} --grpc_python_out={destination} {file_path}"  # noqa
                     os.system(command)
 
         return super().run()
@@ -62,8 +62,6 @@ def run(self):
         "attrs>=21.4.0",
         "google-api>=0.1.12",
         "googleapis-common-protos>=1.56.4",
-        "grpcio>=1.48.1",
-        "grpcio-tools>=1.0.0",
         "flask>=2.1.3",
         "protobuf>=3.20.0",
         "pytest>=7.1.2",

setup.cfg

@@ -2,7 +2,7 @@
 Copyright 2022 Eigr.
 Licensed under the Apache License, Version 2.0.
 """
-from spawn.eigr.actor_pb2 import (
+from spawn.eigr.functions.protocol.actors.actor_pb2 import (
     Actor,
     ActorId,
     ActorState,
@@ -16,7 +16,8 @@
     Registry,
     TimeoutStrategy,
 )
-from spawn.eigr.protocol_pb2 import (
+
+from spawn.eigr.functions.protocol.actors.protocol_pb2 import (
     RegistrationRequest,
     RegistrationResponse,
     ServiceInfo,
@@ -53,7 +54,8 @@ def register(self, actors: List[ActorEntity]):
         logging.info("Registering Actors on the Proxy %s", actors)
         try:
 
-            proxy_url = "http://{}:{}{}".format(self.host, self.port, self.register_uri)
+            proxy_url = "http://{}:{}{}".format(self.host,
+                                                self.port, self.register_uri)
 
             # Create actor params via ActorEntity
             deactivate_timeout_strategy = TimeoutStrategy()