1use anyhow::{Context as _, Result, anyhow, bail};
2use collections::{BTreeMap, HashMap};
3use fs::Fs;
4use language::LanguageName;
5use lsp::LanguageServerName;
6use semantic_version::SemanticVersion;
7use serde::{Deserialize, Serialize};
8use std::{
9 ffi::OsStr,
10 fmt,
11 path::{Path, PathBuf},
12 sync::Arc,
13};
14
15use crate::ExtensionCapability;
16
17/// This is the old version of the extension manifest, from when it was `extension.json`.
18#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
19pub struct OldExtensionManifest {
20 pub name: String,
21 pub version: Arc<str>,
22
23 #[serde(default)]
24 pub description: Option<String>,
25 #[serde(default)]
26 pub repository: Option<String>,
27 #[serde(default)]
28 pub authors: Vec<String>,
29
30 #[serde(default)]
31 pub themes: BTreeMap<Arc<str>, PathBuf>,
32 #[serde(default)]
33 pub languages: BTreeMap<Arc<str>, PathBuf>,
34 #[serde(default)]
35 pub grammars: BTreeMap<Arc<str>, PathBuf>,
36}
37
38/// The schema version of the [`ExtensionManifest`].
39#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
40pub struct SchemaVersion(pub i32);
41
42impl fmt::Display for SchemaVersion {
43 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
44 write!(f, "{}", self.0)
45 }
46}
47
48impl SchemaVersion {
49 pub const ZERO: Self = Self(0);
50
51 pub fn is_v0(&self) -> bool {
52 self == &Self::ZERO
53 }
54}
55
56#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
57pub struct ExtensionManifest {
58 pub id: Arc<str>,
59 pub name: String,
60 pub version: Arc<str>,
61 pub schema_version: SchemaVersion,
62
63 #[serde(default)]
64 pub description: Option<String>,
65 #[serde(default)]
66 pub repository: Option<String>,
67 #[serde(default)]
68 pub authors: Vec<String>,
69 #[serde(default)]
70 pub lib: LibManifestEntry,
71
72 #[serde(default)]
73 pub themes: Vec<PathBuf>,
74 #[serde(default)]
75 pub icon_themes: Vec<PathBuf>,
76 #[serde(default)]
77 pub languages: Vec<PathBuf>,
78 #[serde(default)]
79 pub grammars: BTreeMap<Arc<str>, GrammarManifestEntry>,
80 #[serde(default)]
81 pub language_servers: BTreeMap<LanguageServerName, LanguageServerManifestEntry>,
82 #[serde(default)]
83 pub context_servers: BTreeMap<Arc<str>, ContextServerManifestEntry>,
84 #[serde(default)]
85 pub agent_servers: BTreeMap<Arc<str>, AgentServerManifestEntry>,
86 #[serde(default)]
87 pub slash_commands: BTreeMap<Arc<str>, SlashCommandManifestEntry>,
88 #[serde(default)]
89 pub snippets: Option<PathBuf>,
90 #[serde(default)]
91 pub capabilities: Vec<ExtensionCapability>,
92 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
93 pub debug_adapters: BTreeMap<Arc<str>, DebugAdapterManifestEntry>,
94 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
95 pub debug_locators: BTreeMap<Arc<str>, DebugLocatorManifestEntry>,
96}
97
98impl ExtensionManifest {
99 pub fn allow_exec(
100 &self,
101 desired_command: &str,
102 desired_args: &[impl AsRef<str> + std::fmt::Debug],
103 ) -> Result<()> {
104 let is_allowed = self.capabilities.iter().any(|capability| match capability {
105 ExtensionCapability::ProcessExec(capability) => {
106 capability.allows(desired_command, desired_args)
107 }
108 _ => false,
109 });
110
111 if !is_allowed {
112 bail!(
113 "capability for process:exec {desired_command} {desired_args:?} was not listed in the extension manifest",
114 );
115 }
116
117 Ok(())
118 }
119
120 pub fn allow_remote_load(&self) -> bool {
121 !self.language_servers.is_empty()
122 || !self.debug_adapters.is_empty()
123 || !self.debug_locators.is_empty()
124 }
125}
126
127pub fn build_debug_adapter_schema_path(
128 adapter_name: &Arc<str>,
129 meta: &DebugAdapterManifestEntry,
130) -> PathBuf {
131 meta.schema_path.clone().unwrap_or_else(|| {
132 Path::new("debug_adapter_schemas")
133 .join(Path::new(adapter_name.as_ref()).with_extension("json"))
134 })
135}
136
137#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
138pub struct LibManifestEntry {
139 pub kind: Option<ExtensionLibraryKind>,
140 pub version: Option<SemanticVersion>,
141}
142
143#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
144pub struct AgentServerManifestEntry {
145 /// Display name for the agent (shown in menus).
146 pub name: String,
147 /// Environment variables to set when launching the agent server.
148 #[serde(default)]
149 pub env: HashMap<String, String>,
150 /// Optional icon path (relative to extension root, e.g., "ai.svg").
151 /// Should be a small SVG icon for display in menus.
152 #[serde(default)]
153 pub icon: Option<String>,
154 /// Per-target configuration for archive-based installation.
155 /// The key format is "{os}-{arch}" where:
156 /// - os: "darwin" (macOS), "linux", "windows"
157 /// - arch: "aarch64" (arm64), "x86_64"
158 ///
159 /// Example:
160 /// ```toml
161 /// [agent_servers.myagent.targets.darwin-aarch64]
162 /// archive = "https://example.com/myagent-darwin-arm64.zip"
163 /// cmd = "./myagent"
164 /// args = ["--serve"]
165 /// sha256 = "abc123..." # optional
166 /// ```
167 pub targets: HashMap<String, TargetConfig>,
168}
169
170#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
171pub struct TargetConfig {
172 /// URL to download the archive from (e.g., "https://github.com/owner/repo/releases/download/v1.0.0/myagent-darwin-arm64.zip")
173 pub archive: String,
174 /// Command to run (e.g., "./myagent" or "./myagent.exe")
175 pub cmd: String,
176 /// Command-line arguments to pass to the agent server.
177 #[serde(default)]
178 pub args: Vec<String>,
179 /// Optional SHA-256 hash of the archive for verification.
180 /// If not provided and the URL is a GitHub release, we'll attempt to fetch it from GitHub.
181 #[serde(default)]
182 pub sha256: Option<String>,
183}
184
185#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
186pub enum ExtensionLibraryKind {
187 Rust,
188}
189
190#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
191pub struct GrammarManifestEntry {
192 pub repository: String,
193 #[serde(alias = "commit")]
194 pub rev: String,
195 #[serde(default)]
196 pub path: Option<String>,
197}
198
199#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
200pub struct LanguageServerManifestEntry {
201 /// Deprecated in favor of `languages`.
202 #[serde(default)]
203 language: Option<LanguageName>,
204 /// The list of languages this language server should work with.
205 #[serde(default)]
206 languages: Vec<LanguageName>,
207 #[serde(default)]
208 pub language_ids: HashMap<LanguageName, String>,
209 #[serde(default)]
210 pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
211}
212
213impl LanguageServerManifestEntry {
214 /// Returns the list of languages for the language server.
215 ///
216 /// Prefer this over accessing the `language` or `languages` fields directly,
217 /// as we currently support both.
218 ///
219 /// We can replace this with just field access for the `languages` field once
220 /// we have removed `language`.
221 pub fn languages(&self) -> impl IntoIterator<Item = LanguageName> + '_ {
222 let language = if self.languages.is_empty() {
223 self.language.clone()
224 } else {
225 None
226 };
227 self.languages.iter().cloned().chain(language)
228 }
229}
230
231#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
232pub struct ContextServerManifestEntry {}
233
234#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
235pub struct SlashCommandManifestEntry {
236 pub description: String,
237 pub requires_argument: bool,
238}
239
240#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
241pub struct DebugAdapterManifestEntry {
242 pub schema_path: Option<PathBuf>,
243}
244
245#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
246pub struct DebugLocatorManifestEntry {}
247
248impl ExtensionManifest {
249 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
250 let extension_name = extension_dir
251 .file_name()
252 .and_then(OsStr::to_str)
253 .context("invalid extension name")?;
254
255 let mut extension_manifest_path = extension_dir.join("extension.json");
256 if fs.is_file(&extension_manifest_path).await {
257 let manifest_content = fs
258 .load(&extension_manifest_path)
259 .await
260 .with_context(|| format!("failed to load {extension_name} extension.json"))?;
261 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
262 .with_context(|| {
263 format!("invalid extension.json for extension {extension_name}")
264 })?;
265
266 Ok(manifest_from_old_manifest(manifest_json, extension_name))
267 } else {
268 extension_manifest_path.set_extension("toml");
269 let manifest_content = fs
270 .load(&extension_manifest_path)
271 .await
272 .with_context(|| format!("failed to load {extension_name} extension.toml"))?;
273 toml::from_str(&manifest_content).map_err(|err| {
274 anyhow!("Invalid extension.toml for extension {extension_name}:\n{err}")
275 })
276 }
277 }
278}
279
280fn manifest_from_old_manifest(
281 manifest_json: OldExtensionManifest,
282 extension_id: &str,
283) -> ExtensionManifest {
284 ExtensionManifest {
285 id: extension_id.into(),
286 name: manifest_json.name,
287 version: manifest_json.version,
288 description: manifest_json.description,
289 repository: manifest_json.repository,
290 authors: manifest_json.authors,
291 schema_version: SchemaVersion::ZERO,
292 lib: Default::default(),
293 themes: {
294 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
295 themes.sort();
296 themes.dedup();
297 themes
298 },
299 icon_themes: Vec::new(),
300 languages: {
301 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
302 languages.sort();
303 languages.dedup();
304 languages
305 },
306 grammars: manifest_json
307 .grammars
308 .into_keys()
309 .map(|grammar_name| (grammar_name, Default::default()))
310 .collect(),
311 language_servers: Default::default(),
312 context_servers: BTreeMap::default(),
313 agent_servers: BTreeMap::default(),
314 slash_commands: BTreeMap::default(),
315 snippets: None,
316 capabilities: Vec::new(),
317 debug_adapters: Default::default(),
318 debug_locators: Default::default(),
319 }
320}
321
322#[cfg(test)]
323mod tests {
324 use pretty_assertions::assert_eq;
325
326 use crate::ProcessExecCapability;
327
328 use super::*;
329
330 fn extension_manifest() -> ExtensionManifest {
331 ExtensionManifest {
332 id: "test".into(),
333 name: "Test".to_string(),
334 version: "1.0.0".into(),
335 schema_version: SchemaVersion::ZERO,
336 description: None,
337 repository: None,
338 authors: vec![],
339 lib: Default::default(),
340 themes: vec![],
341 icon_themes: vec![],
342 languages: vec![],
343 grammars: BTreeMap::default(),
344 language_servers: BTreeMap::default(),
345 context_servers: BTreeMap::default(),
346 agent_servers: BTreeMap::default(),
347 slash_commands: BTreeMap::default(),
348 snippets: None,
349 capabilities: vec![],
350 debug_adapters: Default::default(),
351 debug_locators: Default::default(),
352 }
353 }
354
355 #[test]
356 fn test_build_adapter_schema_path_with_schema_path() {
357 let adapter_name = Arc::from("my_adapter");
358 let entry = DebugAdapterManifestEntry {
359 schema_path: Some(PathBuf::from("foo/bar")),
360 };
361
362 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
363 assert_eq!(path, PathBuf::from("foo/bar"));
364 }
365
366 #[test]
367 fn test_build_adapter_schema_path_without_schema_path() {
368 let adapter_name = Arc::from("my_adapter");
369 let entry = DebugAdapterManifestEntry { schema_path: None };
370
371 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
372 assert_eq!(
373 path,
374 PathBuf::from("debug_adapter_schemas").join("my_adapter.json")
375 );
376 }
377
378 #[test]
379 fn test_allow_exec_exact_match() {
380 let manifest = ExtensionManifest {
381 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
382 command: "ls".to_string(),
383 args: vec!["-la".to_string()],
384 })],
385 ..extension_manifest()
386 };
387
388 assert!(manifest.allow_exec("ls", &["-la"]).is_ok());
389 assert!(manifest.allow_exec("ls", &["-l"]).is_err());
390 assert!(manifest.allow_exec("pwd", &[] as &[&str]).is_err());
391 }
392
393 #[test]
394 fn test_allow_exec_wildcard_arg() {
395 let manifest = ExtensionManifest {
396 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
397 command: "git".to_string(),
398 args: vec!["*".to_string()],
399 })],
400 ..extension_manifest()
401 };
402
403 assert!(manifest.allow_exec("git", &["status"]).is_ok());
404 assert!(manifest.allow_exec("git", &["commit"]).is_ok());
405 assert!(manifest.allow_exec("git", &["status", "-s"]).is_err()); // too many args
406 assert!(manifest.allow_exec("npm", &["install"]).is_err()); // wrong command
407 }
408
409 #[test]
410 fn test_allow_exec_double_wildcard() {
411 let manifest = ExtensionManifest {
412 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
413 command: "cargo".to_string(),
414 args: vec!["test".to_string(), "**".to_string()],
415 })],
416 ..extension_manifest()
417 };
418
419 assert!(manifest.allow_exec("cargo", &["test"]).is_ok());
420 assert!(manifest.allow_exec("cargo", &["test", "--all"]).is_ok());
421 assert!(
422 manifest
423 .allow_exec("cargo", &["test", "--all", "--no-fail-fast"])
424 .is_ok()
425 );
426 assert!(manifest.allow_exec("cargo", &["build"]).is_err()); // wrong first arg
427 }
428
429 #[test]
430 fn test_allow_exec_mixed_wildcards() {
431 let manifest = ExtensionManifest {
432 capabilities: vec![ExtensionCapability::ProcessExec(ProcessExecCapability {
433 command: "docker".to_string(),
434 args: vec!["run".to_string(), "*".to_string(), "**".to_string()],
435 })],
436 ..extension_manifest()
437 };
438
439 assert!(manifest.allow_exec("docker", &["run", "nginx"]).is_ok());
440 assert!(manifest.allow_exec("docker", &["run"]).is_err());
441 assert!(
442 manifest
443 .allow_exec("docker", &["run", "ubuntu", "bash"])
444 .is_ok()
445 );
446 assert!(
447 manifest
448 .allow_exec("docker", &["run", "alpine", "sh", "-c", "echo hello"])
449 .is_ok()
450 );
451 assert!(manifest.allow_exec("docker", &["ps"]).is_err()); // wrong first arg
452 }
453 #[test]
454 fn parse_manifest_with_agent_server_archive_launcher() {
455 let toml_src = r#"
456id = "example.agent-server-ext"
457name = "Agent Server Example"
458version = "1.0.0"
459schema_version = 0
460
461[agent_servers.foo]
462name = "Foo Agent"
463
464[agent_servers.foo.targets.linux-x86_64]
465archive = "https://example.com/agent-linux-x64.tar.gz"
466cmd = "./agent"
467args = ["--serve"]
468"#;
469
470 let manifest: ExtensionManifest = toml::from_str(toml_src).expect("manifest should parse");
471 assert_eq!(manifest.id.as_ref(), "example.agent-server-ext");
472 assert!(manifest.agent_servers.contains_key("foo"));
473 let entry = manifest.agent_servers.get("foo").unwrap();
474 assert!(entry.targets.contains_key("linux-x86_64"));
475 let target = entry.targets.get("linux-x86_64").unwrap();
476 assert_eq!(target.archive, "https://example.com/agent-linux-x64.tar.gz");
477 assert_eq!(target.cmd, "./agent");
478 assert_eq!(target.args, vec!["--serve"]);
479 }
480}