a3s-code-core 8.5.3

A3S Code Core - Embeddable AI agent library with tool execution
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
use super::chunk::{chunk_file_with_strategy, ChunkFileRequest};
use super::lexical::{search_catalog, LexicalPartition, LexicalSearchRequest, LexicalSearchResult};
use super::types::{
    ChunkCatalogLimits, ChunkingConfig, WorkspaceChunk, WorkspaceIndexError, WorkspaceIndexResult,
    WorkspaceLexicalEngine,
};
use super::WorkspaceChunkingStrategy;
use crate::workspace::{LocalWorkspaceFile, LocalWorkspaceFileStatus, WorkspacePath};
use std::collections::BTreeMap;
use std::path::{Component, Path};
use std::sync::{Arc, RwLock};
use tokio::sync::watch;

/// Immutable, query-safe view of one catalog revision.
#[derive(Clone)]
pub struct ChunkCatalogSnapshot {
    pub(crate) state: Arc<CatalogState>,
    pub(crate) lexical_engine: WorkspaceLexicalEngine,
}

impl std::fmt::Debug for ChunkCatalogSnapshot {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("ChunkCatalogSnapshot")
            .field("revision", &self.revision())
            .field("source_revision", &self.source_revision())
            .field("lexical_engine", &self.lexical_engine)
            .field("file_count", &self.file_count())
            .field("chunk_count", &self.chunk_count())
            .field("text_bytes", &self.text_bytes())
            .field("estimated_index_bytes", &self.estimated_index_bytes())
            .finish()
    }
}

impl ChunkCatalogSnapshot {
    pub fn revision(&self) -> u64 {
        self.state.revision
    }

    pub fn source_revision(&self) -> u64 {
        self.state.source_revision
    }

    /// Return the lexical engine that produced this immutable snapshot.
    pub fn lexical_engine(&self) -> WorkspaceLexicalEngine {
        self.lexical_engine
    }

    pub fn file_count(&self) -> usize {
        self.state.files.len()
    }

    pub fn chunk_count(&self) -> usize {
        self.state.chunks.len()
    }

    pub fn text_bytes(&self) -> usize {
        self.state.text_bytes
    }

    pub fn estimated_index_bytes(&self) -> usize {
        self.state.estimated_index_bytes
    }

    /// Number of files admitted by the workspace policy for this source
    /// revision, including files whose catalog build failed.
    pub fn eligible_file_count(&self) -> usize {
        self.state.eligible_file_count
    }

    /// Number of admitted files that failed catalog construction for this
    /// source revision.
    pub fn failed_file_count(&self) -> usize {
        self.state.failed_file_count
    }

    pub fn paths(&self) -> Vec<String> {
        self.state.files.keys().cloned().collect()
    }

    pub fn content_digest(&self, path: &WorkspacePath) -> Option<Arc<str>> {
        self.state
            .files
            .get(path.as_str())
            .map(|file| Arc::clone(&file.content_digest))
    }

    pub fn chunks(&self) -> Arc<[Arc<WorkspaceChunk>]> {
        Arc::clone(&self.state.chunks)
    }

    pub fn lexical_search(
        &self,
        request: &LexicalSearchRequest,
    ) -> Result<LexicalSearchResult, WorkspaceIndexError> {
        search_catalog(self, request)
    }
}

/// Atomic, bounded, session-owned catalog of workspace source chunks.
pub struct WorkspaceChunkCatalog {
    chunking: ChunkingConfig,
    chunking_strategy: WorkspaceChunkingStrategy,
    limits: ChunkCatalogLimits,
    lexical_engine: WorkspaceLexicalEngine,
    build_engine: WorkspaceLexicalEngine,
    state: RwLock<Arc<CatalogState>>,
    updates: watch::Sender<ChunkCatalogSnapshot>,
}

impl std::fmt::Debug for WorkspaceChunkCatalog {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("WorkspaceChunkCatalog")
            .field("chunking", &self.chunking)
            .field("chunking_strategy", &self.chunking_strategy)
            .field("lexical_engine", &self.lexical_engine)
            .field("limits", &self.limits)
            .field("snapshot", &self.snapshot().ok())
            .finish()
    }
}

impl WorkspaceChunkCatalog {
    pub fn new(
        chunking: ChunkingConfig,
        limits: ChunkCatalogLimits,
    ) -> WorkspaceIndexResult<Arc<Self>> {
        Self::new_with_strategy_and_engine(
            WorkspaceChunkingStrategy::Lines,
            chunking,
            limits,
            WorkspaceLexicalEngine::default(),
        )
    }

