Merge pull request #289 from code0-tech/feat/#279

Adjust Interface to new RuntimeError Strategy

Author: nicosammito

proto/sagittarius/sagittarius.module.proto

@@ -17,7 +17,7 @@ message ModuleUpdateRequest {
 message ModuleUpdateResponse {
   // True if was successful, false if not
   bool success = 1;
-  optional shared.Error error = 2;
+  optional shared.ServiceError error = 2;
 }
 
 //This service will be implemented as a server by Sagittarius and as a client by Aquila.

proto/sagittarius/sagittarius.runtime_status.proto

@@ -17,7 +17,7 @@ message RuntimeStatusUpdateRequest {
 
 message RuntimeStatusUpdateResponse {
   bool success = 1;
-  optional shared.Error error = 2;
+  optional shared.ServiceError error = 2;
 }
 
 service RuntimeStatusService {

proto/sagittarius/sagittarius.runtime_usage.proto

@@ -13,7 +13,7 @@ message RuntimeUsageRequest {
 
 message RuntimeUsageResponse {
   bool success = 1;
-  optional shared.Error error = 2;
+  optional shared.ServiceError error = 2;
 }
 
 service RuntimeUsageService {

proto/shared/shared.errors.proto

@@ -4,18 +4,31 @@ package shared;
 
 option ruby_package = "Tucana::Shared";
 
-message Error {
+import "shared.struct.proto";
+
+message ServiceError {
   string message = 1;
-  repeated ErrorDetails details = 2;
+  repeated ServiceErrorDetails details = 2;
 }
 
-message ErrorDetails {
+message ServiceErrorDetails {
   oneof kind {
-    ActiveModelError active_model_error = 1;
+    ServiceActiveModelError active_model_error = 1;
   }
 }
 
-message ActiveModelError {
+message ServiceActiveModelError {
   string attribute = 1;
   string type = 2;
 }
+
+message Error {
+  string code = 1; //e.g. T-STD-000123
+  string category = 2; //e.g. InvalidArgument
+  string message = 3; //e.g. Expected number as argument but received list
+  int64 timestamp = 4; // epoch timestamp in milliseconds
+  string version = 5; // version of service which produced the error
+  map<string, string> dependencies = 6;
+  shared.Struct details = 7;
+
+}

proto/shared/shared.execution_result.proto

@@ -5,16 +5,12 @@ package shared;
 option ruby_package = "Tucana::Shared";
 
 import "shared.struct.proto";
+import "shared.errors.proto";
 
 message NodeParameterNodeExecutionResult {
   shared.Value value = 5;
 }
 
-message RuntimeError {
-  string code = 1;
-  optional string description = 2;
-}
-
 message NodeExecutionResult {
 
   int64 node_id = 1;
@@ -25,7 +21,7 @@ message NodeExecutionResult {
 
   oneof result {
     shared.Value success = 5;
-    RuntimeError error = 6;
+    shared.Error error = 6;
   }
 
 }
@@ -43,7 +39,7 @@ message ExecutionResult {
   // Result of executed flow
   oneof result {
     shared.Value success = 7;
-    RuntimeError error = 8;
+    shared.Error error = 8;
   }
 
 }