xtask preprocess field

Author: RoDmitry

README.md

@@ -12,7 +12,7 @@ When updating or adding new parameters and endpoints, make changes directly in t
 Once your changes are merged, you can update this project as follows (you can also run tasks individually):
 
 ```bash
-cargo xtask fetch code-gen
+cargo xtask fetch preprocess code-gen
 ```
 
 This will:

preprocessed_openapi.yml

@@ -349,8 +349,8 @@ paths:
               x-go-type: interface{}
         required: true
         x-rust-type: B
-      x-rust-params-generic-parameter: <B>
       x-rust-generic-parameter: '<B: Serialize>'
+      x-rust-params-generic-parameter: <B>
     delete:
       tags:
       - documents
@@ -1257,8 +1257,6 @@ paths:
               x-go-type: interface{}
         required: true
         x-rust-type: B
-      x-rust-params-generic-parameter: <B>
-      x-rust-generic-parameter: '<B: Serialize>'
       responses:
         '200':
           description: The document referenced by the ID was updated
@@ -1273,6 +1271,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ApiResponse'
+      x-rust-generic-parameter: '<B: Serialize>'
+      x-rust-params-generic-parameter: <B>
     delete:
       tags:
       - documents

xtask/src/add_vendor_attributes.rs

@@ -62,5 +62,22 @@ pub fn add_vendor_attributes(doc_root: &mut Mapping) -> Result<(), String> {
         .supports_plain_text()
         .done()?;
 
+    attrs
+        .operation("/collections/{collectionName}/documents", "patch")
+        .generic_parameter("<B: Serialize>")
+        .params_generic_parameter("<B>")
+        .request_type("B")
+        .done()?;
+
+    attrs
+        .operation(
+            "/collections/{collectionName}/documents/{documentId}",
+            "patch",
+        )
+        .generic_parameter("<B: Serialize>")
+        .params_generic_parameter("<B>")
+        .request_type("B")
+        .done()?;
+
     Ok(())
 }

xtask/src/main.rs

@@ -32,10 +32,12 @@ struct Cli {
 #[derive(ValueEnum, Clone, Debug)]
 #[clap(rename_all = "kebab-case")] // Allows us to type `code-gen` instead of `CodeGen`
 enum Task {
-    /// Fetches the latest OpenAPI spec from [the Typesense repository](https://github.com/typesense/typesense-api-spec/blob/master/openapi.yml).
-    Fetch,
     /// Generates client code from the spec file using the Docker container.
     CodeGen,
+    /// Fetches the latest OpenAPI spec from [the Typesense repository](https://github.com/typesense/typesense-api-spec/blob/master/openapi.yml).
+    Fetch,
+    /// Preprocesses fetched OpenAPI spec file into a new one
+    Preprocess,
 }
 
 #[cfg(target_family = "wasm")]
@@ -48,16 +50,17 @@ fn main() -> Result<()> {
     for task in cli.tasks {
         println!("▶️  Running task: {:?}", task);
         match task {
-            Task::Fetch => task_fetch_api_spec()?,
             Task::CodeGen => task_codegen()?,
+            Task::Fetch => task_fetch_api_spec()?,
+            Task::Preprocess => preprocess_openapi_file(INPUT_SPEC_FILE, OUTPUT_PREPROCESSED_FILE)
+                .expect("Preprocess failed, aborting!"),
         }
     }
     Ok(())
 }
 
-#[cfg(not(target_family = "wasm"))]
 fn task_fetch_api_spec() -> Result<()> {
-    println!("▶️  Running codegen task...");
+    println!("▶️  Running fetch task...");
 
     println!("  - Downloading spec from {}", SPEC_URL);
     let response =
@@ -80,10 +83,6 @@ fn task_fetch_api_spec() -> Result<()> {
 /// Task to generate client code from the OpenAPI spec using a Docker container.
 fn task_codegen() -> Result<()> {
     println!("▶️  Running codegen task via Docker...");
-
-    println!("Preprocessing the Open API spec file...");
-    preprocess_openapi_file(INPUT_SPEC_FILE, OUTPUT_PREPROCESSED_FILE)
-        .expect("Preprocess failed, aborting!");
     // Get the absolute path to the project's root directory.
     // std::env::current_dir() gives us the directory from which `cargo xtask` was run.
     let project_root = env::current_dir().context("Failed to get current directory")?;

xtask/src/preprocess_openapi.rs

@@ -8,6 +8,7 @@ pub fn preprocess_openapi_file(
     input_path: &str,
     output_path: &str,
 ) -> Result<(), Box<dyn std::error::Error>> {
+    println!("Preprocessing the Open API spec file...");
     // --- Step 1: Read the OpenAPI spec from the input file ---
     println!("Reading OpenAPI spec from {}...", input_path);
     let input_content = fs::read_to_string(input_path)

xtask/src/vendor_attributes.rs

@@ -3,8 +3,19 @@ use serde_yaml::{Mapping, Value};
 /// Where to apply a vendor (x-*) attribute.
 pub enum VendorLocation<'a> {
     Schema(&'a str),
-    SchemaField { schema: &'a str, field: &'a str },
-    Operation { path: &'a str, method: &'a str },
+    SchemaField {
+        schema: &'a str,
+        field: &'a str,
+    },
+    Operation {
+        path: &'a str,
+        method: &'a str,
+    },
+    OperationField {
+        path: &'a str,
+        method: &'a str,
+        field: &'a str,
+    },
 }
 
 /// Main helper struct that holds a mutable borrow of the OpenAPI root mapping.
@@ -86,6 +97,19 @@ impl<'a> VendorAttributes<'a> {
                 Self::insert_into_map(op_map, attr, val);
                 Ok(self)
             }
+            VendorLocation::OperationField {
+                path,
+                method,
+                field,
+            } => {
+                let field_map =
+                    self.get_map_mut(&["paths", path, method, field])
+                        .map_err(|_| {
+                            format!("operation field not found: {} {} {}", method, path, field)
+                        })?;
+                Self::insert_into_map(field_map, attr, val);
+                Ok(self)
+            }
         }
     }
 
@@ -166,13 +190,43 @@ impl<'a, 'b> OperationContext<'a, 'b> {
         }
     }
 
+    fn try_set_field(&mut self, field: &str, attr: &str, val: Value) {
+        if self.error.is_some() {
+            return;
+        }
+        if let Err(e) = self.vendor.set_attr(
+            VendorLocation::OperationField {
+                path: self.path,
+                method: self.method,
+                field,
+            },
+            attr,
+            val,
+        ) {
+            self.error = Some(e);
+        }
+    }
+
     pub fn generic_parameter(mut self, generic: &str) -> Self {
         self.try_set("x-rust-generic-parameter", Value::String(generic.into()));
         self
     }
 
-    pub fn return_type(mut self, rust_type: &str) -> Self {
-        self.try_set("x-rust-return-type", Value::String(rust_type.into()));
+    pub fn params_generic_parameter(mut self, generic: &str) -> Self {
+        self.try_set(
+            "x-rust-params-generic-parameter",
+            Value::String(generic.into()),
+        );
+        self
+    }
+
+    pub fn return_type(mut self, typ: &str) -> Self {
+        self.try_set("x-rust-return-type", Value::String(typ.into()));
+        self
+    }
+
+    pub fn request_type(mut self, typ: &str) -> Self {
+        self.try_set_field("requestBody", "x-rust-type", Value::String(typ.into()));
         self
     }