    /// Construct a catalog with an explicit lexical engine.
    pub fn new_with_engine(
        chunking: ChunkingConfig,
        limits: ChunkCatalogLimits,
        lexical_engine: WorkspaceLexicalEngine,
    ) -> WorkspaceIndexResult<Arc<Self>> {
        Self::new_with_strategy_and_engine(
            WorkspaceChunkingStrategy::Lines,
            chunking,
            limits,
            lexical_engine,
        )
    }

    /// Construct a bounded catalog with an explicit text splitting strategy.
    pub fn new_with_strategy(
        chunking_strategy: WorkspaceChunkingStrategy,
        chunking: ChunkingConfig,
        limits: ChunkCatalogLimits,
    ) -> WorkspaceIndexResult<Arc<Self>> {
        Self::new_with_strategy_and_engine(
            chunking_strategy,
            chunking,
            limits,
            WorkspaceLexicalEngine::default(),
        )
    }

    /// Construct a bounded catalog with explicit chunking and lexical engines.
    pub fn new_with_strategy_and_engine(
        chunking_strategy: WorkspaceChunkingStrategy,
        chunking: ChunkingConfig,
        limits: ChunkCatalogLimits,
        lexical_engine: WorkspaceLexicalEngine,
    ) -> WorkspaceIndexResult<Arc<Self>> {
        let chunking = chunking.validate()?;
        chunking_strategy
            .validate_for(chunking)
            .map_err(|error| super::chunking_strategy::map_strategy_error("<catalog>", error))?;
        let limits = limits.validate()?;
        if lexical_engine == WorkspaceLexicalEngine::ZvecRust && !cfg!(feature = "zvec-rust-fts") {
            return Err(WorkspaceIndexError::InvalidConfig(
                "WorkspaceLexicalEngine::ZvecRust requires the zvec-rust-fts feature".to_owned(),
            ));
        }
        let state = Arc::new(CatalogState::default());
        let (updates, _) = watch::channel(ChunkCatalogSnapshot {
            state: Arc::clone(&state),
            lexical_engine,
        });
        Ok(Arc::new(Self {
            chunking,
            chunking_strategy,
            limits,
            lexical_engine,
            build_engine: lexical_engine,
            state: RwLock::new(state),
            updates,
        }))
    }

    pub(crate) fn default_catalog() -> Arc<Self> {
        Self::default_catalog_with_engine(WorkspaceLexicalEngine::default())
    }

    /// Construct the automatic catalog with a caller-selected fallback
    /// engine. The durable workspace projection uses native zvec for the
    /// corpus-wide index; keeping this admission catalog portable avoids
    /// opening one native collection per source file during a cold scan.
    pub(crate) fn default_catalog_with_engine(engine: WorkspaceLexicalEngine) -> Arc<Self> {
        Self::default_catalog_with_engines(engine, engine)
    }

    /// Construct the automatic catalog with separate reported and admission
    /// engines. The durable zvec path reports its native engine to callers,
    /// while its cold admission fallback can build portable partitions.
    pub(crate) fn default_catalog_with_engines(
        lexical_engine: WorkspaceLexicalEngine,
        build_engine: WorkspaceLexicalEngine,
    ) -> Arc<Self> {
        let state = Arc::new(CatalogState::default());
        let (updates, _) = watch::channel(ChunkCatalogSnapshot {
            state: Arc::clone(&state),
            lexical_engine,
        });
        Arc::new(Self {
            chunking: ChunkingConfig::default(),
            chunking_strategy: WorkspaceChunkingStrategy::Lines,
            limits: ChunkCatalogLimits::default(),
            lexical_engine,
            build_engine,
            state: RwLock::new(state),
            updates,
        })
    }

    pub(crate) fn subscribe(&self) -> watch::Receiver<ChunkCatalogSnapshot> {
        self.updates.subscribe()
    }

