Add more fields to KCL execution responses

Cargo.toml

@@ -27,8 +27,8 @@ syn = "3.0.3"
 
 [patch.crates-io]
 kittycad-unit-conversion-derive = { path = "unit-conversion-derive" }
-# kcl-api = { git = "https://github.com/KittyCAD/modeling-app", branch = "main" }
-# kcl-error = { git = "https://github.com/KittyCAD/modeling-app", branch = "main" }
+kcl-api = { git = "https://github.com/KittyCAD/modeling-app", branch = "achalmers/kcl-193-beta1" }
+kcl-error = { git = "https://github.com/KittyCAD/modeling-app", branch = "achalmers/kcl-193-beta1" }
 
 [profile.bench]
 debug = true

modeling-cmds/openapi/api.json

@@ -2577,11 +2577,11 @@
         ]
       },
       "KclFile": {
-        "description": "Region-creation algorithm version.",
+        "description": "A file uploaded with a KCL project.",
         "type": "object",
         "properties": {
           "contents": {
-            "description": "Contents of the file, as UTF-8 encoded bytes.",
+            "description": "Raw file contents. KCL source is UTF-8; imported assets may be binary.",
             "type": "array",
             "items": {
               "type": "integer",

modeling-cmds/src/exec_kcl.rs

@@ -2,7 +2,7 @@ use bon::Builder;
 use indexmap::IndexMap;
 #[cfg(feature = "websocket")]
 use kcl_api::artifact::ArtifactGraph;
-use kcl_api::{kcl_value_view::KclValueView, DefaultPlanes};
+use kcl_api::{kcl_value_view::KclValueView, DefaultPlanes, Object};
 use kcl_error::{CompilationIssue, KclError};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -31,7 +31,7 @@ impl KclProject {
     }
 }
 
-/// Region-creation algorithm version.
+/// A file uploaded with a KCL project.
 #[derive(Clone, PartialEq, Serialize, Deserialize, JsonSchema, Default, Builder)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
@@ -40,7 +40,7 @@ impl KclProject {
 pub struct KclFile {
     /// Where is the file, relative to the project directory?
     pub path: SafeFilepath,
-    /// Contents of the file, as UTF-8 encoded bytes.
+    /// Raw file contents. KCL source is UTF-8; imported assets may be binary.
     #[serde(
         serialize_with = "serde_bytes::serialize",
         deserialize_with = "serde_bytes::deserialize"
@@ -83,6 +83,10 @@ pub struct ExecKclProjectOk {
     pub issues: Vec<CompilationIssue>,
     /// IDs of the standard planes created for this execution.
     pub default_planes: Option<Box<DefaultPlanes>>,
+    /// All objects in all sketches.
+    pub scene_objects: Vec<Object>,
+    /// Which module ID was assigned to each KCL file in the project?
+    pub filenames: IndexMap<kcl_error::ModuleId, kcl_api::modules::ModulePath>,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, Builder)]
@@ -106,20 +110,26 @@ pub struct ExecKclProjectErr {
     pub artifact_graph: ArtifactGraph,
     /// IDs of the standard planes created before execution failed.
     pub default_planes: Option<Box<DefaultPlanes>>,
-    // TODO: Add fields to this as we make KCL data serializable.
-    // Should be a usable subset of `KclErrorWithOutputs`.
+    /// All objects in all sketches.
+    pub scene_objects: Vec<Object>,
+    /// Which module ID was assigned to each KCL file in the project?
+    pub filenames: IndexMap<kcl_error::ModuleId, kcl_api::modules::ModulePath>,
 }
 
 impl ExecKclProjectErr {
-    /// Used when the project execution had a fatal error.
-    pub fn fatal_error(error: KclError) -> Self {
+    /// Be careful using this. If you have executed a KCL program,
+    /// you should be building the full ExecKclProjectErr via its `build()`
+    /// method. This is only for errors that happen before execution.
+    pub fn error_before_execution(error: KclError) -> Self {
         Self {
             error: Some(error),
             non_fatal: Default::default(),
             operations: Default::default(),
             variables: Default::default(),
             artifact_graph: Default::default(),
             default_planes: Default::default(),
+            filenames: Default::default(),
+            scene_objects: Default::default(),
         }
     }
 }
@@ -137,6 +147,8 @@ impl<'a> arbitrary::Arbitrary<'a> for ExecKclProjectOk {
             #[cfg(feature = "websocket")]
             variables: Default::default(),
             default_planes: Default::default(),
+            filenames: Default::default(),
+            scene_objects: Default::default(),
         })
     }
 }
@@ -151,6 +163,8 @@ impl<'a> arbitrary::Arbitrary<'a> for ExecKclProjectErr {
             variables: Default::default(),
             artifact_graph: Default::default(),
             default_planes: Default::default(),
+            scene_objects: Default::default(),
+            filenames: Default::default(),
         })
     }
 }

modeling-cmds/src/websocket.rs

@@ -238,7 +238,7 @@ pub enum OkWebSocketResponseData {
     #[cfg(feature = "exec-kcl")]
     ExecKclProject {
         /// Result after executing KCL.
-        result: Result<crate::exec_kcl::ExecKclProjectOk, crate::exec_kcl::ExecKclProjectErr>,
+        result: Box<Result<crate::exec_kcl::ExecKclProjectOk, crate::exec_kcl::ExecKclProjectErr>>,
     },
 
     /// Request that the client end this connection and establish a new session