From da692684f3dbdfbeedfad24854a05c0ed07dde1d Mon Sep 17 00:00:00 2001
From: Miguel Fernandez <miguel@mff.io>
Date: Tue, 28 Nov 2023 18:38:45 +0100
Subject: [PATCH] Document Restartable

---
 .../connector-test-kit-rs/query-tests-setup/Cargo.toml        | 2 +-
 .../src/connector_tag/js/external_process.rs                  | 4 ++++
 query-engine/query-engine-wasm/Cargo.toml                     | 2 +-
 3 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/query-engine/connector-test-kit-rs/query-tests-setup/Cargo.toml b/query-engine/connector-test-kit-rs/query-tests-setup/Cargo.toml
index 63bae3c1417..c3a5a43b9a7 100644
--- a/query-engine/connector-test-kit-rs/query-tests-setup/Cargo.toml
+++ b/query-engine/connector-test-kit-rs/query-tests-setup/Cargo.toml
@@ -33,7 +33,7 @@ indexmap = { version = "1.0", features = ["serde-1"] }
 query-engine-metrics = {path = "../../metrics"}
 quaint.workspace = true
 jsonrpc-core = "17"
-futures = "0.3" 
+futures = "0.3"
 
 # Only this version is vetted, upgrade only after going through the code,
 # as this is a small crate with little user base.
diff --git a/query-engine/connector-test-kit-rs/query-tests-setup/src/connector_tag/js/external_process.rs b/query-engine/connector-test-kit-rs/query-tests-setup/src/connector_tag/js/external_process.rs
index 96781c4e836..9b3934cde7b 100644
--- a/query-engine/connector-test-kit-rs/query-tests-setup/src/connector_tag/js/external_process.rs
+++ b/query-engine/connector-test-kit-rs/query-tests-setup/src/connector_tag/js/external_process.rs
@@ -97,6 +97,10 @@ impl ExecutorProcess {
     }
 }
 
+/// Wraps an ExecutorProcess allowing for restarting it.
+///
+/// A node process can die for a number of reasons, being one that any `panic!` occurring in Rust
+/// asynchronous code are translated to an abort trap by wasm-bindgen, which kills the node process.
 #[derive(Clone)]
 pub(crate) struct RestartableExecutorProcess {
     p: Arc<Mutex<ExecutorProcess>>,
diff --git a/query-engine/query-engine-wasm/Cargo.toml b/query-engine/query-engine-wasm/Cargo.toml
index 175f47a01ae..06738c45670 100644
--- a/query-engine/query-engine-wasm/Cargo.toml
+++ b/query-engine/query-engine-wasm/Cargo.toml
@@ -6,7 +6,7 @@ edition = "2021"
 [lib]
 doc = false
 crate-type = ["cdylib"]
-name = "query_engine"
+name = "query_engine_wasm"
 
 [dependencies]