feat: recon-over-http (#168)

* feat: recon-over-http * feat: struct HashCount * fix: review comments and minor refactor * fix: metrics for api * fix: incorporate review comments --------- Co-authored-by: Aaron D Goldman <[email protected]>
ceramicnetwork · Jan 11, 2024 · 28d8dd3 · 28d8dd3
1 parent 3a418bb
commit 28d8dd3
Show file tree

Hide file tree

Showing 36 changed files with 944 additions and 185 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -102,7 +102,7 @@ lru = "0.10"
 mime = "0.3"
 mime_classifier = "0.0.1"
 mime_guess = "2.0.4"
-minicbor = { version = "0.19.1", features = ["alloc", "std"] }
+minicbor = { version = "0.19.1", features = ["std", "derive", "half"] }
 mockall = "0.11.4"
 multiaddr = "0.18"
 multibase = "0.9"
@@ -134,6 +134,7 @@ ruzstd = "0.3"
 serde = { version = "1.0", features = ["derive"] }
 serde-error = "0.1.2"
 serde_bytes = "0.11"
+serde_cbor = "0.11.2"
 serde_ipld_dagcbor = "0.3"
 serde_json = "1.0.87"
 serde_qs = "0.10.1"

diff --git a/api-server/.openapi-generator/FILES b/api-server/.openapi-generator/FILES
@@ -4,6 +4,7 @@ Cargo.toml
 README.md
 api/openapi.yaml
 docs/Event.md
+docs/Ring.md
 docs/Version.md
 docs/default_api.md
 examples/ca.pem

diff --git a/api-server/README.md b/api-server/README.md
@@ -100,13 +100,15 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [****](docs/default_api.md#) | **POST** /events | Creates a new event
 [****](docs/default_api.md#) | **GET** /liveness | Test the liveness of the Ceramic node
+[****](docs/default_api.md#) | **POST** /recon | Sends a Recon message
 [****](docs/default_api.md#) | **GET** /subscribe/{sort_key}/{sort_value} | Get events for a stream
 [****](docs/default_api.md#) | **POST** /version | Get the version of the Ceramic node
 
 
 ## Documentation For Models
 
  - [Event](docs/Event.md)
+ - [Ring](docs/Ring.md)
  - [Version](docs/Version.md)
 
 

diff --git a/api-server/api/openapi.yaml b/api-server/api/openapi.yaml
@@ -96,6 +96,28 @@ paths:
         "204":
           description: success
       summary: Creates a new event
+  /recon:
+    post:
+      parameters:
+      - description: Recon ring
+        explode: true
+        in: query
+        name: ring
+        required: true
+        schema:
+          $ref: '#/components/schemas/Ring'
+        style: form
+      requestBody:
+        $ref: '#/components/requestBodies/Message'
+      responses:
+        "200":
+          content:
+            application/cbor-seq:
+              schema:
+                format: binary
+                type: string
+          description: success
+      summary: Sends a Recon message
 components:
   requestBodies:
     Event:
@@ -105,6 +127,14 @@ components:
             $ref: '#/components/schemas/Event'
       description: Event to add to the node
       required: true
+    Message:
+      content:
+        application/cbor-seq:
+          schema:
+            format: byte
+            type: string
+      description: Recon message to send
+      required: true
   schemas:
     Version:
       description: "Version of the Ceramic node in semver format, e.g. 2.1.0"
@@ -120,10 +150,15 @@ components:
         eventId: eventId
       properties:
         eventId:
-          description: Multibase encodeding of event id bytes.
+          description: Multibase encoding of event id bytes.
           type: string
       required:
       - eventId
       title: A Ceramic Event
       type: object
+    Ring:
+      enum:
+      - interest
+      - model
+      type: string
 
diff --git a/api-server/docs/Event.md b/api-server/docs/Event.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**event_id** | **String** | Multibase encodeding of event id bytes. | 
+**event_id** | **String** | Multibase encoding of event id bytes. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/api-server/docs/Message.md b/api-server/docs/Message.md
@@ -0,0 +1,10 @@
+# Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**msg** | [***swagger::ByteArray**](file.md) | CBOR payload of Recon message | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/api-server/docs/Ring.md b/api-server/docs/Ring.md
@@ -0,0 +1,9 @@
+# Ring
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/api-server/docs/default_api.md b/api-server/docs/default_api.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 ****](default_api.md#) | **POST** /events | Creates a new event
 ****](default_api.md#) | **GET** /liveness | Test the liveness of the Ceramic node
+****](default_api.md#) | **POST** /recon | Sends a Recon message
 ****](default_api.md#) | **GET** /subscribe/{sort_key}/{sort_value} | Get events for a stream
 ****](default_api.md#) | **POST** /version | Get the version of the Ceramic node
 
@@ -57,6 +58,32 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# ****
+> swagger::ByteArray (ring, body)
+Sends a Recon message
+
+### Required Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+  **ring** | [****](.md)| Recon ring | 
+  **body** | **swagger::ByteArray**| Recon message to send | 
+
+### Return type
+
+[**swagger::ByteArray**](file.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/cbor-seq
+ - **Accept**: application/cbor-seq
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # ****
 > Vec<models::Event> (sort_key, sort_value, optional)
 Get events for a stream

diff --git a/api-server/examples/client/main.rs b/api-server/examples/client/main.rs
@@ -3,7 +3,7 @@
 #[allow(unused_imports)]
 use ceramic_api_server::{
     models, Api, ApiNoContext, Client, ContextWrapperExt, EventsPostResponse, LivenessGetResponse,
-    SubscribeSortKeySortValueGetResponse, VersionPostResponse,
+    ReconPostResponse, SubscribeSortKeySortValueGetResponse, VersionPostResponse,
 };
 use clap::{App, Arg};
 #[allow(unused_imports)]
@@ -103,6 +103,15 @@ fn main() {
                 (client.context() as &dyn Has<XSpanIdString>).get().clone()
             );
         }
+        /* Disabled because there's no example.
+        Some("ReconPost") => {
+            let result = rt.block_on(client.recon_post(
+                  ???,
+                  swagger::ByteArray(Vec::from("BYTE_ARRAY_DATA_HERE"))
+            ));
+            info!("{:?} (X-Span-ID: {:?})", result, (client.context() as &dyn Has<XSpanIdString>).get().clone());
+        },
+        */
         Some("SubscribeSortKeySortValueGet") => {
             let result = rt.block_on(client.subscribe_sort_key_sort_value_get(
                 "sort_key_example".to_string(),