Merge pull request #307 from code0-tech/300-proxy-service

proxy service

Author: raphael-goetz

.github/workflows/build.yml

@@ -46,7 +46,7 @@ jobs:
         env:
           RUST_BACKTRACE: 'full'
       - name: Test De/Serialization from/to json
-        run: PATH=${{ runner.temp }}/proto/bin:$PATH cargo test --features sagittarius
+        run: PATH=${{ runner.temp }}/proto/bin:$PATH cargo test
         env:
           RUST_BACKTRACE: 'full'
       - name: Package crate

README.md

@@ -19,7 +19,7 @@ To enable additional features::
 
 ```toml
 [dependencies]
-tucana = { version = "<version>", features = ["sagittarius", "aquila"] }
+tucana = { version = "<version>", features = ["sagittarius_rails", "aquila"] }
 ```
 
 ### Ruby
@@ -33,7 +33,7 @@ gem 'tucana', '<version>'
 Don't forget to initialize the required feature:
 ```ruby
 # For Sagittarius
-Tucana.load_protocol(:sagittarius)
+Tucana.load_protocol(:sagittarius_rails)
 
 # For Aquila
 Tucana.load_protocol(:aquila)
@@ -47,26 +47,41 @@ See: [NPM](https://www.npmjs.com/package/@code0-tech/tucana)
 npm i @code0-tech/tucana
 ```
 
