Skip to content

armgit / Cap

Public Imported from GitHub
0

Open source Loom alternative. Beautiful, shareable screen recordings.

fix(cli): include standard error field in Caps JSON failures

Akshar Patel3621dd2c32d3
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7c6b6fa18..7c3f0b0d6 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -308,6 +308,7 @@ jobs:
cargo test --locked -p cap --bin cap record::tests
cargo test --locked -p cap --bin cap recordings::tests
cargo test --locked -p cap --test cli recordings_list
+ cargo test --locked -p cap --test cli caps_json_errors_include_the_standard_error_field
cargo test --locked -p cap-recording --lib -- --test-threads=1
cargo test --locked -p cap-recording --test x11_shm_capture -- --test-threads=1
cargo test --locked -p scap-targets --lib --test linux_targets
diff --git a/apps/cli/src/caps.rs b/apps/cli/src/caps.rs
index 4bb9e4d96..d09a84fb4 100644
--- a/apps/cli/src/caps.rs
+++ b/apps/cli/src/caps.rs
@@ -1144,7 +1144,16 @@ impl CapsArgs {
if let Err(error) = &result
&& output_format == OutputFormat::Json
{
- let _ = write_json(error);
+ #[derive(Serialize)]
+ struct JsonError<'a> {
+ error: &'a str,
+ #[serde(flatten)]
+ details: &'a AgentApiError,
+ }
+ let _ = write_json(&JsonError {
+ error: &error.message,
+ details: error,
+ });
}
result.map_err(|error| error.to_string())
}
diff --git a/apps/cli/tests/cli.rs b/apps/cli/tests/cli.rs
index d3372bb3e..7dd2674d0 100644
--- a/apps/cli/tests/cli.rs
+++ b/apps/cli/tests/cli.rs
@@ -1500,3 +1500,22 @@ fn write_single_segment_meta(project: &Path) {
)
.unwrap();
}
+
+#[test]
+fn caps_json_errors_include_the_standard_error_field() {
+ for flags in [&["--json"][..], &["--format", "json"][..]] {
+ let output = cap()
+ .args(["caps", "get", "!"])
+ .args(flags)
+ .env("CAP_AGENT_TOKEN", "cap_cli_synthetic_test_token")
+ .env("CAP_SERVER_URL", "http://127.0.0.1:9")
+ .output()
+ .unwrap();
+ assert_eq!(output.status.code(), Some(1));
+ let error = parse_json(&output);
+ assert_eq!(error["error"], "Cap ID contains invalid characters");
+ assert_eq!(error["message"], "Cap ID contains invalid characters");
+ assert_eq!(error["code"], "INVALID_REQUEST");
+ assert_eq!(error["retryable"], false);
+ }
+}