New ExecKclProject command

This command takes in a KCL project (which is a list of files, like a virtual filesystem directory) and returns the same Ok/Err result type that the frontend usually gets for KCL execution.

Internally, it validates the filepaths (to make sure they're all relative to the KCL project root), and uses types from the frontend, which have been moved into a kcl-api crate.

Author: adamchalmers

Cargo.lock

@@ -18,7 +18,7 @@ tabled = ["dep:tabled"]
 ts-rs = ["dep:ts-rs"]
 slog = ["dep:slog"]
 cxx = ["dep:cxx"]
-websocket = ["dep:serde_json"]
+websocket = []
 webrtc = ["dep:webrtc"]
 unstable_exhaustive = []
 python = ["dep:pyo3", "dep:pyo3-stub-gen"]
@@ -36,6 +36,7 @@ enum-iterator-derive = "1.2.1"
 euler = "0.4.1"
 http = "1.4.0"
 kittycad-modeling-cmds-macros = { workspace = true }
+kcl-api = { version = "0.2.161", git = "https://github.com/KittyCAD/modeling-app", branch = "achalmers/kcl-in-engine" }
 kittycad-unit-conversion-derive = "0.1.0"
 # Fork of <crates.io/crates/measurements>
 measurements = { package = "kittycad-measurements", version = "0.11.2" }
@@ -50,7 +51,7 @@ pyo3-stub-gen = { version = "0.22.3", optional = true, default-features = false,
 schemars = { version = "0.8.22", features = ["bigdecimal04", "chrono", "url", "uuid1"] }
 serde = { version = "1.0.219", features = ["derive"] }
 serde_bytes = "0.11.19"
-serde_json = { version = "1.0.150", optional = true }
+serde_json = "1.0.150"
 slog = { version = "2.8.2", optional = true }
 tabled = { version = "0.20", optional = true }
 ts-rs = { version = "12.0.1", optional = true, features = ["chrono-impl", "uuid-impl", "no-serde-warnings", "serde-json-impl"] }

modeling-cmds/Cargo.toml

@@ -1,18 +1,83 @@
 use bon::Builder;
 use schemars::JsonSchema;
-use serde::Deserialize;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
+use crate::shared::safe_filepath::SafeFilepath;
+
+/// A KCL project that can be executed.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Default, Builder)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
 #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
-pub struct ExecKclProjectOk {}
+pub struct KclProject {
+    /// All files in the project.
+    pub files: Vec<KclFile>,
+    /// Which file is the entrypoint?
+    /// This is the first KCL file to be executed,
+    /// the root of the KCL module tree.
+    pub entrypoint: SafeFilePath,
+}
 
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
+/// Region-creation algorithm version.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Default, Builder)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
 #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
-pub struct ExecKclProjectErr {}
+pub struct KclFile {
+    /// Where is the file, relative to the project directory?
+    pub path: SafeFilepath,
+    /// Contents of the file, as UTF-8 encoded bytes.
+    #[serde(deserialize_with = "serde_bytes::deserialize")]
+    #[serde(serialize_with = "serde_bytes::serialize")]
+    pub contents: Vec<u8>,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+/// Successful KCL project execution response.
+pub struct ExecKclProjectOk {
+    /// Scene graph updates and execution metadata produced by running the KCL project.
+    pub scene_graph_delta:
+        kcl_api::SceneGraphDelta<kcl_api::SceneGraph<serde_json::Value, serde_json::Value>, serde_json::Value>,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+/// Failed KCL project execution response.
+pub struct ExecKclProjectErr {
+    /// Error produced while executing the KCL project.
+    pub error: kcl_api::Error,
+}
+
+#[cfg(feature = "arbitrary")]
+// TODO: Impl this properly for fuzzing.
+impl<'a> arbitrary::Arbitrary<'a> for ExecKclProjectOk {
+    fn arbitrary(_u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
+        Ok(Self {
+            scene_graph_delta: kcl_api::SceneGraphDelta::new(
+                kcl_api::SceneGraph::empty(kcl_api::ProjectId(0), kcl_api::FileId(0), kcl_api::Version(0)),
+                Vec::new(),
+                false,
+                serde_json::Value::Null,
+            ),
+        })
+    }
+}
+
+#[cfg(feature = "arbitrary")]
+// TODO: Impl this properly for fuzzing.
+impl<'a> arbitrary::Arbitrary<'a> for ExecKclProjectErr {
+    fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
+        Ok(Self {
+            error: kcl_api::Error {
+                msg: <String as arbitrary::Arbitrary>::arbitrary(u)?,
+            },
+        })
+    }
+}

modeling-cmds/src/exec_kcl.rs

@@ -12,12 +12,11 @@ use crate::{
     def_enum::negative_one,
     length_unit::LengthUnit,
     output::ExtrusionFaceInfo,
-    shared::safe_filepath::SafeFilepath,
     units::{self, UnitAngle},
 };
 
 mod point;
-mod safe_filepath;
+pub mod safe_filepath;
 
 /// An edge can be referenced by its uuid or by the faces that uniquely define it.
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
@@ -2184,29 +2183,3 @@ impl From<BodiesUpdated> for BodiesCreated {
 fn one() -> f32 {
     1.0
 }
-
-/// A KCL project that can be executed.
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Default, Builder)]
-#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
-#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
-pub struct KclProject {
-    /// All files in the project.
-    files: Vec<KclFile>,
-}
-
-/// Region-creation algorithm version.
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Default, Builder)]
-#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
-#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
-pub struct KclFile {
-    /// Where is the file, relative to the project directory?
-    pub path: SafeFilepath,
-    /// Contents of the file, as UTF-8 encoded bytes.
-    #[serde(deserialize_with = "serde_bytes::deserialize")]
-    #[serde(serialize_with = "serde_bytes::serialize")]
-    pub contents: Vec<u8>,
-}