agentty 0.15.0

Agentty is an ADE (Agentic Development Environment) for structured, controllable AI-assisted software development.
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
//! Shared app dependency container for managers and background workflows.

use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::sync::{Arc, Mutex};
use std::time::Duration;

use ag_agent::{AppServerClient, OneShotClient, RealOneShotClient};
use ag_forge::ReviewRequestClient;
use ag_git::GitClient;
use tokio::sync::mpsc;
use tokio::task::JoinHandle;
use tokio::time::{self, Instant};
use tracing::{debug, warn};

use crate::app::AppEvent;
use crate::db::AppRepositories;
use crate::domain::agent::{AgentCliInfo, AgentKind};
use crate::domain::session::SessionId;
use crate::infra::clipboard_image::{ClipboardImageClient, RealClipboardImageClient};
use crate::infra::clock::Clock;
use crate::infra::fs::FsClient;
use crate::infra::personality::{PersonalityCatalogClient, RealPersonalityCatalogClient};

/// Shared per-app session redraw version counters keyed by session id.
pub(crate) type SessionUpdateVersionMap = Arc<Mutex<HashMap<SessionId, u64>>>;

/// Maximum graceful-shutdown wait shared by all background cleanup tasks.
const CLEANUP_TASK_SHUTDOWN_TIMEOUT: Duration = Duration::from_secs(5);

/// External clients and cached machine-scoped availability injected into
/// [`AppServices`].
pub(crate) struct AppServiceDeps {
    /// Shared provider-owned app-server client override used by tests and
    /// injected environments.
    pub(crate) app_server_client_override: Option<Arc<dyn AppServerClient>>,
    /// Cached locally runnable backends used to scope model selection.
    pub(crate) available_agent_kinds: Vec<AgentKind>,
    /// Optional clipboard image client override used by tests and injected
    /// environments.
    pub(crate) clipboard_image_client_override: Option<Arc<dyn ClipboardImageClient>>,
    /// Shared filesystem client for async filesystem operations.
    pub(crate) fs_client: Arc<dyn FsClient>,
    /// Shared git client for async git operations.
    pub(crate) git_client: Arc<dyn GitClient>,
    /// Optional isolated-prompt client override used by tests and injected
    /// environments.
    pub(crate) one_shot_client_override: Option<Arc<dyn OneShotClient>>,
    /// Optional workspace personality catalog override used by tests.
    pub(crate) personality_catalog_client_override: Option<Arc<dyn PersonalityCatalogClient>>,
    /// Shared repository bundle used by app workflows.
    pub(crate) repositories: AppRepositories,
    /// Shared forge review-request client.
    pub(crate) review_request_client: Arc<dyn ReviewRequestClient>,
}

/// Shared app dependencies used by managers and background workflows.
pub struct AppServices {
    available_agent_clis: Arc<Mutex<Vec<AgentCliInfo>>>,
    available_agent_kinds: Arc<[AgentKind]>,
    app_server_client_override: Option<Arc<dyn AppServerClient>>,
    base_path: PathBuf,
    cleanup_task_handles: Arc<Mutex<Vec<JoinHandle<()>>>>,
    clipboard_image_client: Arc<dyn ClipboardImageClient>,
    clock: Arc<dyn Clock>,
    event_tx: mpsc::UnboundedSender<AppEvent>,
    fs_client: Arc<dyn FsClient>,
    git_client: Arc<dyn GitClient>,
    one_shot_client: Arc<dyn OneShotClient>,
    personality_catalog_client: Arc<dyn PersonalityCatalogClient>,
    repositories: AppRepositories,
    review_request_client: Arc<dyn ReviewRequestClient>,
    session_update_versions: SessionUpdateVersionMap,
}

impl AppServices {
    /// Creates a shared service container with versioned agent CLI
    /// availability captured at startup.
    pub(crate) fn new_with_agent_clis(
        base_path: PathBuf,
        clock: Arc<dyn Clock>,
        event_tx: mpsc::UnboundedSender<AppEvent>,
        deps: AppServiceDeps,
        available_agent_clis: Vec<AgentCliInfo>,
    ) -> Self {
        let AppServiceDeps {
            app_server_client_override,
            available_agent_kinds,
            clipboard_image_client_override,
            fs_client,
            git_client,
            one_shot_client_override,
            personality_catalog_client_override,
            repositories,
            review_request_client,
        } = deps;
        let clipboard_image_client = clipboard_image_client_override.unwrap_or_else(|| {
            Arc::new(RealClipboardImageClient::new(
                Arc::clone(&clock),
                Arc::clone(&fs_client),
            ))
        });
        let one_shot_client = one_shot_client_override.unwrap_or_else(|| {
            Arc::new(RealOneShotClient::new(
                app_server_client_override.as_ref().map(Arc::clone),
            ))
        });
        let personality_catalog_client = personality_catalog_client_override
            .unwrap_or_else(|| Arc::new(RealPersonalityCatalogClient));

        Self {
            available_agent_clis: Arc::new(Mutex::new(available_agent_clis)),
            available_agent_kinds: Arc::<[AgentKind]>::from(available_agent_kinds),
            app_server_client_override,
            base_path,
            cleanup_task_handles: Arc::default(),
            clipboard_image_client,
            clock,
            event_tx,
            fs_client,
            git_client,
            one_shot_client,
            personality_catalog_client,
            repositories,
            review_request_client,
            session_update_versions: Arc::default(),
        }
    }

