typeduck-codex-utils-rustls-provider 0.6.0

Support package for the standalone Codex Web runtime (codex-exec-server)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
use std::collections::HashSet;
use std::io;

use codex_exec_server_protocol::CapabilityRootDiscoverRequest;
use codex_exec_server_protocol::CapabilityRootDiscovery;
use codex_exec_server_protocol::CapabilityRootsDiscoverParams;
use codex_exec_server_protocol::CapabilityRootsDiscoverResponse;
use codex_exec_server_protocol::CapabilityTextFile;
use codex_exec_server_protocol::DISCOVERABLE_PLUGIN_MANIFEST_PATHS;
use codex_exec_server_protocol::DiscoveredPluginFiles;
use codex_exec_server_protocol::DiscoveredSkillFiles;
use codex_file_system::ExecutorFileSystem;
use codex_file_system::WalkEntryKind;
use codex_file_system::WalkOptions;
use codex_utils_path_uri::PathUri;
use futures::StreamExt;
use serde::Deserialize;
use serde_json::Value;

const MAX_ROOTS_PER_REQUEST: usize = 128;
const MAX_SCAN_DEPTH: usize = 6;
const MAX_DIRECTORIES_PER_ROOT: usize = 2_000;
const MAX_ENTRIES_PER_ROOT: usize = 20_000;
const MAX_FILE_BYTES: usize = 1024 * 1024;
const MAX_BUNDLE_BYTES_PER_ROOT: usize = 16 * 1024 * 1024;
const MAX_CONCURRENT_ROOTS: usize = 8;
const SKILL_FILE_NAME: &str = "SKILL.md";
const SKILL_METADATA_PATH: &str = "agents/openai.yaml";
const DEFAULT_MCP_CONFIG_PATH: &str = ".mcp.json";

#[derive(Debug, thiserror::Error)]
pub enum CapabilityDiscoveryError {
    #[error("capability root discovery accepts at most {MAX_ROOTS_PER_REQUEST} roots")]
    TooManyRoots,
}

/// Discovers and materializes capability manifests using one executor-local filesystem.
///
/// Product parsing and policy intentionally remain with the caller. This operation owns the
/// filesystem-expensive portion: bounded traversal, recognized-file selection, and reads.
#[tracing::instrument(
    name = "capability_roots.discover_v1",
    skip_all,
    fields(root_count = params.roots.len())
)]
pub async fn discover_capability_roots(
    file_system: &dyn ExecutorFileSystem,
    params: CapabilityRootsDiscoverParams,
) -> Result<CapabilityRootsDiscoverResponse, CapabilityDiscoveryError> {
    if params.roots.len() > MAX_ROOTS_PER_REQUEST {
        return Err(CapabilityDiscoveryError::TooManyRoots);
    }

    let roots = futures::stream::iter(params.roots)
        .map(|root| discover_root(file_system, root))
        .buffered(MAX_CONCURRENT_ROOTS)
        .collect()
        .await;
    Ok(CapabilityRootsDiscoverResponse { roots })
}

