refactor: remove REST endpoints, openapi-generator-cli can't handle I…

…BC swagger

Cargo.toml

@@ -19,11 +19,15 @@ serde_json = "1.0.108"
 tokio = { version = "1.34.0", features = ["macros"] }
 tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.17", features = ["env-filter"] }
-haqq-rest = {path = "./rest"}
+# haqq-rest = {path = "./rest"}
 
 [workspace]
 
-members = [".", "haqq-build", "rest"]
+members = [
+".",
+"haqq-build",
+# "rest"
+]
 
 [features]
 default = ["proto_full"]

README.md

@@ -4,12 +4,15 @@ This repo contains RPC clients — generated with [buf.build](https://buf.bu
 
 ## Rust Client
 
-Rust client is fully functional, supports [gRPC](https://github.com/haqq-network/haqq-clients/blob/master/tests/grpc.rs) and [REST](https://github.com/haqq-network/haqq-clients/blob/master/tests/rest.rs) enpoints.
+Rust client is fully functional, supports [gRPC](https://github.com/haqq-network/haqq-clients/blob/master/tests/grpc.rs).
 
 Not published in crates yet but will be any time soon. In order to use, add to your project's `Cargo.toml`:
 
 * `haqq-proto = {git = "https://github.com/haqq-network/haqq-clients"}` — for gRPC endpoints
-* `haqq-rest = {git = "https://github.com/haqq-network/haqq-clients"}` — for REST endpoints
+
+**TODO**:
+
+- [ ] REST endpoints (openapi-generator-cli is very buggy for rust)
 
 ## TypeScript gRPC-Web Client
 

buf.gen.yaml

@@ -33,15 +33,15 @@ plugins:
       - include_file=src/gen/mod.rs
       - gen_crate
 
-  - plugin: buf.build/grpc-ecosystem/openapiv2:v2.18.1
-    out: openapi
-    # https://github.com/grpc-ecosystem/grpc-gateway/blob/main/protoc-gen-openapiv2/main.go
-    opt:
-      # - openapi_naming_strategy=simple
-      - allow_merge=true
-      # https://github.com/cosmos/cosmos-sdk/blob/main/proto/buf.gen.swagger.yaml
-      - fqn_for_openapi_name=true
-      - simple_operation_ids=true
+  # - plugin: buf.build/grpc-ecosystem/openapiv2:v2.18.1
+  #   out: openapi
+  #   # https://github.com/grpc-ecosystem/grpc-gateway/blob/main/protoc-gen-openapiv2/main.go
+  #   opt:
+  #     # - openapi_naming_strategy=simple
+  #     - allow_merge=true
+  #     # https://github.com/cosmos/cosmos-sdk/blob/main/proto/buf.gen.swagger.yaml
+  #     - fqn_for_openapi_name=true
+  #     - simple_operation_ids=true
 
   - plugin: buf.build/bufbuild/es:v1.3.1
     out: web/gen/proto/connect-web

buf.work.yaml

@@ -2,4 +2,3 @@ version: v1
 directories:
    - haqq-node/proto
    - cosmos-sdk/proto
-

haqq-build/src/main.rs

@@ -36,7 +36,6 @@ fn main() {
     std::mem::drop(f);
 
     apply_proto_patches(Path::new(PROTO_GEN_DIR));
-    apply_openapi_patches(Path::new(OPENAPI_SPEC_GEN_DIR));
 
     let stdout = Stdio::inherit();
     let stderr = Stdio::inherit();
@@ -45,41 +44,71 @@ fn main() {
         fs::remove_dir_all(OPENAPI_GEN_DIR).unwrap();
     }
 
-    let mut cmd = Command::new("openapi-generator-cli");
-    cmd.args([
-        "generate",
-        "-i",
-        &format!("{}/apidocs.swagger.json", OPENAPI_SPEC_GEN_DIR),
-        "-g",
-        "rust",
-        "-o",
-        OPENAPI_GEN_DIR,
-        "--skip-validate-spec",
-        "--package-name",
-        "haqq-rest",
-    ]);
-
-    cmd.stdout(stdout).stderr(stderr);
-
-    let output = cmd.output().unwrap();
-    assert!(output.status.success());
+    // let mut cmd = Command::new("openapi-generator-cli");
+    // cmd.args([
+    //     "generate",
+    //     "-i",
+    //     "haqq-node/client/docs/swagger-ui/swagger.json",
+    //     "-g",
+    //     "rust",
+    //     // "--enum-name-mappings",
+    //     // "Option=Opt,option=opt",
+    //     "-o",
+    //     OPENAPI_GEN_DIR,
+    //     "--skip-validate-spec",
+    //     "--package-name",
+    //     "haqq-rest",
+    // ]);
+
+    // cmd.stdout(stdout).stderr(stderr);
+
+    // let output = cmd.output().unwrap();
+    // assert!(output.status.success());
+
+    // apply_rest_patches();
 }
 
 // https://github.com/cosmos/cosmos-rust/blob/08353cb090aea4ad1569c5962a1a92d6327cd2d1/proto-build/src/main.rs#L396
 fn patch_file(path: impl AsRef<Path>, pattern: &Regex, replacement: &str) -> io::Result<()> {
     let mut contents = fs::read_to_string(&path)?;
     contents = pattern.replace_all(&contents, replacement).to_string();
-    fs::write(path, &contents)
+    fs::write(&path, &contents)
 }
 
-fn apply_openapi_patches(openapi_dir: &Path) {
-    patch_file(
-        openapi_dir.join("apidocs.swagger.json"),
-        &Regex::new("version not set").unwrap(),
-        OPENAPI_VERSION,
-    )
-    .expect("error patching apidocs.swagger.json");
-}
+// fn patch_files(paths: Vec<impl AsRef<Path>>, pattern: &Regex, replacement: &str) -> io::Result<()> {
+//     for path in paths {
+//         if let Err(e) = patch_file(path, pattern, replacement) {
+//             return Err(e);
+//         }
+//     }
+
+//     Ok(())
+// }
+
+// fn apply_rest_patches() {
+//     for (pattern, replacement) in [
+//         ("Option<", "core::option::Option<"),
+//         ("Option::is_", "core::option::Option::is_"),
+//     ] {
+//         // FIXME: figure out a way how to rename Option in enum
+//         // there is --enum-name-mappings option in openapi-generator-cli
+//         // but apparently it's currently only supported by java generators
+//         // patch_files(
+//         //     vec![
+//         //         "rest/src/models/cosmos_period_gov_period_v1_period_weighted_vote_option.rs",
+//         //         "rest/src/models/cosmos_period_gov_period_v1beta1_period_vote.rs",
+//         //         "rest/src/models/cosmos_period_gov_period_v1beta1_period_weighted_vote_option.rs",
+//         //         "rest/src/models/gov_v1_votes_200_response_votes_inner_options_inner.rs",
+//         //         "rest/src/models/votes_200_response_votes_inner_options_inner.rs",
+//         //         "rest/src/models/votes_200_response_votes_inner.rs",
+//         //         "rest/src/models/vote_200_response_vote.rs",
+//         //     ],
+//         //     &Regex::new(pattern).unwrap(),
+//         //     replacement,
+//         // )
+//         // .expect("error patching rest file");
+//     }
+// }
 
 /// Fix clashing type names in prost-generated code. See cosmos/cosmos-rust#154.
 fn apply_proto_patches(proto_dir: &Path) {