+### Python
+
+See: [PyPI](https://pypi.org/project/tucana/)
+
+```console
+pip install tucana
+```
+
 ## Project Structure
 
-The project is organized with services functioning as servers. Each protocol in the Sagittarius folder corresponds to
-services that Sagittarius must implement as a server.
+The project is organized with services functioning as servers. Each protocol in the Aquila folder corresponds to
+services that Aquila must implement as a server.
+
+> Notice: Sagittarius has been splitted into a service without and with streams regarding issues due to the thread blocking implementation of Ruby gRPC
 
 ```ascii-tree
 .
 ├── aquila
 │   ├── action - Action service (emits events, and handles executions)
 │   ├── 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)
 │   └── execution - Service for updating completed executions
-├── sagittarius
+├── sagittarius_gateway
+│   ├── flow - Flow service (handles flow updates)
+│   ├── module - Module service to receive datatypes, functions and flow types from aquila
+│   ├── 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├── sagittarius
+├── sagittarius_rails
 │   ├── flow - Flow service (handles flow updates)
 │   ├── module - Module service to receive datatypes, functions and flow types from aquila
-│   ├── ping - Ping service (performs life checks)
 │   ├── 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
+│   ├── test_execution - Service and Types for the test execution
+│   └── token - Service for verifing a runtime token
 └── shared
     ├── data_type - Defines types for data types
     ├── errors - Defines error object

build/python/scripts/generate.py

@@ -66,7 +66,8 @@ def organize_generated_files(output_dir: Path) -> None:
     protocol_map = {
         "shared": output_dir / "shared",
         "aquila": output_dir / "aquila",
-        "sagittarius": output_dir / "sagittarius",
+        "sagittarius_gateway": output_dir / "sagittarius_gateway",
+        "sagittarius_rails": output_dir / "sagittarius_rails",
         "velorum": output_dir / "velorum",
     }
 
@@ -95,7 +96,7 @@ def organize_generated_files(output_dir: Path) -> None:
 
 
 def create_init_files(output_dir: Path) -> None:
-    for namespace in ["shared", "aquila", "sagittarius", "velorum"]:
+    for namespace in ["shared", "aquila", "sagittarius_gateway", "sagittarius_rails", "velorum"]:
         ns_dir = output_dir / namespace
         if ns_dir.exists():
             init_file = ns_dir / "__init__.py"
@@ -154,7 +155,7 @@ def main():
 
     print(f"\n✅ Generation complete!")
     print(f"   Output directory: {generated_dir}")
-    print(f"   Ready to import: from tucana.generated import shared, aquila, sagittarius, velorum")
+    print(f"   Ready to import: from tucana.generated import shared, aquila, sagittarius_gateway, sagittarius_rails, velorum")
 
 
 if __name__ == "__main__":

build/python/tests/test_tucana.py

@@ -8,11 +8,16 @@ def test_load_aquila():
     from tucana.generated import aquila  # noqa: F401
 
 
-def test_load_sagittarius():
-    """Test loading sagittarius protocol."""
-    from tucana.generated import sagittarius  # noqa: F401
+def test_load_sagittarius_gateway():
+    """Test loading sagittarius_gateway protocol."""
+    from tucana.generated import sagittarius_gateway  # noqa: F401
+
+
+def test_load_sagittarius_rails():
+    """Test loading sagittarius_rails protocol."""
+    from tucana.generated import sagittarius_rails  # noqa: F401
 
 
 def test_load_velorum():
     """Test loading velorum protocol."""
-    from tucana.generated import velorum  # noqa: F401
+    from tucana.generated import velorum  # noqa: F401

build/ruby/lib/tucana.rb

@@ -5,7 +5,7 @@
 module Tucana
   class Error < StandardError; end
 
-  AVAILABLE_PROTOCOLS = %i[aquila sagittarius velorum]
+  AVAILABLE_PROTOCOLS = %i[aquila sagittarius_gateway sagittarius_rails velorum]
 
   def self.load_protocol(protocol)
     if protocol != :shared

build/rust/Cargo.toml

@@ -23,11 +23,12 @@ name = "tucana"
 path = "src/lib.rs"
 
 [features]
-default = ["aquila", "sagittarius", "velorum"]
+default = ["aquila", "sagittarius_gateway", "sagittarius_rails", "velorum"]
 aquila = []
-sagittarius = []
+sagittarius_gateway = []
+sagittarius_rails = []
 velorum = []
-all = ["aquila", "sagittarius", "velorum"]
+all = ["aquila", "sagittarius_gateway", "sagittarius_rails", "velorum"]
 
 [build-dependencies]
 tonic-prost-build = { version = "0.14.0" }

build/rust/src/lib.rs

@@ -11,10 +11,16 @@ pub mod aquila {
     include!("generated/aquila.serde.rs");
 }
 
-#[cfg(feature = "sagittarius")]
-pub mod sagittarius {
-    include!("generated/sagittarius.rs");
-    include!("generated/sagittarius.serde.rs");
+#[cfg(feature = "sagittarius_gateway")]
+pub mod sagittarius_gateway {
+    include!("generated/sagittarius_gateway.rs");
+    include!("generated/sagittarius_gateway.serde.rs");
+}
+
+#[cfg(feature = "sagittarius_rails")]
+pub mod sagittarius_rails {
+    include!("generated/sagittarius_rails.rs");
+    include!("generated/sagittarius_rails.serde.rs");
 }
 
 #[cfg(feature = "velorum")]

build/ts/package.json

@@ -16,10 +16,11 @@
   "scripts": {
     "build": "vite build",
     "generate:aquila": "protoc --ts_opt=add_pb_suffix  --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/aquila --proto_path=../../proto/shared ../../proto/aquila/*.proto",
-    "generate:sagittarius": "protoc --ts_opt=add_pb_suffix --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/sagittarius --proto_path=../../proto/shared ../../proto/sagittarius/*.proto",
+    "generate:sagittarius_gateway": "protoc --ts_opt=add_pb_suffix --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/sagittarius_gateway --proto_path=../../proto/shared ../../proto/sagittarius_gateway/*.proto",
+    "generate:sagittarius_rails": "protoc --ts_opt=add_pb_suffix --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/sagittarius_rails --proto_path=../../proto/shared ../../proto/sagittarius_rails/*.proto",
     "generate:velorum": "protoc --ts_opt=add_pb_suffix --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/velorum --proto_path=../../proto/shared ../../proto/velorum/*.proto",
     "generate:shared": "protoc --ts_opt=add_pb_suffix --ts_opt=generate_dependencies --ts_out=pb/_generated --proto_path=../../proto/shared ../../proto/shared/*.proto",
-    "generate": "npm run clean && npm run generate:shared && npm run generate:sagittarius && npm run generate:aquila && npm run generate:velorum && npm run generate:exports",
+    "generate": "npm run clean && npm run generate:shared && npm run generate:sagittarius_gateway && npm run generate:sagittarius_rails && npm run generate:aquila && npm run generate:velorum && npm run generate:exports",
     "generate:exports": "node scripts/generateExports.mjs",
     "clean": "rm -rf pb/_generated/*.js && rm -rf pb/_generated/*.ts && rm -rf helpers/*.js"
   },
@@ -48,10 +49,15 @@
       "import": "./dist/aquila.es.js",
       "require": "./dist/aquila.cjs.js"
     },
-    "./sagittarius": {
-      "types": "./dist/sagittarius.d.ts",
-      "import": "./dist/sagittarius.es.js",
-      "require": "./dist/sagittarius.cjs.js"
+    "./sagittarius_gateway": {
+      "types": "./dist/sagittarius_gateway.d.ts",
+      "import": "./dist/sagittarius_gateway.es.js",
+      "require": "./dist/sagittarius_gateway.cjs.js"
+    },
+     "./sagittarius_rails": {
+      "types": "./dist/sagittarius_rails.d.ts",
+      "import": "./dist/sagittarius_rails.es.js",
+      "require": "./dist/sagittarius_rails.cjs.js"
     },
     "./velorum": {
       "types": "./dist/velorum.d.ts",

build/ts/tsconfig.json

@@ -7,5 +7,5 @@
     "strict": true,
     "skipLibCheck": true
   },
-  "include": ["helpers", "pb", "pb/aquila.ts", "pb/shared.ts", "pb/sagittarius.ts"]
-}
+  "include": ["helpers", "pb", "pb/aquila.ts", "pb/shared.ts", "pb/sagittarius_gateway.ts", "pb/sagittarius_rails.ts", "pb/velorum.ts"]
+}

build/ts/vite.config.ts

@@ -11,7 +11,8 @@ export default defineConfig({
             entry: {
                 shared: resolve(__dirname, "pb/shared.ts"),
                 aquila: resolve(__dirname, "pb/aquila.ts"),
-                sagittarius: resolve(__dirname, "pb/sagittarius.ts"),
+                sagittarius_gateway: resolve(__dirname, "pb/sagittarius_gateway.ts"),
+                sagittarius_rails: resolve(__dirname, "pb/sagittarius_rails.ts"),
                 velorum: resolve(__dirname, "pb/velorum.ts"),
                 helpers: resolve(__dirname, "helpers/helpers.ts"),
             },
@@ -24,7 +25,8 @@ export default defineConfig({
             input: {
                 shared: resolve(__dirname, "pb/shared.ts"),
                 aquila: resolve(__dirname, "pb/aquila.ts"),
-                sagittarius: resolve(__dirname, "pb/sagittarius.ts"),
+                sagittarius_gateway: resolve(__dirname, "pb/sagittarius_gateway.ts"),
+                sagittarius_rails: resolve(__dirname, "pb/sagittarius_rails.ts"),
                 velorum: resolve(__dirname, "pb/velorum.ts"),
                 helpers: resolve(__dirname, "helpers/helpers.ts"),
             },
@@ -65,4 +67,4 @@ export default defineConfig({
             "@": resolve(__dirname, "src"),
         },
     },
-});
+});