    pub fn snapshot(&self) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        self.state
            .read()
            .map(|state| ChunkCatalogSnapshot {
                state: Arc::clone(&state),
                lexical_engine: self.lexical_engine,
            })
            .map_err(|_| WorkspaceIndexError::LockPoisoned)
    }

    /// Replace one caller-admitted file and atomically publish a new revision.
    pub fn replace_file(
        &self,
        path: &WorkspacePath,
        language: Option<&str>,
        source_revision: u64,
        content: &str,
    ) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        if path.is_root() || !safe_relative_path(path.as_str()) {
            return Err(WorkspaceIndexError::InvalidConfig(
                "catalog paths must be normalized workspace-relative files".to_owned(),
            ));
        }
        let file = LocalWorkspaceFile {
            path: path.as_str().to_owned(),
            size: content.len() as u64,
            modified_ms: None,
            language: language.map(str::to_owned),
            status: LocalWorkspaceFileStatus::Unknown,
            binary: false,
            generated: false,
        };
        let replacement = Arc::new(CatalogFile::build(
            file,
            source_revision,
            content,
            self.chunking,
            &self.chunking_strategy,
            self.lexical_engine,
        )?);
        let mut state = self
            .state
            .write()
            .map_err(|_| WorkspaceIndexError::LockPoisoned)?;
        let mut files = state.files.clone();
        files.insert(path.as_str().to_owned(), replacement);
        let eligible_file_count = files.len();
        self.publish_locked(&mut state, source_revision, files, eligible_file_count, 0)
    }

    pub fn remove_file(
        &self,
        path: &WorkspacePath,
        source_revision: u64,
    ) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        if path.is_root() || !safe_relative_path(path.as_str()) {
            return Err(WorkspaceIndexError::InvalidConfig(
                "catalog paths must be normalized workspace-relative files".to_owned(),
            ));
        }
        let mut state = self
            .state
            .write()
            .map_err(|_| WorkspaceIndexError::LockPoisoned)?;
        let mut files = state.files.clone();
        files.remove(path.as_str());
        let eligible_file_count = files.len();
        self.publish_locked(&mut state, source_revision, files, eligible_file_count, 0)
    }

    pub fn clear(&self, source_revision: u64) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        let mut state = self
            .state
            .write()
            .map_err(|_| WorkspaceIndexError::LockPoisoned)?;
        self.publish_locked(&mut state, source_revision, BTreeMap::new(), 0, 0)
    }

    pub(crate) fn chunking(&self) -> ChunkingConfig {
        self.chunking
    }

    pub(crate) fn chunking_strategy(&self) -> WorkspaceChunkingStrategy {
        self.chunking_strategy.clone()
    }

    pub(crate) fn limits(&self) -> ChunkCatalogLimits {
        self.limits
    }

    /// Return the typed lexical engine selected for this catalog.
    pub fn lexical_engine(&self) -> WorkspaceLexicalEngine {
        self.lexical_engine
    }

    pub(crate) fn build_engine(&self) -> WorkspaceLexicalEngine {
        self.build_engine
    }

    pub(crate) fn publish_reconciliation(
        &self,
        expected_revision: u64,
        source_revision: u64,
        files: BTreeMap<String, Arc<CatalogFile>>,
        eligible_file_count: usize,
        failed_file_count: usize,
    ) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        let mut state = self
            .state
            .write()
            .map_err(|_| WorkspaceIndexError::LockPoisoned)?;
        if state.revision != expected_revision {
            return Err(WorkspaceIndexError::ConcurrentUpdate {
                expected: expected_revision,
                actual: state.revision,
            });
        }
        self.publish_locked(
            &mut state,
            source_revision,
            files,
            eligible_file_count,
            failed_file_count,
        )
    }

    fn publish_locked(
        &self,
        state: &mut Arc<CatalogState>,
        source_revision: u64,
        files: BTreeMap<String, Arc<CatalogFile>>,
        eligible_file_count: usize,
        failed_file_count: usize,
    ) -> WorkspaceIndexResult<ChunkCatalogSnapshot> {
        if files.len().saturating_add(failed_file_count) > eligible_file_count {
            return Err(WorkspaceIndexError::InvalidConfig(
                "catalog coverage counts are inconsistent".to_owned(),
            ));
        }
        let usage = CatalogUsage::from_files(files.values(), self.limits)?;
        let chunks = files
            .values()
            .flat_map(|file| file.chunks.iter().cloned())
            .collect::<Vec<_>>();
        if source_revision < state.source_revision {
            return Err(WorkspaceIndexError::StaleRevision {
                requested: source_revision,
                current: state.source_revision,
            });
        }
        let next = Arc::new(CatalogState {
            revision: state.revision.saturating_add(1),
            source_revision,
            files,
            chunks: Arc::from(chunks),
            text_bytes: usage.text_bytes,
            estimated_index_bytes: usage.index_bytes,
            eligible_file_count,
            failed_file_count,
        });
        *state = Arc::clone(&next);
        let snapshot = ChunkCatalogSnapshot {
            state: next,
            lexical_engine: self.lexical_engine,
        };
        self.updates.send_replace(snapshot.clone());
        Ok(snapshot)
    }
}

fn safe_relative_path(path: &str) -> bool {
    !path.is_empty()
        && Path::new(path)
            .components()
            .all(|component| matches!(component, Component::Normal(_) | Component::CurDir))
}

#[derive(Clone, Copy, Debug, Default)]
pub(crate) struct CatalogUsage {
    files: usize,
    chunks: usize,
    text_bytes: usize,
    index_bytes: usize,
}

