Clean up batch code (#2041)

* Clean up batch code

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* Remove 'flush_batch: bool' from send_modeling_cmd

It was always being set with false, and it was
bugged for true. If true was set, the cmd would
never actually be run.

* Fix derive-docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

src/wasm-lib/Cargo.lock

@@ -944,23 +944,6 @@ dependencies = [
  "syn 2.0.58",
 ]
 
-[[package]]
-name = "derive-docs"
-version = "0.1.12"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "138b94245509a9dd516008788b585c34847829cf37b40a758b4aa581cf94f147"
-dependencies = [
- "Inflector",
- "convert_case",
- "once_cell",
- "proc-macro2",
- "quote",
- "regex",
- "serde",
- "serde_tokenstream",
- "syn 2.0.58",
-]
-
 [[package]]
 name = "diesel_derives"
 version = "2.1.3"
@@ -1879,7 +1862,7 @@ dependencies = [
  "criterion",
  "dashmap",
  "databake",
- "derive-docs 0.1.12 (registry+https://github.com/rust-lang/crates.io-index)",
+ "derive-docs",
  "expectorate",
  "futures",
  "gltf-json",

src/wasm-lib/derive-docs/src/lib.rs

@@ -793,7 +793,6 @@ fn generate_code_block_test(
 
             ctx.engine
                 .send_modeling_cmd(
-                    false,
                     uuid::Uuid::new_v4(),
                     crate::executor::SourceRange::default(),
                     kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -809,7 +808,6 @@ fn generate_code_block_test(
             let resp = ctx
                 .engine
                 .send_modeling_cmd(
-                    false,
                     uuid::Uuid::new_v4(),
                     crate::executor::SourceRange::default(),
                     kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/array.gen

@@ -39,7 +39,6 @@ mod test_examples_show {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_show {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {
@@ -136,7 +134,6 @@ mod test_examples_show {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -163,7 +160,6 @@ mod test_examples_show {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/box.gen

@@ -39,7 +39,6 @@ mod test_examples_show {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_show {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/doc_comment_with_code.gen

@@ -39,7 +39,6 @@ mod test_examples_my_func {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_my_func {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {
@@ -136,7 +134,6 @@ mod test_examples_my_func {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -163,7 +160,6 @@ mod test_examples_my_func {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/doc_comment_with_code_on_ignored_function.gen

@@ -40,7 +40,6 @@ mod test_examples_import {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -67,7 +66,6 @@ mod test_examples_import {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {
@@ -138,7 +136,6 @@ mod test_examples_import {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -165,7 +162,6 @@ mod test_examples_import {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/lineTo.gen

@@ -39,7 +39,6 @@ mod test_examples_line_to {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_line_to {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {
@@ -136,7 +134,6 @@ mod test_examples_line_to {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -163,7 +160,6 @@ mod test_examples_line_to {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/min.gen

@@ -39,7 +39,6 @@ mod test_examples_min {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_min {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {
@@ -136,7 +134,6 @@ mod test_examples_min {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -163,7 +160,6 @@ mod test_examples_min {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/option.gen

@@ -39,7 +39,6 @@ mod test_examples_show {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_show {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/option_input_format.gen

@@ -39,7 +39,6 @@ mod test_examples_import {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_import {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/return_vec_box_sketch_group.gen

@@ -39,7 +39,6 @@ mod test_examples_import {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_import {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/return_vec_sketch_group.gen

@@ -39,7 +39,6 @@ mod test_examples_import {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_import {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/derive-docs/tests/show.gen

@@ -39,7 +39,6 @@ mod test_examples_show {
         let (x, y) = crate::std::utils::get_camera_zoom_magnitude_per_unit_length(units);
         ctx.engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -66,7 +65,6 @@ mod test_examples_show {
         let resp = ctx
             .engine
             .send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 crate::executor::SourceRange::default(),
                 kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/kcl/Cargo.toml

@@ -18,8 +18,7 @@ chrono = "0.4.37"
 clap = { version = "4.5.4", features = ["cargo", "derive", "env", "unicode"], optional = true }
 dashmap = "5.5.3"
 databake = { version = "0.1.7", features = ["derive"] }
-derive-docs = { version = "0.1.12" }
+derive-docs = { version = "0.1.12",  path = "../derive-docs" }
-#derive-docs = { path = "../derive-docs" }
 futures = { version = "0.3.30" }
 gltf-json = "1.4.0"
 kittycad = { workspace = true }

src/wasm-lib/kcl/src/ast/modify.rs

@@ -75,7 +75,6 @@ pub async fn modify_ast_for_sketch(
     // Let's get the path info.
     let resp = engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             SourceRange::default(),
             ModelingCmd::PathGetInfo { path_id: sketch_id },
@@ -100,7 +99,6 @@ pub async fn modify_ast_for_sketch(
     for segment in &path_info.segments {
         if let Some(command_id) = &segment.command_id {
             let h = engine.send_modeling_cmd(
-                false,
                 uuid::Uuid::new_v4(),
                 SourceRange::default(),
                 ModelingCmd::CurveGetControlPoints { curve_id: *command_id },

src/wasm-lib/kcl/src/engine/mod.rs

@@ -30,7 +30,6 @@ pub trait EngineManager: std::fmt::Debug + Send + Sync + 'static {
 
     async fn send_modeling_cmd(
         &self,
-        flush_batch: bool,
         id: uuid::Uuid,
         source_range: crate::executor::SourceRange,
         cmd: kittycad::types::ModelingCmd,
@@ -40,15 +39,12 @@ pub trait EngineManager: std::fmt::Debug + Send + Sync + 'static {
             cmd_id: id,
         };
 
-        if !flush_batch {
+        // Add cmd to the batch.
-            self.batch().lock().unwrap().push((req.clone(), source_range));
+        self.batch().lock().unwrap().push((req, source_range));
-        }
 
         // If the batch only has this one command that expects a return value,
         // fire it right away, or if we want to flush batch queue.
-        let is_sending = (is_cmd_with_return_values(&cmd) && self.batch().lock().unwrap().len() == 1)
+        let is_sending = is_cmd_with_return_values(&cmd);
-            || flush_batch
-            || is_cmd_with_return_values(&cmd);
 
         // Return a fake modeling_request empty response.
         if !is_sending {
@@ -73,17 +69,21 @@ pub trait EngineManager: std::fmt::Debug + Send + Sync + 'static {
             });
         }
 
-        let batched_requests = WebSocketRequest::ModelingCmdBatchReq {
+        let requests = self
-            requests: self.batch().lock().unwrap().iter().fold(vec![], |mut acc, (val, _)| {
+            .batch()
-                let WebSocketRequest::ModelingCmdReq { cmd, cmd_id } = val else {
+            .lock()
-                    return acc;
+            .unwrap()
-                };
+            .iter()
-                acc.push(kittycad::types::ModelingCmdReq {
+            .filter_map(|(val, _)| match val {
+                WebSocketRequest::ModelingCmdReq { cmd, cmd_id } => Some(kittycad::types::ModelingCmdReq {
                     cmd: cmd.clone(),
                     cmd_id: *cmd_id,
-                });
+                }),
-                acc
+                _ => None,
-            }),
+            })
+            .collect();
+        let batched_requests = WebSocketRequest::ModelingCmdBatchReq {
+            requests,
             batch_id: uuid::Uuid::new_v4(),
         };
 

src/wasm-lib/kcl/src/executor.rs

@@ -1004,7 +1004,6 @@ pub async fn execute_outer(
     // Before we even start executing the program, set the units.
     ctx.engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             SourceRange::default(),
             kittycad::types::ModelingCmd::SetSceneUnits {

src/wasm-lib/kcl/src/std/mod.rs

@@ -211,10 +211,7 @@ impl Args {
         id: uuid::Uuid,
         cmd: kittycad::types::ModelingCmd,
     ) -> Result<OkWebSocketResponseData, KclError> {
-        self.ctx
+        self.ctx.engine.send_modeling_cmd(id, self.source_range, cmd).await
-            .engine
-            .send_modeling_cmd(false, id, self.source_range, cmd)
-            .await
     }
 
     fn make_user_val_from_json(&self, j: serde_json::Value) -> Result<MemoryItem, KclError> {

src/wasm-lib/tests/executor/main.rs

@@ -47,7 +47,6 @@ async fn execute_and_snapshot(code: &str, units: kittycad::types::UnitLength) ->
 
     ctx.engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             kcl_lib::executor::SourceRange::default(),
             kittycad::types::ModelingCmd::DefaultCameraLookAt {
@@ -63,7 +62,6 @@ async fn execute_and_snapshot(code: &str, units: kittycad::types::UnitLength) ->
     let resp = ctx
         .engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             kcl_lib::executor::SourceRange::default(),
             kittycad::types::ModelingCmd::TakeSnapshot {

src/wasm-lib/tests/modify/main.rs

@@ -54,7 +54,6 @@ async fn setup(code: &str, name: &str) -> Result<(ExecutorContext, Program, uuid
     let plane_id = uuid::Uuid::new_v4();
     ctx.engine
         .send_modeling_cmd(
-            false,
             plane_id,
             SourceRange::default(),
             ModelingCmd::MakePlane {
@@ -73,7 +72,6 @@ async fn setup(code: &str, name: &str) -> Result<(ExecutorContext, Program, uuid
     // You can however get path info without sketch mode.
     ctx.engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             SourceRange::default(),
             ModelingCmd::SketchModeEnable {
@@ -89,7 +87,6 @@ async fn setup(code: &str, name: &str) -> Result<(ExecutorContext, Program, uuid
     // We can't get control points of an existing sketch without being in edit mode.
     ctx.engine
         .send_modeling_cmd(
-            false,
             uuid::Uuid::new_v4(),
             SourceRange::default(),
             ModelingCmd::EditModeEnter { target: sketch_id },