chore: use latest stable openapi-generator-cli

Turns out that the openapi-generator-cli npm crate is a whole major version behind (6 vs 7) of the openapi-generator jar. This change removes the usage of the npm package as it was only a wrapper for downloading the jar and running it. Now we have a simple bash script that uses that latest stable release of openapi-generator. This means we now have the fix for the extra .clone() calls and can enable -D warnings for test/example code not just the binary build.
ceramicnetwork · Jan 24, 2024 · c76b9b3 · c76b9b3
1 parent bc3ccea
commit c76b9b3
Show file tree

Hide file tree

Showing 21 changed files with 156 additions and 104 deletions.
diff --git a/.github/workflows/create-release-pr.yml b/.github/workflows/create-release-pr.yml
@@ -35,6 +35,5 @@ jobs:
       - run: |
           git config user.email "[email protected]"
           git config user.name "Github Automation"
-      - run: npm install @openapitools/[email protected] -g
       - name: Create release PR
         run: make RELEASE_LEVEL=${{ github.event.inputs.level }} release-pr
diff --git a/.github/workflows/rust-build-and-test.yml b/.github/workflows/rust-build-and-test.yml
@@ -44,7 +44,6 @@ jobs:
       run: make check-clippy
     - name: Check generated servers
       run: |
-        npm install @openapitools/[email protected] -g
         make check-api-server
         make check-kubo-rpc-server
   test:

diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@
 
 peer*
 sync_test.sh
+
+openapi-generator-cli.jar
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@
 # Therefore may be useful in ensuring a change
 # is ready to pass CI checks.
 
-RUSTFLAGS = --cfg tokio_unstable
+RUSTFLAGS = -D warnings --cfg tokio_unstable
 CARGO = RUSTFLAGS='${RUSTFLAGS}' cargo
 
 RELEASE_LEVEL ?= minor
@@ -55,7 +55,6 @@ check-kubo-rpc-server:
 	./ci-scripts/check_kubo_rpc_server.sh
 
 .PHONY: release
-release: RUSTFLAGS += -D warnings
 release:
 	$(CARGO) build -p ceramic-one --locked --release
 

diff --git a/api-server/.openapi-generator/VERSION b/api-server/.openapi-generator/VERSION
@@ -1 +1 @@
-6.6.0
+7.2.0
diff --git a/api-server/Cargo.toml b/api-server/Cargo.toml
@@ -35,6 +35,7 @@ mime = "0.3"
 
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
+validator = { version = "0.16", features = ["derive"] }
 
 # Crates included if required by the API definition
 

diff --git a/api-server/README.md b/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.9.0
-- Build date: 2024-01-17T12:46:40.618372865-07:00[America/Denver]
+- Build date: 2024-01-24T14:39:40.257161505-07:00[America/Denver]
 
 
 

diff --git a/api-server/examples/server/server.rs b/api-server/examples/server/server.rs
@@ -118,7 +118,6 @@ where
         event: models::Event,
         context: &C,
     ) -> Result<EventsPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "events_post({:?}) - X-Span-ID: {:?}",
             event,
@@ -129,7 +128,6 @@ where
 
     /// Test the liveness of the Ceramic node
     async fn liveness_get(&self, context: &C) -> Result<LivenessGetResponse, ApiError> {
-        let context = context.clone();
         info!("liveness_get() - X-Span-ID: {:?}", context.get().0.clone());
         Err(ApiError("Generic failure".into()))
     }
@@ -145,14 +143,12 @@ where
         limit: Option<f64>,
         context: &C,
     ) -> Result<SubscribeSortKeySortValueGetResponse, ApiError> {
-        let context = context.clone();
         info!("subscribe_sort_key_sort_value_get(\"{}\", \"{}\", {:?}, {:?}, {:?}, {:?}) - X-Span-ID: {:?}", sort_key, sort_value, controller, stream_id, offset, limit, context.get().0.clone());
         Err(ApiError("Generic failure".into()))
     }
 
     /// Get the version of the Ceramic node
     async fn version_post(&self, context: &C) -> Result<VersionPostResponse, ApiError> {
-        let context = context.clone();
         info!("version_post() - X-Span-ID: {:?}", context.get().0.clone());
         Err(ApiError("Generic failure".into()))
     }