impl CatalogUsage {
    pub(crate) fn from_files<'a>(
        files: impl IntoIterator<Item = &'a Arc<CatalogFile>>,
        limits: ChunkCatalogLimits,
    ) -> WorkspaceIndexResult<Self> {
        let mut usage = Self::default();
        for file in files {
            usage.try_add(file, limits)?;
        }
        Ok(usage)
    }

    pub(crate) fn try_add(
        &mut self,
        file: &CatalogFile,
        limits: ChunkCatalogLimits,
    ) -> WorkspaceIndexResult<()> {
        let requested_files = self.files.saturating_add(1);
        let requested_chunks = self.chunks.saturating_add(file.chunks.len());
        let requested_text = self.text_bytes.saturating_add(file.text_bytes);
        let requested_index = self.index_bytes.saturating_add(file.estimated_index_bytes);
        check_limit("file count", requested_files, limits.max_files)?;
        check_limit("chunk count", requested_chunks, limits.max_chunks)?;
        check_limit("text byte", requested_text, limits.max_text_bytes)?;
        check_limit(
            "index byte estimate",
            requested_index,
            limits.max_index_bytes,
        )?;
        self.files = requested_files;
        self.chunks = requested_chunks;
        self.text_bytes = requested_text;
        self.index_bytes = requested_index;
        Ok(())
    }
}

fn check_limit(resource: &'static str, requested: usize, limit: usize) -> WorkspaceIndexResult<()> {
    if requested > limit {
        return Err(WorkspaceIndexError::BudgetExceeded {
            resource,
            requested,
            limit,
        });
    }
    Ok(())
}

#[derive(Default)]
pub(crate) struct CatalogState {
    pub(crate) revision: u64,
    pub(crate) source_revision: u64,
    pub(crate) files: BTreeMap<String, Arc<CatalogFile>>,
    pub(crate) chunks: Arc<[Arc<WorkspaceChunk>]>,
    pub(crate) text_bytes: usize,
    pub(crate) estimated_index_bytes: usize,
    pub(crate) eligible_file_count: usize,
    pub(crate) failed_file_count: usize,
}

pub(crate) struct CatalogFile {
    pub(crate) manifest: LocalWorkspaceFile,
    pub(crate) content_digest: Arc<str>,
    pub(crate) chunks: Arc<[Arc<WorkspaceChunk>]>,
    pub(crate) lexical: Arc<LexicalPartition>,
    pub(crate) text_bytes: usize,
    pub(crate) estimated_index_bytes: usize,
}

impl CatalogFile {
    pub(crate) fn build(
        manifest: LocalWorkspaceFile,
        source_revision: u64,
        content: &str,
        chunking: ChunkingConfig,
        chunking_strategy: &WorkspaceChunkingStrategy,
        lexical_engine: WorkspaceLexicalEngine,
    ) -> WorkspaceIndexResult<Self> {
        let chunked = chunk_file_with_strategy(
            ChunkFileRequest {
                path: &manifest.path,
                language: manifest.language.as_deref(),
                source_revision,
                content,
            },
            chunking,
            chunking_strategy,
        )?;
        let chunks: Arc<[Arc<WorkspaceChunk>]> = Arc::from(chunked.chunks);
        let lexical = Arc::new(LexicalPartition::build(
            Arc::clone(&chunks),
            lexical_engine,
        )?);
        let estimated_index_bytes = lexical
            .estimated_bytes()
            .saturating_add(
                chunks
                    .len()
                    .saturating_mul(std::mem::size_of::<WorkspaceChunk>()),
            )
            .saturating_add(manifest.path.capacity())
            .saturating_add(chunked.content_digest.len());
        Ok(Self {
            manifest,
            content_digest: chunked.content_digest,
            chunks,
            lexical,
            text_bytes: chunked.text_bytes,
            estimated_index_bytes,
        })
    }

    pub(crate) fn matches_manifest(&self, candidate: &LocalWorkspaceFile) -> bool {
        self.manifest.path == candidate.path
            && self.manifest.size == candidate.size
            && self.manifest.modified_ms == candidate.modified_ms
            && self.manifest.language == candidate.language
            && self.manifest.binary == candidate.binary
            && self.manifest.generated == candidate.generated
    }

    pub(crate) fn with_manifest(&self, manifest: LocalWorkspaceFile) -> Self {
        Self {
            manifest,
            content_digest: Arc::clone(&self.content_digest),
            chunks: Arc::clone(&self.chunks),
            lexical: Arc::clone(&self.lexical),
            text_bytes: self.text_bytes,
            estimated_index_bytes: self.estimated_index_bytes,
        }
    }
}