fix: return null instead of an empty string when data isn't included …

…for event response

api-server/README.md

@@ -15,7 +15,7 @@ To see how to make this your own, look here:
 [README]((https://openapi-generator.tech))
 
 - API version: 0.25.0
-- Build date: 2024-06-26T12:32:38.465059-06:00[America/Denver]
+- Build date: 2024-06-26T12:41:21.980959-06:00[America/Denver]
 
 
 

api-server/api/openapi.yaml

@@ -436,7 +436,6 @@ components:
           description: Multibase encoding of event data.
           type: string
       required:
-      - data
       - id
       title: A Ceramic Event
       type: object

api-server/docs/Event.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Multibase encoding of event root CID bytes. | 
-**data** | **String** | Multibase encoding of event data. | 
+**data** | **String** | Multibase encoding of event data. | [optional] [default to None]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

api-server/src/models.rs

@@ -287,13 +287,14 @@ pub struct Event {
 
     /// Multibase encoding of event data.
     #[serde(rename = "data")]
-    pub data: String,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub data: Option<String>,
 }
 
 impl Event {
     #[allow(clippy::new_without_default)]
-    pub fn new(id: String, data: String) -> Event {
-        Event { id, data }
+    pub fn new(id: String) -> Event {
+        Event { id, data: None }
     }
 }
 
@@ -305,8 +306,9 @@ impl std::string::ToString for Event {
         let params: Vec<Option<String>> = vec![
             Some("id".to_string()),
             Some(self.id.to_string()),
-            Some("data".to_string()),
-            Some(self.data.to_string()),
+            self.data
+                .as_ref()
+                .map(|data| ["data".to_string(), data.to_string()].join(",")),
         ];
 
         params.into_iter().flatten().collect::<Vec<_>>().join(",")
@@ -374,11 +376,7 @@ impl std::str::FromStr for Event {
                 .into_iter()
                 .next()
                 .ok_or_else(|| "id missing in Event".to_string())?,
-            data: intermediate_rep
-                .data
-                .into_iter()
-                .next()
-                .ok_or_else(|| "data missing in Event".to_string())?,
+            data: intermediate_rep.data.into_iter().next(),
         })
     }
 }

api/ceramic.yaml

@@ -402,7 +402,6 @@ components:
       type: object
       required:
         - id
-        - data
       properties:
         id:
           type: string

api/src/server.rs

@@ -63,14 +63,13 @@ const INSERT_REQUEST_TIMEOUT: std::time::Duration = std::time::Duration::from_se
 // Helper to build responses consistent as we can't implement for the api_server::models directly
 pub struct BuildResponse {}
 impl BuildResponse {
-    pub fn event(id: Cid, data: Vec<u8>) -> models::Event {
+    pub fn event(id: Cid, data: Option<Vec<u8>>) -> models::Event {
         let id = id.to_string();
-        let data = if data.is_empty() {
-            String::default()
-        } else {
-            multibase::encode(multibase::Base::Base64, data)
-        };
-        models::Event::new(id, data)
+        let mut res = models::Event::new(id);
+        if data.as_ref().map_or(false, |e| !e.is_empty()) {
+            res.data = Some(multibase::encode(multibase::Base::Base64, data.unwrap()));
+        }
+        res
     }
 }
 
@@ -196,12 +195,12 @@ impl EventInsertResult {
 pub struct EventDataResult {
     /// The CID of the event
     pub id: ceramic_core::Cid,
-    /// The data as a car file
-    pub data: Vec<u8>,
+    /// The data as a car file. Can be none if not requested.
+    pub data: Option<Vec<u8>>,
 }
 
 impl EventDataResult {
-    pub fn new(id: ceramic_core::Cid, data: Vec<u8>) -> Self {
+    pub fn new(id: ceramic_core::Cid, data: Option<Vec<u8>>) -> Self {
         Self { id, data }
     }
 }
@@ -548,7 +547,7 @@ where
             .await
             .map_err(|err| ErrorResponse::new(format!("failed to get keys: {err}")))?
             .into_iter()
-            .map(|(id, data)| BuildResponse::event(id, data))
+            .map(|(id, data)| BuildResponse::event(id, Some(data)))
             .collect::<Vec<_>>();
 
         let event_cnt = events.len();
@@ -671,7 +670,7 @@ where
         };
         match data {
             Ok(Some(data)) => {
-                let event = BuildResponse::event(cid, data);
+                let event = BuildResponse::event(cid, Some(data));
                 Ok(EventsEventIdGetResponse::Success(event))
             }
             Ok(None) => Ok(EventsEventIdGetResponse::EventNotFound(format!(

api/src/tests.rs

@@ -520,7 +520,7 @@ async fn get_events_for_interest_range() {
     r: Success(EventsGet { events: [Event { id: "fce0105ff012616e0f0c1e987ef0f772afbe2c7f05c50102bc800", data: "" }], resume_offset: 1, is_complete: false })
             */
     let mock_interest = MockAccessInterestStoreTest::new();
-    let expected = BuildResponse::event(cid, vec![]);
+    let expected = BuildResponse::event(cid, None);
     let mut mock_event_store = MockEventStoreTest::new();
     mock_event_store
         .expect_range_with_values()
@@ -589,7 +589,7 @@ async fn test_events_event_id_get_by_event_id_success() {
         event.id,
         multibase::encode(multibase::Base::Base32Lower, event_cid.to_bytes())
     );
-    assert_eq!(event.data, event_data_base64);
+    assert_eq!(event.data.unwrap(), event_data_base64);
 }
 
 #[test(tokio::test)]
@@ -619,5 +619,5 @@ async fn test_events_event_id_get_by_cid_success() {
         event.id,
         multibase::encode(multibase::Base::Base32Lower, event_cid.to_bytes())
     );
-    assert_eq!(event.data, event_data_base64);
+    assert_eq!(event.data.unwrap(), event_data_base64);
 }

service/src/event/store.rs

@@ -162,7 +162,7 @@ impl ceramic_api::EventStore for CeramicEventService {
                     CeramicOneEvent::new_events_since_value(&self.pool, highwater, limit).await?;
                 let res = cids
                     .into_iter()
-                    .map(|cid| ceramic_api::EventDataResult::new(cid, vec![]))
+                    .map(|cid| ceramic_api::EventDataResult::new(cid, None))
                     .collect();
                 (hw, res)
             }
@@ -174,7 +174,7 @@ impl ceramic_api::EventStore for CeramicEventService {
                 for (cid, value) in data {
                     res.push(ceramic_api::EventDataResult::new(
                         cid,
-                        value.encode_car().await?,
+                        Some(value.encode_car().await?),
                     ));
                 }
                 (hw, res)