diff --git a/api-server/src/models.rs b/api-server/src/models.rs
@@ -1,12 +1,14 @@
 #![allow(clippy::useless_vec)]
 #![allow(unused_qualifications)]
 
+use validator::Validate;
+
 #[cfg(any(feature = "client", feature = "server"))]
 use crate::header;
 use crate::models;
 
 /// A Ceramic event as part of a Ceramic Stream
-#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, validator::Validate)]
 #[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
 pub struct Event {
     /// Multibase encoding of event id bytes.
@@ -158,7 +160,7 @@ impl std::convert::TryFrom<hyper::header::HeaderValue> for header::IntoHeaderVal
 }
 
 /// Version of the Ceramic node in semver format, e.g. 2.1.0
-#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, validator::Validate)]
 #[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
 pub struct Version {
     /// Version of the Ceramic node
@@ -182,7 +184,7 @@ impl std::string::ToString for Version {
         let params: Vec<Option<String>> = vec![self
             .version
             .as_ref()
-            .map(|version| vec!["version".to_string(), version.to_string()].join(","))];
+            .map(|version| ["version".to_string(), version.to_string()].join(","))];
 
         params.into_iter().flatten().collect::<Vec<_>>().join(",")
     }

diff --git a/api-server/src/server/mod.rs b/api-server/src/server/mod.rs
@@ -420,9 +420,9 @@ where
                                                         CONTENT_TYPE,
                                                         HeaderValue::from_str("application/json")
                                                             .expect("Unable to create Content-Type header for SUBSCRIBE_SORT_KEY_SORT_VALUE_GET_SUCCESS"));
-                                let body = serde_json::to_string(&body)
+                                let body_content = serde_json::to_string(&body)
                                     .expect("impossible to fail to serialize");
-                                *response.body_mut() = Body::from(body);
+                                *response.body_mut() = Body::from(body_content);
                             }
                         },
                         Err(_) => {
@@ -461,9 +461,9 @@ where
                                                         CONTENT_TYPE,
                                                         HeaderValue::from_str("application/json")
                                                             .expect("Unable to create Content-Type header for VERSION_POST_SUCCESS"));
-                                let body = serde_json::to_string(&body)
+                                let body_content = serde_json::to_string(&body)
                                     .expect("impossible to fail to serialize");
-                                *response.body_mut() = Body::from(body);
+                                *response.body_mut() = Body::from(body_content);
                             }
                         },
                         Err(_) => {

diff --git a/ci-scripts/gen_api_server.sh b/ci-scripts/gen_api_server.sh
@@ -6,7 +6,7 @@ cd $DIR/..
 
 
 # Generate crate
-npx @openapitools/openapi-generator-cli \
+./ci-scripts/openapi-generator-cli.sh \
     generate \
     -i api/ceramic.yaml \
     -g rust-server  \

diff --git a/ci-scripts/gen_kubo_rpc_server.sh b/ci-scripts/gen_kubo_rpc_server.sh
@@ -8,7 +8,7 @@ cd $DIR/..
 
 
 # Generate crate
-npx @openapitools/openapi-generator-cli \
+./ci-scripts/openapi-generator-cli.sh \
     generate \
     -i kubo-rpc/kubo-rpc.yaml \
     -g rust-server  \

diff --git a/ci-scripts/openapi-generator-cli.sh b/ci-scripts/openapi-generator-cli.sh
@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+#
+# This script is a small wrapper to download the jar file for openapi-generator-cli and run it.
+
+VERSION='7.2.0'
+jar=openapi-generator-cli.jar
+
+if [ ! -f $jar ]
+then
+    wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/${VERSION}/openapi-generator-cli-${VERSION}.jar -O $jar
+fi
+
+java -ea                          \
+  -Xms512M                        \
+  -Xmx1024M                       \
+  -server                         \
+  -jar ./${jar} "$@"
diff --git a/kubo-rpc-server/.openapi-generator/VERSION b/kubo-rpc-server/.openapi-generator/VERSION
@@ -1 +1 @@
-6.6.0
+7.2.0
diff --git a/kubo-rpc-server/Cargo.toml b/kubo-rpc-server/Cargo.toml
@@ -39,6 +39,7 @@ mime = "0.3"
 
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
+validator = { version = "0.16", features = ["derive"] }
 
 # Crates included if required by the API definition
 mime_0_2 = { package = "mime", version = "0.2.6", optional = true }

diff --git a/kubo-rpc-server/README.md b/kubo-rpc-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.9.0
-- Build date: 2024-01-17T12:46:50.987533413-07:00[America/Denver]
+- Build date: 2024-01-24T14:39:45.959361295-07:00[America/Denver]
 
 
 

diff --git a/kubo-rpc-server/examples/server/server.rs b/kubo-rpc-server/examples/server/server.rs
@@ -122,7 +122,6 @@ where
         offline: Option<bool>,
         context: &C,
     ) -> Result<BlockGetPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "block_get_post(\"{}\", {:?}, {:?}) - X-Span-ID: {:?}",
             arg,
