Refactor/error improvements (#15)

* refactor: move errors to its own module

* refactor: remove panic call from start API

* refactor: remove ServiceBuilder default implementation

* refactor: use new output format for error (initial changes)

* feat: add new HTTP example with protobuf

* feat: add new service error structure

- Adding new error structure to be used by applications as their errors.

* feat: improve public error API

* chore: update example

* feat: add support for hiding response error fields

- Also adding option to log every error returned by a service.

* refactor: code style adjustments

* test: add tests for service error object

* chore: update coverage badge

Author: rsfreitas

docs/mikros.md

@@ -187,14 +187,15 @@ max_diff_range = 100
 Mikros has some environment variables that it uses to set custom information
 while the application is running. They are the following:
 
-| Name                       | Description                                                                                                              |
-|----------------------------|--------------------------------------------------------------------------------------------------------------------------|
-| MIKROS_SERVICE_DEPLOY      | A string to set the current deployment server of the application, like (dev, stage, prod). Default: local                |
-| MIKROS_TRACKER_HEADER_NAME | A header name where the track ID will be located in HTTP requests/responses (not implemented yet). Default: X-Request-ID |
-| MIKROS_COUPLED_NAMESPACE   | The namespace where services/applications are running, to build the gRPC connection URL. Default: localhost              | 
-| MIKROS_COUPLED_PORT        | The default port for dependent gRPC services. Default: 7070                                                              |
-| MIKROS_GRPC_PORT           | Default listening port for gRPC applications. Default: 7070                                                              |
-| MIKROS_HTTP_PORT           | Default listening port for HTTP applications. Default: 8080                                                              |
+| Name                        | Description                                                                                                              |
+|-----------------------------|--------------------------------------------------------------------------------------------------------------------------|
+| MIKROS_SERVICE_DEPLOY       | A string to set the current deployment server of the application, like (dev, stage, prod). Default: local                |
+| MIKROS_TRACKER_HEADER_NAME  | A header name where the track ID will be located in HTTP requests/responses (not implemented yet). Default: X-Request-ID |
+| MIKROS_COUPLED_NAMESPACE    | The namespace where services/applications are running, to build the gRPC connection URL. Default: localhost              | 
+| MIKROS_COUPLED_PORT         | The default port for dependent gRPC services. Default: 7070                                                              |
+| MIKROS_GRPC_PORT            | Default listening port for gRPC applications. Default: 7070                                                              |
+| MIKROS_HTTP_PORT            | Default listening port for HTTP applications. Default: 8080                                                              |
+| MIKROS_HIDE_RESPONSE_FIELDS | A comma separated list of fields to be hidden in HTTP services error response.                                           |
 
 ### The service structure
 

examples/apps/Cargo.toml

@@ -6,7 +6,7 @@ members = [
     "grpc_with_lifecycle",
     "http",
     "http_with_lifecycle",
-    "http_with_lifecycle_and_state",
+    "http_with_lifecycle_and_state", "http_with_protobuf",
     "http_with_state",
     "native",
     "script"

examples/apps/cronjob_service/service.toml

@@ -2,7 +2,7 @@ name = "cronjob-example"
 version = "v0.1.0"
 language = "rust"
 product = "examples"
-types = ["cronjob"]
+types = ["cronjob2"]
 
 [features.simple_api]
 enabled = true

examples/apps/cronjob_service/src/main.rs

@@ -19,17 +19,14 @@ impl cronjob::CronjobService for Service {
 }
 
 #[tokio::main]
-async fn main() {
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let s = Box::new(Service::default());
     let c = Box::new(CronjobBuilder::new(s).build());
 
-    let svc = ServiceBuilder::default()
+    let mut svc = ServiceBuilder::new()
         .custom(c)
         .with_features(vec![simple_api::new(), example::new()])
-        .build();
+        .build()?;
 
-    match svc {
-        Ok(mut svc) => svc.start().await,
-        Err(e) => panic!("{}", e.to_string()),
-    }
+    Ok(svc.start().await?)
 }

examples/apps/grpc/src/main.rs

@@ -58,12 +58,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let greeter = Arc::new(MyGreeter::new(ctx.clone()));
     let greeter_service = GreeterServer::from_arc(greeter);
 
-    let svc = ServiceBuilder::default().grpc(greeter_service).build();
+    let mut svc = ServiceBuilder::new()
+        .grpc(greeter_service)
+        .build()?;
 
-    match svc {
-        Ok(mut svc) => svc.start().await,
-        Err(e) => panic!("{}", e.to_string()),
-    }
-
-    Ok(())
+    Ok(svc.start().await?)
 }

examples/apps/grpc_with_lifecycle/src/main.rs

@@ -87,14 +87,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let greeter = Arc::new(MyGreeter::new(ctx.clone()));
     let greeter_service = GreeterServer::from_arc(greeter);
 
-    let svc = ServiceBuilder::default()
+    let mut svc = ServiceBuilder::new()
         .grpc_with_lifecycle(greeter_service, ctx.clone())
-        .build();
+        .build()?;
 
-    match svc {
-        Ok(mut svc) => svc.start().await,
-        Err(e) => panic!("{}", e.to_string()),
-    }
-
-    Ok(())
+    Ok(svc.start().await?)
 }

