Move the wasm lib, and cleanup rust directory and all references (#5585)
* git mv src/wasm-lib rust Signed-off-by: Jess Frazelle <github@jessfraz.com> * mv wasm-lib to workspace Signed-off-by: Jess Frazelle <github@jessfraz.com> * mv kcl-lib Signed-off-by: Jess Frazelle <github@jessfraz.com> * mv derive docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * resolve file paths Signed-off-by: Jess Frazelle <github@jessfraz.com> * clippy Signed-off-by: Jess Frazelle <github@jessfraz.com> * move more shit Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix more paths Signed-off-by: Jess Frazelle <github@jessfraz.com> * make yarn build:wasm work Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix scripts Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * better references Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix cargo ci Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix reference Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix more ci Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * cargo sort Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix script Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fmt Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix a dep Signed-off-by: Jess Frazelle <github@jessfraz.com> * sort Signed-off-by: Jess Frazelle <github@jessfraz.com> * remove unused deps Signed-off-by: Jess Frazelle <github@jessfraz.com> * Revert "remove unused deps" This reverts commit fbabdb062e275fd5cbc1476f8480a1afee15d972. * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * deps; Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
GitHub
275
rust/kcl-lib/src/coredump/mod.rs
Normal file
275
rust/kcl-lib/src/coredump/mod.rs
Normal file
@ -0,0 +1,275 @@
|
||||
//! Core dump related structures and functions.
|
||||
#![allow(dead_code)]
|
||||
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
pub mod local;
|
||||
#[cfg(target_arch = "wasm32")]
|
||||
pub mod wasm;
|
||||
|
||||
use std::path::Path;
|
||||
|
||||
use anyhow::Result;
|
||||
use base64::Engine;
|
||||
use kittycad::Client;
|
||||
use schemars::JsonSchema;
|
||||
use serde::{Deserialize, Serialize};
|
||||
/// "Value" would be OK. This is imported as "JValue" throughout the rest of this crate.
|
||||
use serde_json::Value as JValue;
|
||||
use uuid::Uuid;
|
||||
|
||||
#[async_trait::async_trait(?Send)]
|
||||
pub trait CoreDump: Clone {
|
||||
/// Return the authentication token.
|
||||
fn token(&self) -> Result<String>;
|
||||
|
||||
fn base_api_url(&self) -> Result<String>;
|
||||
|
||||
fn version(&self) -> Result<String>;
|
||||
|
||||
fn kcl_code(&self) -> Result<String>;
|
||||
|
||||
fn pool(&self) -> Result<String>;
|
||||
|
||||
fn os(&self) -> Result<OsInfo>;
|
||||
|
||||
fn is_desktop(&self) -> Result<bool>;
|
||||
|
||||
async fn get_webrtc_stats(&self) -> Result<WebrtcStats>;
|
||||
|
||||
async fn get_client_state(&self) -> Result<JValue>;
|
||||
|
||||
/// Return a screenshot of the app.
|
||||
async fn screenshot(&self) -> Result<String>;
|
||||
|
||||
/// Get a screenshot of the app and upload it to public cloud storage.
|
||||
async fn upload_screenshot(&self, coredump_id: &Uuid, zoo_client: &Client) -> Result<String> {
|
||||
let screenshot = self.screenshot().await?;
|
||||
let cleaned = screenshot.trim_start_matches("data:image/png;base64,");
|
||||
|
||||
// Base64 decode the screenshot.
|
||||
let data = base64::engine::general_purpose::STANDARD.decode(cleaned)?;
|
||||
// Upload the screenshot.
|
||||
let links = zoo_client
|
||||
.meta()
|
||||
.create_debug_uploads(vec![kittycad::types::multipart::Attachment {
|
||||
name: "".to_string(),
|
||||
filename: Some(format!(r#"modeling-app/coredump-{coredump_id}-screenshot.png"#)),
|
||||
content_type: Some("image/png".to_string()),
|
||||
data,
|
||||
}])
|
||||
.await
|
||||
.map_err(|e| anyhow::anyhow!(e.to_string()))?;
|
||||
|
||||
if links.is_empty() {
|
||||
anyhow::bail!("Failed to upload screenshot");
|
||||
}
|
||||
|
||||
Ok(links[0].clone())
|
||||
}
|
||||
|
||||
/// Dump the app info.
|
||||
async fn dump(&self) -> Result<CoreDumpInfo> {
|
||||
// Create the zoo client.
|
||||
let mut zoo_client = kittycad::Client::new(self.token()?);
|
||||
zoo_client.set_base_url(&self.base_api_url()?);
|
||||
|
||||
let coredump_id = uuid::Uuid::new_v4();
|
||||
let client_state = self.get_client_state().await?;
|
||||
let webrtc_stats = self.get_webrtc_stats().await?;
|
||||
let os = self.os()?;
|
||||
let screenshot_url = self.upload_screenshot(&coredump_id, &zoo_client).await?;
|
||||
|
||||
let mut core_dump_info = CoreDumpInfo {
|
||||
id: coredump_id,
|
||||
version: self.version()?,
|
||||
git_rev: git_rev::try_revision_string!().map_or_else(|| "unknown".to_string(), |s| s.to_string()),
|
||||
timestamp: chrono::Utc::now(),
|
||||
desktop: self.is_desktop()?,
|
||||
kcl_code: self.kcl_code()?,
|
||||
os,
|
||||
webrtc_stats,
|
||||
github_issue_url: None,
|
||||
pool: self.pool()?,
|
||||
client_state,
|
||||
};
|
||||
|
||||
// pretty-printed JSON byte vector of the coredump.
|
||||
let data = serde_json::to_vec_pretty(&core_dump_info)?;
|
||||
|
||||
// Upload the coredump.
|
||||
let links = zoo_client
|
||||
.meta()
|
||||
.create_debug_uploads(vec![kittycad::types::multipart::Attachment {
|
||||
name: "".to_string(),
|
||||
filename: Some(format!(r#"modeling-app/coredump-{}.json"#, coredump_id)),
|
||||
content_type: Some("application/json".to_string()),
|
||||
data,
|
||||
}])
|
||||
.await
|
||||
.map_err(|e| anyhow::anyhow!(e.to_string()))?;
|
||||
|
||||
if links.is_empty() {
|
||||
anyhow::bail!("Failed to upload coredump");
|
||||
}
|
||||
|
||||
let coredump_url = &links[0];
|
||||
|
||||
core_dump_info.set_github_issue_url(&screenshot_url, coredump_url, &coredump_id)?;
|
||||
|
||||
Ok(core_dump_info)
|
||||
}
|
||||
}
|
||||
|
||||
/// The app info structure.
|
||||
/// The Core Dump Info structure.
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
||||
#[ts(export)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub struct CoreDumpInfo {
|
||||
/// The unique id for the core dump - this helps correlate uploaded files with coredump data.
|
||||
pub id: Uuid,
|
||||
/// The version of the app.
|
||||
pub version: String,
|
||||
/// The git revision of the app.
|
||||
pub git_rev: String,
|
||||
/// A timestamp of the core dump.
|
||||
#[ts(type = "string")]
|
||||
pub timestamp: chrono::DateTime<chrono::Utc>,
|
||||
/// If the app is running in desktop or the browser.
|
||||
pub desktop: bool,
|
||||
/// The os info.
|
||||
pub os: OsInfo,
|
||||
/// The webrtc stats.
|
||||
pub webrtc_stats: WebrtcStats,
|
||||
/// A GitHub issue url to report the core dump.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub github_issue_url: Option<String>,
|
||||
/// The kcl code the user is using.
|
||||
pub kcl_code: String,
|
||||
/// Engine pool the client is connected to.
|
||||
pub pool: String,
|
||||
/// The client state (singletons and xstate).
|
||||
pub client_state: JValue,
|
||||
}
|
||||
|
||||
impl CoreDumpInfo {
|
||||
/// Set the github issue url.
|
||||
pub fn set_github_issue_url(&mut self, screenshot_url: &str, coredump_url: &str, coredump_id: &Uuid) -> Result<()> {
|
||||
let coredump_filename = Path::new(coredump_url).file_name().unwrap().to_str().unwrap();
|
||||
let desktop_or_browser_label = if self.desktop { "desktop-app" } else { "browser" };
|
||||
let labels = ["coredump", "bug", desktop_or_browser_label];
|
||||
let mut body = format!(
|
||||
r#"[Add a title above and insert a description of the issue here]
|
||||
|
||||
|
||||
|
||||
> _Note: If you are capturing from a browser there is limited support for screenshots, only captures the modeling scene.
|
||||
If you are on MacOS native screenshots may be disabled by default. To enable native screenshots add Zoo Modeling App to System Settings -> Screen & SystemAudio Recording for native screenshots._
|
||||
|
||||
<details>
|
||||
<summary><b>Core Dump</b></summary>
|
||||
|
||||
[{coredump_filename}]({coredump_url})
|
||||
|
||||
Reference ID: {coredump_id}
|
||||
</details>
|
||||
"#
|
||||
);
|
||||
|
||||
// Add the kcl code if it exists.
|
||||
if !self.kcl_code.trim().is_empty() {
|
||||
body.push_str(&format!(
|
||||
r#"
|
||||
<details>
|
||||
<summary><b>KCL Code</b></summary>
|
||||
|
||||
```kcl
|
||||
{}
|
||||
```
|
||||
</details>
|
||||
"#,
|
||||
self.kcl_code
|
||||
));
|
||||
}
|
||||
|
||||
let urlencoded: String = form_urlencoded::byte_serialize(body.as_bytes()).collect();
|
||||
|
||||
// Note that `github_issue_url` is not included in the coredump file.
|
||||
// It has already been encoded and uploaded at this point.
|
||||
// The `github_issue_url` is used in openWindow in wasm.ts.
|
||||
self.github_issue_url = Some(format!(
|
||||
r#"https://github.com/{}/{}/issues/new?body={}&labels={}"#,
|
||||
"KittyCAD",
|
||||
"modeling-app",
|
||||
urlencoded,
|
||||
labels.join(",")
|
||||
));
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// The os info structure.
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
||||
#[ts(export)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub struct OsInfo {
|
||||
/// The platform the app is running on.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub platform: Option<String>,
|
||||
/// The architecture the app is running on.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub arch: Option<String>,
|
||||
/// The kernel version.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub version: Option<String>,
|
||||
/// Information about the browser.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub browser: Option<String>,
|
||||
}
|
||||
|
||||
/// The webrtc stats structure.
|
||||
#[derive(Default, Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
|
||||
#[ts(export)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub struct WebrtcStats {
|
||||
/// The packets lost.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub packets_lost: Option<u32>,
|
||||
/// The frames received.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub frames_received: Option<u32>,
|
||||
/// The frame width.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub frame_width: Option<f32>,
|
||||
/// The frame height.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub frame_height: Option<f32>,
|
||||
/// The frame rate.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub frame_rate: Option<f32>,
|
||||
/// The number of key frames decoded.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub key_frames_decoded: Option<u32>,
|
||||
/// The number of frames dropped.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub frames_dropped: Option<u32>,
|
||||
/// The pause count.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub pause_count: Option<u32>,
|
||||
/// The total pauses duration.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub total_pauses_duration: Option<f32>,
|
||||
/// The freeze count.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub freeze_count: Option<u32>,
|
||||
/// The total freezes duration.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub total_freezes_duration: Option<f32>,
|
||||
/// The pli count.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub pli_count: Option<u32>,
|
||||
/// Packet jitter for this synchronizing source, measured in seconds.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub jitter: Option<f32>,
|
||||
}
|
||||
Reference in New Issue
Block a user