@@ -142,7 +141,6 @@ where
         pin: Option<bool>,
         context: &C,
     ) -> Result<BlockPutPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "block_put_post({:?}, {:?}, {:?}, {:?}) - X-Span-ID: {:?}",
             file,
@@ -160,7 +158,6 @@ where
         arg: String,
         context: &C,
     ) -> Result<BlockStatPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "block_stat_post(\"{}\") - X-Span-ID: {:?}",
             arg,
@@ -176,7 +173,6 @@ where
         output_codec: Option<models::Codecs>,
         context: &C,
     ) -> Result<DagGetPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "dag_get_post(\"{}\", {:?}) - X-Span-ID: {:?}",
             arg,
@@ -192,7 +188,6 @@ where
         file: swagger::ByteArray,
         context: &C,
     ) -> Result<DagImportPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "dag_import_post({:?}) - X-Span-ID: {:?}",
             file,
@@ -209,7 +204,6 @@ where
         input_codec: Option<models::Codecs>,
         context: &C,
     ) -> Result<DagPutPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "dag_put_post({:?}, {:?}, {:?}) - X-Span-ID: {:?}",
             file,
@@ -226,7 +220,6 @@ where
         arg: String,
         context: &C,
     ) -> Result<DagResolvePostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "dag_resolve_post(\"{}\") - X-Span-ID: {:?}",
             arg,
@@ -237,7 +230,6 @@ where
 
     /// Report identifying information about a node
     async fn id_post(&self, arg: Option<String>, context: &C) -> Result<IdPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "id_post({:?}) - X-Span-ID: {:?}",
             arg,
@@ -254,7 +246,6 @@ where
         progress: Option<bool>,
         context: &C,
     ) -> Result<PinAddPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "pin_add_post(\"{}\", {:?}, {:?}) - X-Span-ID: {:?}",
             arg,
@@ -267,7 +258,6 @@ where
 
     /// Remove a block from the pin store
     async fn pin_rm_post(&self, arg: String, context: &C) -> Result<PinRmPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "pin_rm_post(\"{}\") - X-Span-ID: {:?}",
             arg,
@@ -282,7 +272,6 @@ where
         arg: &Vec<String>,
         context: &C,
     ) -> Result<SwarmConnectPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "swarm_connect_post({:?}) - X-Span-ID: {:?}",
             arg,
@@ -293,7 +282,6 @@ where
 
     /// Report connected peers
     async fn swarm_peers_post(&self, context: &C) -> Result<SwarmPeersPostResponse, ApiError> {
-        let context = context.clone();
         info!(
             "swarm_peers_post() - X-Span-ID: {:?}",
             context.get().0.clone()
@@ -303,7 +291,6 @@ where
 
     /// Report server version
     async fn version_post(&self, context: &C) -> Result<VersionPostResponse, ApiError> {
-        let context = context.clone();
         info!("version_post() - X-Span-ID: {:?}", context.get().0.clone());
         Err(ApiError("Generic failure".into()))
     }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,3 +8,5 @@

		peer*
		sync_test.sh

		openapi-generator-cli.jar