async fn discover_root(
    file_system: &dyn ExecutorFileSystem,
    request: CapabilityRootDiscoverRequest,
) -> CapabilityRootDiscovery {
    let CapabilityRootDiscoverRequest { id, path } = request;
    let mut discovery = CapabilityRootDiscovery {
        id,
        path: path.clone(),
        plugin: None,
        skills: Vec::new(),
        namespace_manifests: Vec::new(),
        warnings: Vec::new(),
        error: None,
    };

    match file_system.get_metadata(&path, /*sandbox*/ None).await {
        Ok(metadata) if metadata.is_directory => {}
        Ok(_) => {
            discovery.error = Some(format!("capability root {path} is not a directory"));
            return discovery;
        }
        Err(error) => {
            discovery.error = Some(format!("failed to inspect capability root {path}: {error}"));
            return discovery;
        }
    }

    let walk = match file_system
        .walk(
            &path,
            WalkOptions {
                max_depth: MAX_SCAN_DEPTH,
                max_directories: MAX_DIRECTORIES_PER_ROOT,
                max_entries: MAX_ENTRIES_PER_ROOT,
                follow_directory_symlinks: true,
                prune_hidden_directories: false,
            },
            /*sandbox*/ None,
        )
        .await
    {
        Ok(walk) => walk,
        Err(error) => {
            discovery.error = Some(format!("failed to scan capability root {path}: {error}"));
            return discovery;
        }
    };
    discovery
        .warnings
        .extend(walk.errors.into_iter().map(|error| {
            format!(
                "failed to scan capability path {}: {}",
                error.path, error.message
            )
        }));
    if walk.truncated {
        discovery.warnings.push(format!(
            "capability scan reached its traversal limit (root: {path})"
        ));
    }

    let mut skill_paths = Vec::new();
    let mut namespace_manifest_paths = Vec::new();
    for entry in walk.entries {
        if entry.kind != WalkEntryKind::File {
            continue;
        }
        if entry.path.basename().as_deref() == Some(SKILL_FILE_NAME) {
            skill_paths.push(entry.path.clone());
        }
        if is_plugin_manifest_path(&entry.path) {
            namespace_manifest_paths.push(entry.path);
        }
    }
    skill_paths.sort_unstable_by_key(PathUri::to_string);
    namespace_manifest_paths.sort_unstable_by(|left, right| {
        let left_root = plugin_root_for_manifest(left).map(|path| path.to_string());
        let right_root = plugin_root_for_manifest(right).map(|path| path.to_string());
        left_root
            .cmp(&right_root)
            .then_with(|| plugin_manifest_priority(left).cmp(&plugin_manifest_priority(right)))
    });

    let mut budget = BundleBudget::default();
    let root_manifest =
        read_first_plugin_manifest(file_system, &path, &mut budget, &mut discovery.warnings).await;

    let inherited_manifest = match root_manifest.as_ref() {
        Some(manifest) => Some(manifest.clone()),
        None => {
            read_nearest_ancestor_manifest(file_system, &path, &mut budget, &mut discovery.warnings)
                .await
        }
    };
    let mut seen_namespace_roots = HashSet::new();
    if let Some(manifest) = inherited_manifest {
        if let Some(plugin_root) = plugin_root_for_manifest(&manifest.path) {
            seen_namespace_roots.insert(plugin_root);
        }
        discovery.namespace_manifests.push(manifest);
    }
    for manifest_path in namespace_manifest_paths {
        let Some(plugin_root) = plugin_root_for_manifest(&manifest_path) else {
            continue;
        };
        if !seen_namespace_roots.insert(plugin_root) {
            continue;
        }
        if let Some(manifest) = read_optional_text_file(
            file_system,
            manifest_path,
            &mut budget,
            &mut discovery.warnings,
        )
        .await
        {
            discovery.namespace_manifests.push(manifest);
        }
    }

    if let Some(manifest) = root_manifest {
        let declarations = plugin_declaration_paths(&path, &manifest, &mut discovery.warnings);
        let mcp_path = if declarations.mcp_inline {
            None
        } else {
            declarations
                .mcp_config
                .or_else(|| path.join(DEFAULT_MCP_CONFIG_PATH).ok())
        };
        let mcp_config = match mcp_path {
            Some(path) => {
                read_optional_text_file(file_system, path, &mut budget, &mut discovery.warnings)
                    .await
            }
            None => None,
        };
        let apps_config = match declarations.apps_config {
            Some(path) => {
                read_optional_text_file(file_system, path, &mut budget, &mut discovery.warnings)
                    .await
            }
            None => None,
        };
        discovery.plugin = Some(DiscoveredPluginFiles {
            manifest,
            mcp_config,
            apps_config,
        });
    }

    for skill_path in skill_paths {
        let Some(instructions) = read_optional_text_file(
            file_system,
            skill_path.clone(),
            &mut budget,
            &mut discovery.warnings,
        )
        .await
        else {
            continue;
        };
        let metadata = match skill_path
            .parent()
            .and_then(|skill_dir| skill_dir.join(SKILL_METADATA_PATH).ok())
        {
            Some(metadata_path) => {
                read_optional_text_file(
                    file_system,
                    metadata_path,
                    &mut budget,
                    &mut discovery.warnings,
                )
                .await
            }
            None => None,
        };
        discovery.skills.push(DiscoveredSkillFiles {
            instructions,
            metadata,
        });
    }

    discovery
}

async fn read_first_plugin_manifest(
    file_system: &dyn ExecutorFileSystem,
    root: &PathUri,
    budget: &mut BundleBudget,
    warnings: &mut Vec<String>,
) -> Option<CapabilityTextFile> {
    for relative_path in DISCOVERABLE_PLUGIN_MANIFEST_PATHS {
        let Ok(path) = root.join(relative_path) else {
            continue;
        };
        if let Some(manifest) = read_optional_text_file(file_system, path, budget, warnings).await {
            return Some(manifest);
        }
    }
    None
}

async fn read_nearest_ancestor_manifest(
    file_system: &dyn ExecutorFileSystem,
    root: &PathUri,
    budget: &mut BundleBudget,
    warnings: &mut Vec<String>,
) -> Option<CapabilityTextFile> {
    let mut ancestor = root.parent();
    while let Some(path) = ancestor {
        if let Some(manifest) =
            read_first_plugin_manifest(file_system, &path, budget, warnings).await
        {
            return Some(manifest);
        }
        ancestor = path.parent();
    }
    None
}