    /// Returns the session base path.
    pub(crate) fn base_path(&self) -> &Path {
        self.base_path.as_path()
    }

    /// Returns the cached locally runnable agent kinds.
    pub(crate) fn available_agent_kinds(&self) -> Vec<AgentKind> {
        self.available_agent_kinds.as_ref().to_vec()
    }

    /// Returns the cached locally runnable agent CLIs and detected versions.
    pub(crate) fn available_agent_clis(&self) -> Vec<AgentCliInfo> {
        self.available_agent_clis
            .lock()
            .map(|agent_clis| agent_clis.clone())
            .unwrap_or_default()
    }

    /// Replaces the cached CLI rows after background version detection
    /// completes.
    pub(crate) fn replace_available_agent_clis(&self, available_agent_clis: Vec<AgentCliInfo>) {
        if let Ok(mut agent_clis) = self.available_agent_clis.lock() {
            *agent_clis = available_agent_clis;
        }
    }

    /// Returns the application repository bundle.
    pub(crate) fn db(&self) -> &AppRepositories {
        &self.repositories
    }

    /// Returns the shared wall-clock used by session workflows.
    pub(crate) fn clock(&self) -> Arc<dyn Clock> {
        Arc::clone(&self.clock)
    }

    /// Returns the shared clipboard-image client for pasted image capture.
    pub(crate) fn clipboard_image_client(&self) -> Arc<dyn ClipboardImageClient> {
        Arc::clone(&self.clipboard_image_client)
    }

    /// Returns the shared client for isolated structured agent prompts.
    pub(crate) fn one_shot_client(&self) -> Arc<dyn OneShotClient> {
        Arc::clone(&self.one_shot_client)
    }

    /// Returns the workspace personality discovery client.
    pub(crate) fn personality_catalog_client(&self) -> Arc<dyn PersonalityCatalogClient> {
        Arc::clone(&self.personality_catalog_client)
    }

    /// Enqueues an app event onto the internal event bus with debug
    /// instrumentation for producer-side event volume.
    pub(crate) fn emit_app_event(&self, event: AppEvent) {
        let event_label = app_event_label(&event);
        debug!(
            event = event_label,
            "enqueueing app event through app services"
        );

        // Fire-and-forget: receiver may be dropped during shutdown.
        if self.event_tx.send(event).is_err() {
            warn!(
                event = event_label,
                "failed to send app event because the receiver is closed"
            );
        }
    }

    /// Enqueues refresh events for workflows that changed both session
    /// snapshots and project-level session aggregates.
    pub(crate) fn emit_session_and_project_refresh_events(&self) {
        self.emit_app_event(AppEvent::RefreshSessions);
        self.emit_app_event(AppEvent::RefreshProjects);
    }

    /// Tracks one best-effort cleanup task that should complete before the app
    /// finishes graceful shutdown.
    pub(crate) fn track_cleanup_task(&self, join_handle: JoinHandle<()>) {
        if let Ok(mut cleanup_task_handles) = self.cleanup_task_handles.lock() {
            cleanup_task_handles.push(join_handle);
        }
    }

    /// Waits for all tracked cleanup tasks to finish.
    ///
    /// The task list is drained before awaiting so the synchronous mutex guard
    /// is never held across an `.await`. The loop repeats in case a cleanup
    /// task registers additional cleanup work before it exits. All tasks share
    /// one shutdown deadline; unfinished tasks are canceled after it expires.
    pub(crate) async fn wait_for_cleanup_tasks(&self) {
        wait_for_cleanup_task_handles(
            self.cleanup_task_handles.as_ref(),
            CLEANUP_TASK_SHUTDOWN_TIMEOUT,
        )
        .await;
    }

    /// Returns a clone of the app event sender.
    pub(crate) fn event_sender(&self) -> mpsc::UnboundedSender<AppEvent> {
        self.event_tx.clone()
    }

    /// Returns the shared filesystem client for async filesystem operations.
    pub(crate) fn fs_client(&self) -> Arc<dyn FsClient> {
        Arc::clone(&self.fs_client)
    }

