Merge pull request #284 from code0-tech/feat/#283

Add module structure

Author: nicosammito

README.md

@@ -56,31 +56,27 @@ services that Sagittarius must implement as a server.
 .
 ├── aquila
 │   ├── action - Action service (emits events, and handles executions)
-│   ├── action_configuration - ActionConfiguration service 
-│   ├── data_type - DataType service
-│   ├── flow_definition - FlowType service (handles flow_type updates)
-│   ├── runtime_function - Service for updating the runtime functions
+│   ├── module - Module service for Taurus to send over datatypes, functions and flow types
 │   ├── runtime_status - Service for runtime status (handles information about Draco and Taurus)
 │   └── runtime_usage - Service for runtime usage (handles execution time of a flow)
 ├── sagittarius
-│   ├── action_configuration - ActionConfiguration service 
-│   ├── data_type - DataType service
 │   ├── flow - Flow service (handles flow updates)
-│   ├── flow_type - FlowType service (handles flow_type updates)
+│   ├── module - Module service to receive datatypes, functions and flow types from aquila
 │   ├── ping - Ping service (performs life checks)
-│   ├── runtime_function - Service for updating the runtime functions
 │   ├── runtime_status - Service for runtime status (handles information about Draco and Taurus)
 │   ├── runtime_usage - Service for runtime usage (handles execution time of a flow)
 │   └── test_execution - Service and Types for the test execution
 └── shared
-    ├── action_configuration - Defines types for action configuration
     ├── data_type - Defines types for data types
-    ├── flow - Defines types for flows
-    ├── flow_definition - Defines a definition for a Flow
-    ├── runtime_function - Defines types for runtime functions
-    ├── runtime_status - Defines types for runtime status (handles information about Draco and Taurus)
-    ├── runtime_usage - Defines types for runtime usage (handles execution time of a flow)
-    ├── struct - Defines types for json representations
-    ├── translation - Contains translations with country codes and translated messages
-    └── version - Contains verion type for definitions
+    ├── errors - Defines error object
+    ├── execution_result - Defines execution result of a flow
+    ├── flow - Defines the flow to execute
+    ├── flow_type - Defines types for flows
+    ├── function - Defines a function
+    ├── module - Defines group of functions, runtime functions, flow types and data types
+    ├── runtime_function - Defines a runtime function
+    ├── runtime_status - Defines a runtime status (handles information about Draco and Taurus)
+    ├── runtime_usage - Defines a runtime usage (handles execution time of a flow)
+    ├── struct - Defines json representations
+    └── translation - Contains translations with country codes and translated messages
 ```

proto/aquila/aquila.action.proto

@@ -4,12 +4,12 @@ option ruby_package = "Tucana::Aquila";
 
 package aquila;
 
-import "shared.action_configuration.proto";
+import "shared.module.proto";
 import "shared.execution_result.proto";
 import "shared.struct.proto";
 
 // Event that gets admitted by an action
-message Event {
+message ActionEvent {
   // Id of Event type
   string event_type = 1;
   // Project Id that this event is emitted for
@@ -21,13 +21,11 @@ message Event {
 // Action flow/event configuration
 message ActionLogon {
   // Action identifier
-  string action_identifier = 1;
-  string version = 2;
-  repeated shared.ActionConfigurationDefinition action_configurations = 3;
+  shared.Module module = 1;
 }
 
 // Request to execute a request a flow
-message ExecutionRequest {
+message ActionExecutionRequest {
   // Execution identifier of execution
   string execution_identifier = 1;
   // Function identifier of flow to execute
@@ -38,41 +36,30 @@ message ExecutionRequest {
   int64 project_id = 4;
 }
 
-// Result from executed flows by an action
-message ExecutionResult {
-  // Identifier of flow to execute
-  string execution_identifier = 1;
-  // Result of executed flow
-  oneof result {
-    shared.Value success = 2;
-    shared.RuntimeError error = 3;
-  }
-}
-
-message TransferRequest {
+message ActionTransferRequest {
   oneof data {
     // Identification of the action
     //
     // Expected behavior:
     // Aquila will abort if the first request is not an ActionLogon
     ActionLogon logon = 1;
     // Event that got admitted
-    Event event = 2;
+    ActionEvent event = 2;
     // Result of execution that was triggered by a execution request
-    ExecutionResult result = 3;
+    shared.NodeExecutionResult result = 3;
   }
 }
 
-message TransferResponse {
+message ActionTransferResponse {
   oneof data {
     // Execution request
-    ExecutionRequest execution = 1;
-    // ActionConfigurations that have been configured by the user
-    shared.ActionConfigurations action_configurations = 2;
+    ActionExecutionRequest execution = 1;
+    // ModuleConfigurations that have been configured by the user
+    shared.ModuleConfigurations module_configurations = 2;
   }
 }
 
 service ActionTransferService {
   // This behavior achieves a bi-directional stream so that both services aren't required to be a server & client on their own
-  rpc Transfer (stream TransferRequest) returns (stream TransferResponse);
+  rpc Transfer (stream ActionTransferRequest) returns (stream ActionTransferResponse);
 }

proto/aquila/aquila.data_type.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+option ruby_package = "Tucana::Aquila";
+
+package aquila;
+
+import "shared.module.proto";
+
+// Request for updating a list of modules including data types, flow types and runtime function definitions
+message ModuleUpdateRequest {
+  // List of modules
+  repeated shared.Module modules = 1;
+}
+
+// Response of updating modules including data types, flow types and runtime function definitions
+message ModuleUpdateResponse {
+  // True if was successful, false if not
+  bool success = 1;
+}
+
+//This service will be implemented as a server by Aquila and as a client by Taurus.
+service ModuleService {
+  rpc Update(ModuleUpdateRequest) returns (ModuleUpdateResponse) {}
+}

proto/aquila/aquila.flow_type.proto

@@ -5,7 +5,7 @@ option ruby_package = "Tucana::Sagittarius";
 package sagittarius;
 
 import "shared.flow.proto";
-import "shared.action_configuration.proto";
+import "shared.module.proto";
 
 //Aquila sends a request to initialise stream to Sagittarius
 message FlowLogonRequest {
@@ -20,8 +20,8 @@ message FlowResponse {
     int64 deleted_flow_id = 2;
     // Replaces all flows in Aquila (only on startup and for releases)
     shared.Flows flows = 3;
-    // ActionConfigurations that have been configured by the user 
-    shared.ActionConfigurations action_configurations = 4;
+    // ModuleConfigurations that have been configured by the user
+    shared.ModuleConfigurations module_configurations = 4;
   }
 }