async fn read_optional_text_file(
    file_system: &dyn ExecutorFileSystem,
    path: PathUri,
    budget: &mut BundleBudget,
    warnings: &mut Vec<String>,
) -> Option<CapabilityTextFile> {
    let metadata = match file_system.get_metadata(&path, /*sandbox*/ None).await {
        Ok(metadata) if metadata.is_file => metadata,
        Ok(_) => return None,
        Err(error) if error.kind() == io::ErrorKind::NotFound => return None,
        Err(error) => {
            warnings.push(format!("failed to inspect capability file {path}: {error}"));
            return None;
        }
    };
    let Ok(size) = usize::try_from(metadata.size) else {
        warnings.push(format!("capability file {path} is too large"));
        return None;
    };
    if size > MAX_FILE_BYTES {
        warnings.push(format!(
            "capability file {path} exceeds the {MAX_FILE_BYTES}-byte limit"
        ));
        return None;
    }
    if !budget.can_add(size) {
        warnings.push(format!(
            "capability root bundle exceeds the {MAX_BUNDLE_BYTES_PER_ROOT}-byte limit"
        ));
        return None;
    }
    let mut stream = match file_system.read_file_stream(&path, /*sandbox*/ None).await {
        Ok(stream) => stream,
        Err(error) => {
            warnings.push(format!("failed to read capability file {path}: {error}"));
            return None;
        }
    };
    let mut contents = Vec::with_capacity(size);
    while let Some(chunk) = stream.next().await {
        let chunk = match chunk {
            Ok(chunk) => chunk,
            Err(error) => {
                warnings.push(format!("failed to read capability file {path}: {error}"));
                return None;
            }
        };
        let Some(new_len) = contents.len().checked_add(chunk.len()) else {
            warnings.push(format!("capability file {path} exceeded its read limit"));
            return None;
        };
        if new_len > MAX_FILE_BYTES || !budget.can_add(new_len) {
            warnings.push(format!("capability file {path} exceeded its read limit"));
            return None;
        }
        contents.extend_from_slice(&chunk);
    }
    let contents = match String::from_utf8(contents) {
        Ok(contents) => contents,
        Err(error) => {
            warnings.push(format!("capability file {path} is not UTF-8: {error}"));
            return None;
        }
    };
    budget.add(contents.len());
    Some(CapabilityTextFile { path, contents })
}

fn is_plugin_manifest_path(path: &PathUri) -> bool {
    plugin_manifest_priority(path).is_some()
}

fn plugin_manifest_priority(path: &PathUri) -> Option<usize> {
    if path.basename().as_deref() != Some("plugin.json") {
        return None;
    }
    let manifest_directory = path.parent()?.basename()?;
    DISCOVERABLE_PLUGIN_MANIFEST_PATHS
        .iter()
        .position(|relative_path| {
            relative_path.strip_suffix("/plugin.json") == Some(manifest_directory.as_str())
        })
}

fn plugin_root_for_manifest(path: &PathUri) -> Option<PathUri> {
    path.parent()?.parent()
}

#[derive(Default)]
struct BundleBudget {
    bytes: usize,
}

impl BundleBudget {
    fn can_add(&self, bytes: usize) -> bool {
        self.bytes
            .checked_add(bytes)
            .is_some_and(|total| total <= MAX_BUNDLE_BYTES_PER_ROOT)
    }

    fn add(&mut self, bytes: usize) {
        self.bytes += bytes;
    }
}

#[derive(Default)]
struct PluginDeclarationPaths {
    mcp_config: Option<PathUri>,
    mcp_inline: bool,
    apps_config: Option<PathUri>,
}

#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct RawPluginDeclarations {
    #[serde(default)]
    mcp_servers: Option<Value>,
    #[serde(default)]
    apps: Option<Value>,
}

fn plugin_declaration_paths(
    root: &PathUri,
    manifest: &CapabilityTextFile,
    warnings: &mut Vec<String>,
) -> PluginDeclarationPaths {
    let declarations = match serde_json::from_str::<RawPluginDeclarations>(&manifest.contents) {
        Ok(declarations) => declarations,
        Err(_) => return PluginDeclarationPaths::default(),
    };
    PluginDeclarationPaths {
        mcp_config: declarations.mcp_servers.as_ref().and_then(|value| {
            declared_file_path(root, "mcpServers", value, &manifest.path, warnings)
        }),
        mcp_inline: declarations
            .mcp_servers
            .as_ref()
            .is_some_and(Value::is_object),
        apps_config: declarations
            .apps
            .as_ref()
            .and_then(|value| declared_file_path(root, "apps", value, &manifest.path, warnings)),
    }
}

fn declared_file_path(
    root: &PathUri,
    field: &str,
    value: &Value,
    manifest_path: &PathUri,
    warnings: &mut Vec<String>,
) -> Option<PathUri> {
    let Value::String(path) = value else {
        return None;
    };
    let Some(relative_path) = path.strip_prefix("./") else {
        warnings.push(format!(
            "ignoring {field} in {manifest_path}: path must start with `./`"
        ));
        return None;
    };
    if relative_path.is_empty()
        || relative_path
            .split(['/', '\\'])
            .any(|component| component == "..")
    {
        warnings.push(format!(
            "ignoring {field} in {manifest_path}: path must remain below the capability root"
        ));
        return None;
    }
    match root.join(relative_path) {
        Ok(path) if path.starts_with(root) => Some(path),
        Ok(_) | Err(_) => {
            warnings.push(format!(
                "ignoring {field} in {manifest_path}: path must remain below the capability root"
            ));
            None
        }
    }
}