    /// Returns the shared git client for async git operations.
    pub(crate) fn git_client(&self) -> Arc<dyn GitClient> {
        Arc::clone(&self.git_client)
    }

    /// Returns the shared forge review-request client.
    pub(crate) fn review_request_client(&self) -> Arc<dyn ReviewRequestClient> {
        Arc::clone(&self.review_request_client)
    }

    /// Returns the shared per-app session update version counters.
    pub(crate) fn session_update_versions(&self) -> SessionUpdateVersionMap {
        Arc::clone(&self.session_update_versions)
    }

    /// Returns the optional app-server client override used by tests and
    /// injected environments.
    pub(crate) fn app_server_client_override(&self) -> Option<Arc<dyn AppServerClient>> {
        self.app_server_client_override.as_ref().map(Arc::clone)
    }
}

/// Waits for tracked cleanup tasks until one shared deadline, then cancels
/// every unfinished task so terminal shutdown can continue.
async fn wait_for_cleanup_task_handles(
    cleanup_task_handles: &Mutex<Vec<JoinHandle<()>>>,
    timeout: Duration,
) {
    let deadline = Instant::now() + timeout;

    loop {
        let task_handles = cleanup_task_handles
            .lock()
            .map(|mut task_handles| task_handles.drain(..).collect::<Vec<_>>())
            .unwrap_or_default();

        if task_handles.is_empty() {
            break;
        }

        for mut task_handle in task_handles {
            match time::timeout_at(deadline, &mut task_handle).await {
                Ok(Ok(())) => {}
                Ok(Err(error)) => {
                    warn!(
                        error = %error,
                        "background cleanup task failed during shutdown"
                    );
                }
                Err(_) => {
                    task_handle.abort();
                    warn!(
                        timeout_seconds = timeout.as_secs(),
                        "background cleanup task exceeded the shutdown deadline and was canceled"
                    );

                    if let Err(error) = task_handle.await
                        && !error.is_cancelled()
                    {
                        warn!(
                            error = %error,
                            "background cleanup task failed while being canceled"
                        );
                    }
                }
            }
        }
    }
}

/// Returns a stable instrumentation label for one app event variant.
fn app_event_label(event: &AppEvent) -> &'static str {
    match event {
        AppEvent::AtMentionEntriesLoaded { .. } => "AtMentionEntriesLoaded",
        AppEvent::DiffPreviewLoaded { .. } => "DiffPreviewLoaded",
        AppEvent::SessionDiffLoaded { .. } => "SessionDiffLoaded",
        AppEvent::GitStatusUpdated { .. } => "GitStatusUpdated",
        AppEvent::VersionAvailabilityUpdated { .. } => "VersionAvailabilityUpdated",
        AppEvent::AgentCliVersionsUpdated { .. } => "AgentCliVersionsUpdated",
        AppEvent::UpdateStatusChanged { .. } => "UpdateStatusChanged",
        AppEvent::SessionModelUpdated { .. } => "SessionModelUpdated",
        AppEvent::SessionPersonalityUpdated { .. } => "SessionPersonalityUpdated",
        AppEvent::SessionReasoningLevelUpdated { .. } => "SessionReasoningLevelUpdated",
        AppEvent::SessionSpeedModeUpdated { .. } => "SessionSpeedModeUpdated",
        AppEvent::RefreshSessions => "RefreshSessions",
        AppEvent::RefreshProjects => "RefreshProjects",
        AppEvent::RefreshGitStatus => "RefreshGitStatus",
        AppEvent::SessionReviewCommentSnapshotLoaded { .. } => "SessionReviewCommentSnapshotLoaded",
        AppEvent::SessionProgressUpdated { .. } => "SessionProgressUpdated",
        AppEvent::SyncMainCompleted { .. } => "SyncMainCompleted",
        AppEvent::SyncMainConflictResolutionStarted { .. } => "SyncMainConflictResolutionStarted",
        AppEvent::SessionDiffStatsUpdated { .. } => "SessionDiffStatsUpdated",
        AppEvent::SessionTitleGenerationFinished { .. } => "SessionTitleGenerationFinished",
        AppEvent::BranchPublishActionCompleted { .. } => "BranchPublishActionCompleted",
        AppEvent::BranchPublishActionResolved { .. } => "BranchPublishActionResolved",
        AppEvent::BranchPublishActionStarted { .. } => "BranchPublishActionStarted",
        AppEvent::SessionQueuedSyncResolved { .. } => "SessionQueuedSyncResolved",
        AppEvent::ReviewPrepared { .. } => "ReviewPrepared",
        AppEvent::ReviewPreparationFailed { .. } => "ReviewPreparationFailed",
        AppEvent::FocusedReviewPersistenceRetry { .. } => "FocusedReviewPersistenceRetry",
        AppEvent::SessionUpdated { .. } => "SessionUpdated",
        AppEvent::AgentResponseReceived { .. } => "AgentResponseReceived",
        AppEvent::StackedParentTurnCompleted { .. } => "StackedParentTurnCompleted",
        AppEvent::StackedParentSyncCompleted { .. } => "StackedParentSyncCompleted",
        AppEvent::StackedParentMergeCompleted { .. } => "StackedParentMergeCompleted",
        AppEvent::SessionWorkflowNoticeUpdated { .. } => "SessionWorkflowNoticeUpdated",
        AppEvent::SessionOrchestrationProgressUpdated { .. } => {
            "SessionOrchestrationProgressUpdated"
        }
        AppEvent::PublishedBranchSyncUpdated { .. } => "PublishedBranchSyncUpdated",
        AppEvent::ReviewRequestStatusUpdated { .. } => "ReviewRequestStatusUpdated",
    }
}