examples/apps/http_with_protobuf/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "http_with_protobuf"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+chrono = "0.4.39"
+example = { path = "../../features/example" }
+mikros = { path = "../../../" }
+prost = "0.13.3"
+prost-wkt = "0.6.0"
+prost-wkt-types = "0.6.0"
+serde = "1.0.215"
+tokio = { version = "1.41.1", features = ["full"] }
+tonic = "0.12.3"
+uuid = {version = "1.11.0", features = ["serde", "v4"]}
+
+[build-dependencies]
+tonic-build = "0.12.3"

examples/apps/http_with_protobuf/build.rs

@@ -0,0 +1,19 @@
+fn main() {
+    tonic_build::configure()
+        .protoc_arg("--mikros-extensions_out=src")
+        .protoc_arg("--mikros-extensions_opt=settings=protoc-gen-mikros-extensions.toml")
+        .out_dir("src/generated")
+        .extern_path(
+            ".google.protobuf.Timestamp",
+            "::prost_wkt_types::Timestamp"
+        )
+        .compile_protos(
+            &["proto/card.proto"],
+            &["proto", "plugin"],
+        )
+        .unwrap_or_else(|e| panic!("Failed to compile protos: {:?}", e));
+
+    // Set files that trigger this build process if changed.
+    println!("cargo:rerun-if-changed=proto/card.proto");
+    println!("cargo:rerun-if-changed=protoc-gen-mikros-extensions.toml");
+}

examples/apps/http_with_protobuf/proto/card.proto

@@ -0,0 +1,116 @@
+syntax = "proto3";
+
+package card;
+
+option go_package = "examples/gen/go/services/card;card";
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "mikros/extensions/extensions.proto";
+
+enum CardType {
+  CARD_TYPE_UNSPECIFIED = 0;
+  CARD_TYPE_CREDIT = 1;
+  CARD_TYPE_DEBIT = 2;
+}
+
+// The service entity
+message CardWire {
+  string id = 1;
+  string owner_name = 2;
+  string card_id = 3;
+  google.protobuf.Timestamp created_at = 4;
+  google.protobuf.Timestamp updated_at = 5;
+}
+
+// The service definition
+service CardService {
+  rpc CreateCard(CreateCardRequest) returns (CreateCardResponse) {
+    option (google.api.http) = {
+      post: "/card/v1/cards"
+      body: "*"
+    };
+
+    option (mikros.extensions.method_options) = {
+      http: {
+        header: "debug"
+      }
+    };
+  }
+
+  rpc GetCard(GetCardRequest) returns (GetCardResponse) {
+    option (google.api.http) = {
+      get: "/card/v1/cards/{id}"
+    };
+
+    option (mikros.extensions.method_options) = {
+      http: {
+        header: "debug"
+      }
+    };
+  }
+
+  rpc UpdateCard(UpdateCardRequest) returns (UpdateCardResponse) {
+    option (google.api.http) = {
+      put: "/card/v1/cards/{id}"
+      body: "*"
+    };
+
+    option (mikros.extensions.method_options) = {
+      http: {
+        header: "debug"
+      }
+    };
+  }
+
+  rpc DeleteCard(DeleteCardRequest) returns (DeleteCardResponse) {
+    option (google.api.http) = {
+      delete: "/card/v1/cards/{id}"
+    };
+
+    option (mikros.extensions.method_options) = {
+      http: {
+        header: "debug"
+      }
+    };
+  }
+}
+
+message CreateCardRequest {
+  string owner_name = 1;
+  string card_id = 2;
+  bool debug = 3;
+}
+
+message CreateCardResponse {
+  CardWire card = 1;
+}
+
+message GetCardRequest {
+  string id = 1;
+  bool debug = 2;
+}
+
+message GetCardResponse {
+  CardWire card = 1;
+}
+
+message UpdateCardRequest {
+  string id = 1;
+  string owner_name = 2;
+  string card_id = 3;
+  bool debug = 4;
+}
+
+message UpdateCardResponse {
+  CardWire card = 1;
+}
+
+message DeleteCardRequest {
+  string id = 1;
+  bool debug = 2;
+}
+
+message DeleteCardResponse {
+  CardWire card = 1;
+}

examples/apps/http_with_protobuf/protoc-gen-mikros-extensions.toml

@@ -0,0 +1,15 @@
+debug = true
+
+[suffix]
+domain = "Domain"
+outbound = "Outbound"
+wire = "Wire"
+wire_input = "Request"
+wire_output = "Response"
+
+[templates.rust]
+enabled = true
+single_module = true
+module_name = "api"
+run_rustfmt = true
+fmt_edition = "2021"

examples/apps/http_with_protobuf/service.toml

@@ -0,0 +1,8 @@
+name = "http-proto-example"
+version = "v0.1.0"
+language = "rust"
+product = "examples"
+types = ["http"]
+
+[features.example]
+enabled = true

examples/apps/http_with_protobuf/src/api/mod.rs

@@ -0,0 +1,2 @@
+pub mod router;
+