#[cfg(test)]
mod tests {
    use std::future;

    use super::*;

    #[test]
    fn app_event_label_names_session_review_comment_snapshot_loads() {
        // Arrange
        let event = AppEvent::SessionReviewCommentSnapshotLoaded {
            request_id: 1,
            result: Err("forge unavailable".to_string()),
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "SessionReviewCommentSnapshotLoaded");
    }

    #[test]
    fn app_event_label_names_diff_preview_loads() {
        // Arrange
        let event = AppEvent::DiffPreviewLoaded {
            path: "README.md".to_string(),
            request_id: 1,
            result: Ok(ag_git::WorktreeFileContent::Missing),
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "DiffPreviewLoaded");
    }

    #[test]
    fn app_event_label_names_session_diff_loads() {
        // Arrange
        let event = AppEvent::SessionDiffLoaded {
            request_id: 1,
            result: Ok("diff".to_string()),
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "SessionDiffLoaded");
    }

    #[test]
    fn app_event_label_names_focused_review_persistence_retries() {
        // Arrange
        let event = AppEvent::FocusedReviewPersistenceRetry {
            retry: crate::app::review::FocusedReviewPersistenceRetry {
                attempt: 1,
                persistence_update: crate::app::review::FocusedReviewPersistence {
                    diff_hash: Some(42),
                    session_id: "session-id".into(),
                    status: crate::domain::review::FocusedReviewStatus::Ready,
                    text: Some("review".to_string()),
                },
            },
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "FocusedReviewPersistenceRetry");
    }

    #[test]
    fn app_event_label_names_session_diff_stats_updates() {
        // Arrange
        let event = AppEvent::SessionDiffStatsUpdated {
            diff_stats: crate::domain::session::SessionDiffStats::Unknown,
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "SessionDiffStatsUpdated");
    }

    #[test]
    fn app_event_label_names_orchestration_progress_updates() {
        // Arrange
        let event = AppEvent::SessionOrchestrationProgressUpdated {
            progress: Some("Working... protocol: running".to_string()),
            session_id: "controller".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "SessionOrchestrationProgressUpdated");
    }

    #[test]
    fn app_event_label_names_branch_publish_starts() {
        // Arrange
        let event = AppEvent::BranchPublishActionStarted {
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "BranchPublishActionStarted");
    }

    #[test]
    fn app_event_label_names_branch_publish_resolutions() {
        // Arrange
        let event = AppEvent::BranchPublishActionResolved {
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "BranchPublishActionResolved");
    }

    #[test]
    fn app_event_label_names_queued_sync_resolutions() {
        // Arrange
        let event = AppEvent::SessionQueuedSyncResolved {
            session_id: "session-id".into(),
        };

        // Act
        let label = app_event_label(&event);

        // Assert
        assert_eq!(label, "SessionQueuedSyncResolved");
    }

    #[tokio::test]
    async fn cleanup_task_wait_cancels_work_after_shared_deadline() {
        // Arrange
        let (started_tx, started_rx) = tokio::sync::oneshot::channel();
        let task_handle = tokio::spawn(async move {
            let _ = started_tx.send(());
            future::pending::<()>().await;
        });
        let cleanup_task_handles = Mutex::new(vec![task_handle]);
        started_rx.await.expect("cleanup task should start");

        // Act
        time::timeout(
            Duration::from_secs(1),
            wait_for_cleanup_task_handles(&cleanup_task_handles, Duration::from_millis(25)),
        )
        .await
        .expect("cleanup wait should honor its shared deadline");

        // Assert
        assert!(
            cleanup_task_handles
                .lock()
                .expect("cleanup task mutex should remain available")
                .is_empty()
        );
    }
}