agentty 0.10.1

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
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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
//! App-wide background task helpers for requested-review loads, version
//! checks, and review-assist generation.
//!
//! Recurring git-status and review-request polling lives in the sync
//! orchestrator (`app/sync.rs`); this module keeps one-shot background tasks.

use std::future::Future;
use std::path::{Path, PathBuf};
use std::pin::Pin;
use std::sync::Arc;

use ag_forge::ReviewRequestClient;
use askama::Template;
use tokio::sync::mpsc;

use crate::app::error::AppError;
use crate::app::{AppEvent, UpdateStatus};
use crate::domain::agent::{AgentKind, AgentModel, ReasoningLevel};
use crate::domain::session::SessionId;
use crate::infra::agent;
use crate::infra::git::GitClient;
use crate::version;

/// Stateless helpers for app-scoped one-shot background tasks and app-server
/// session execution.
pub(super) struct TaskService;

/// Inputs needed to generate review assist text in the background.
pub(super) struct ReviewAssistTaskInput {
    pub(super) app_event_tx: mpsc::UnboundedSender<AppEvent>,
    /// Hash of the diff that triggered this review, threaded back in the
    /// completion event so the reducer can store it without re-reading cache.
    pub(super) diff_hash: u64,
    pub(super) review_diff: String,
    pub(super) review_model: AgentModel,
    pub(super) session_folder: PathBuf,
    pub(super) session_id: SessionId,
    pub(super) session_summary: Option<String>,
}

/// Askama view model for rendering review assist prompts.
#[derive(Template)]
#[template(path = "review_assist_prompt.md", escape = "none")]
struct ReviewAssistPromptTemplate<'a> {
    /// Full diff payload wrapped in a Markdown fence sized for its content.
    fenced_diff: &'a str,
    /// Prior session summary used to give the review model continuity.
    session_summary: &'a str,
}

impl TaskService {
    /// Loads one fresh machine-scoped snapshot of locally runnable agent
    /// kinds behind the injected availability boundary.
    pub(super) async fn load_agent_availability(
        availability_probe: Arc<dyn agent::AgentAvailabilityProbe>,
    ) -> Vec<AgentKind> {
        tokio::task::spawn_blocking(move || availability_probe.available_agent_kinds())
            .await
            .unwrap_or_else(|_| AgentKind::ALL.to_vec())
    }

    /// Spawns one requested-review refresh for the active project.
    ///
    /// The task resolves the project remote through the injected git boundary,
    /// asks the forge client for open PRs/MRs requesting the authenticated
    /// user's review, and reports the result through [`AppEvent`] with the
    /// generation that lets the reducer discard stale completions.
    pub(super) fn spawn_requested_reviews_task(
        generation: u64,
        project_id: i64,
        working_dir: PathBuf,
        app_event_tx: mpsc::UnboundedSender<AppEvent>,
        git_client: Arc<dyn GitClient>,
        review_request_client: Arc<dyn ReviewRequestClient>,
    ) {
        tokio::spawn(async move {
            let result = load_requested_reviews(
                working_dir,
                git_client.as_ref(),
                review_request_client.as_ref(),
            )
            .await;
            let _ = app_event_tx.send(AppEvent::RequestedReviewsLoaded {
                generation,
                project_id,
                result,
            });
        });
    }

    /// Spawns a one-shot background check for newer `agentty` versions on
    /// npmjs, optionally followed by an automatic `npm i -g agentty@latest`
    /// update.
    ///
    /// The task emits [`AppEvent::VersionAvailabilityUpdated`] with
    /// `Some("vX.Y.Z")` only when a newer version is detected. When
    /// `auto_update` is `true` and a newer version exists, the task
    /// subsequently emits [`AppEvent::UpdateStatusChanged`] with
    /// `InProgress`, then `Complete` or `Failed` depending on the npm
    /// install outcome.
    ///
    /// In tests, it emits an immediate `None` update instead of spawning the
    /// network check so test runs stay deterministic and offline.
    pub(super) fn spawn_version_check_task(
        app_event_tx: &mpsc::UnboundedSender<AppEvent>,
        auto_update: bool,
    ) {
        #[cfg(test)]
        {
            let _ = auto_update;
            // Fire-and-forget: receiver may be dropped during shutdown.
            let _ = app_event_tx.send(Self::version_availability_event(None));
        }

        #[cfg(not(test))]
        let app_event_tx = app_event_tx.clone();

        #[cfg(not(test))]
        tokio::spawn(async move {
            let latest_version_tag = version::latest_npm_version_tag().await;
            let version_event = Self::version_availability_event(latest_version_tag);

            let newer_version = match &version_event {
                AppEvent::VersionAvailabilityUpdated {
                    latest_available_version: Some(version),
                } => Some(version.clone()),
                _ => None,
            };

            // Fire-and-forget: receiver may be dropped during shutdown.
            let _ = app_event_tx.send(version_event);

            if let Some(newer_version) = newer_version
                && auto_update
            {
                Self::run_background_update(&app_event_tx, &newer_version).await;
            }
        });
    }

    /// Runs `npm i -g agentty@latest` in a background blocking task and
    /// emits update progress events.
    #[cfg(not(test))]
    async fn run_background_update(
        app_event_tx: &mpsc::UnboundedSender<AppEvent>,
        newer_version: &str,
    ) {
        // Fire-and-forget: receiver may be dropped during shutdown.
        let _ = app_event_tx.send(AppEvent::UpdateStatusChanged {
            update_status: UpdateStatus::InProgress {
                version: newer_version.to_string(),
            },
        });

        let update_result = tokio::task::spawn_blocking(move || {
            let update_runner = version::RealUpdateRunner;
            version::run_npm_update_sync(&update_runner)
        })
        .await;

        let update_status = match update_result {
            Ok(Ok(_)) => UpdateStatus::Complete {
                version: newer_version.to_string(),
            },
            Ok(Err(_)) | Err(_) => UpdateStatus::Failed {
                version: newer_version.to_string(),
            },
        };

        // Fire-and-forget: receiver may be dropped during shutdown.
        let _ = app_event_tx.send(AppEvent::UpdateStatusChanged { update_status });
    }

    /// Spawns one background review assist generation task and emits
    /// an event with either final review text or a failure description.
    pub(super) fn spawn_review_assist_task(input: ReviewAssistTaskInput) {
        let ReviewAssistTaskInput {
            app_event_tx,
            diff_hash,
            review_diff,
            review_model,
            session_folder,
            session_id,
            session_summary,
        } = input;

        tokio::spawn(async move {
            let review_result = Self::review_assist_text(
                &session_folder,
                review_model,
                &review_diff,
                session_summary.as_deref(),
            )
            .await;

            let app_event = Self::review_app_event(diff_hash, review_result, session_id);
            // Fire-and-forget: receiver may be dropped during shutdown.
            let _ = app_event_tx.send(app_event);
        });
    }

    /// Generates review assist text by running one model command with
    /// read-only review constraints and parsing the final assistant response
    /// content.
    async fn review_assist_text(
        session_folder: &Path,
        review_model: AgentModel,
        review_diff: &str,
        session_summary: Option<&str>,
    ) -> Result<String, AppError> {
        Self::review_assist_text_with_submitter(
            session_folder,
            review_model,
            review_diff,
            session_summary,
            |review_folder, review_model, review_prompt| {
                Box::pin(async move {
                    agent::submit_one_shot(agent::OneShotRequest {
                        child_pid: None,
                        folder: review_folder,
                        model: review_model,
                        prompt: review_prompt,
                        request_kind: crate::infra::channel::AgentRequestKind::UtilityPrompt,
                        reasoning_level: ReasoningLevel::default(),
                    })
                    .await
                })
            },
        )
        .await
    }

    /// Converts a raw version lookup result into the reducer event consumed by
    /// app state.
    fn version_availability_event(latest_version_tag: Option<String>) -> AppEvent {
        let latest_available_version = latest_version_tag.filter(|latest_version| {
            version::is_newer_than_current_version(env!("CARGO_PKG_VERSION"), latest_version)
        });

        AppEvent::VersionAvailabilityUpdated {
            latest_available_version,
        }
    }

    /// Generates review assist text using an injected one-shot submitter so
    /// failure paths can be tested without subprocess execution.
    async fn review_assist_text_with_submitter<Submitter>(
        session_folder: &Path,
        review_model: AgentModel,
        review_diff: &str,
        session_summary: Option<&str>,
        submitter: Submitter,
    ) -> Result<String, AppError>
    where
        Submitter: for<'submit> FnOnce(
            &'submit Path,
            AgentModel,
            &'submit str,
        ) -> Pin<
            Box<dyn Future<Output = Result<agent::AgentResponse, String>> + Send + 'submit>,
        >,
    {
        let review_prompt = Self::review_assist_prompt(review_diff, session_summary)?;
        let agent_response = submitter(session_folder, review_model, &review_prompt)
            .await
            .map_err(AppError::Workflow)?;

        Self::review_output_text(&agent_response)
    }

    /// Builds the final reducer event for one review-assist task outcome.
    ///
    /// Converts the typed [`AppError`] to a display string at the event
    /// boundary because [`AppEvent`] requires `Clone` + `Eq`, which
    /// [`AppError`] cannot satisfy due to non-cloneable inner IO errors.
    fn review_app_event(
        diff_hash: u64,
        review_result: Result<String, AppError>,
        session_id: SessionId,
    ) -> AppEvent {
        match review_result {
            Ok(review_text) => AppEvent::ReviewPrepared {
                diff_hash,
                review_text,
                session_id,
            },
            Err(error) => AppEvent::ReviewPreparationFailed {
                diff_hash,
                error: error.to_string(),
                session_id,
            },
        }
    }

    /// Extracts one non-empty review string from the agent response payload.
    fn review_output_text(agent_response: &agent::AgentResponse) -> Result<String, AppError> {
        let review_text = agent_response.to_display_text();
        let review_text = review_text.trim();
        if review_text.is_empty() {
            return Err(AppError::Workflow(
                "Review assist returned empty output".to_string(),
            ));
        }

        Ok(review_text.to_string())
    }

    /// Renders the review assist prompt from the markdown template.
    ///
    /// # Errors
    /// Returns an error when Askama template rendering fails.
    fn review_assist_prompt(
        review_diff: &str,
        session_summary: Option<&str>,
    ) -> Result<String, AppError> {
        let trimmed_diff = review_diff.trim();
        let fence = agent::diff_fence(trimmed_diff);
        let fenced_diff = format!("{fence}diff\n{trimmed_diff}\n{fence}");
        let template = ReviewAssistPromptTemplate {
            fenced_diff: &fenced_diff,
            session_summary: session_summary.map_or("", str::trim),
        };

        template.render().map_err(|error| {
            AppError::Workflow(format!(
                "Failed to render `review_assist_prompt.md`: {error}"
            ))
        })
    }
}

/// Resolves the active project remote and loads PRs/MRs requesting the current
/// authenticated user's review.
async fn load_requested_reviews(
    working_dir: PathBuf,
    git_client: &dyn GitClient,
    review_request_client: &dyn ReviewRequestClient,
) -> Result<Vec<ag_forge::RequestedReview>, String> {
    let repo_url = git_client
        .repo_url(working_dir.clone())
        .await
        .map_err(|error| format!("Failed to resolve repository remote: {error}"))?;
    let remote = review_request_client
        .detect_remote(repo_url)
        .map(|remote| remote.with_command_working_directory(working_dir))
        .map_err(|error| error.detail_message())?;

    review_request_client
        .list_requested_reviews(remote)
        .await
        .map_err(|error| error.detail_message())
}

#[cfg(test)]
mod tests {
    use std::path::Path;
    use std::time::Duration;

    use super::*;
    use crate::infra::agent::protocol::AgentResponse;

    #[tokio::test]
    /// Ensures test-mode version checks still emit one reducer event without
    /// touching the network.
    async fn spawn_version_check_task_emits_none_update_in_tests() {
        // Arrange
        let (app_event_tx, mut app_event_rx) = mpsc::unbounded_channel();

        // Act
        TaskService::spawn_version_check_task(&app_event_tx, true);
        let app_event = tokio::time::timeout(Duration::from_secs(1), app_event_rx.recv())
            .await
            .expect("timed out waiting for version-check event")
            .expect("version-check task should emit one event");

        // Assert
        assert_eq!(
            app_event,
            AppEvent::VersionAvailabilityUpdated {
                latest_available_version: None,
            }
        );
    }

    #[tokio::test]
    /// Ensures the `--no-update` flag (`auto_update=false`) still emits a
    /// version availability event without triggering an update.
    async fn spawn_version_check_task_with_no_update_emits_version_event() {
        // Arrange
        let (app_event_tx, mut app_event_rx) = mpsc::unbounded_channel();

        // Act
        TaskService::spawn_version_check_task(&app_event_tx, false);
        let app_event = tokio::time::timeout(Duration::from_secs(1), app_event_rx.recv())
            .await
            .expect("timed out waiting for version-check event")
            .expect("version-check task should emit one event");

        // Assert — still emits version check, no update events
        assert_eq!(
            app_event,
            AppEvent::VersionAvailabilityUpdated {
                latest_available_version: None,
            }
        );
    }

    #[test]
    /// Verifies version availability keeps only tags newer than the current
    /// crate version.
    fn version_availability_event_keeps_newer_version_tags() {
        // Arrange
        let latest_version_tag = Some("v999.0.0".to_string());

        // Act
        let app_event = TaskService::version_availability_event(latest_version_tag);

        // Assert
        assert_eq!(
            app_event,
            AppEvent::VersionAvailabilityUpdated {
                latest_available_version: Some("v999.0.0".to_string()),
            }
        );
    }

    #[test]
    /// Verifies version availability suppresses current-version tags so the
    /// UI only announces true upgrades.
    fn version_availability_event_ignores_current_version_tag() {
        // Arrange
        let latest_version_tag = Some(format!("v{}", env!("CARGO_PKG_VERSION")));

        // Act
        let app_event = TaskService::version_availability_event(latest_version_tag);

        // Assert
        assert_eq!(
            app_event,
            AppEvent::VersionAvailabilityUpdated {
                latest_available_version: None,
            }
        );
    }

    #[tokio::test]
    /// Ensures review assist surfaces one-shot submission failures as
    /// [`AppError::Workflow`] without invoking a real subprocess.
    async fn review_assist_text_with_submitter_returns_workflow_error_on_submit_failure() {
        // Arrange
        let session_folder = Path::new("/tmp/review-assist-submit-error");
        let review_model = AgentModel::ClaudeSonnet46;
        let review_diff = "diff --git a/src/lib.rs b/src/lib.rs";

        // Act
        let result = TaskService::review_assist_text_with_submitter(
            session_folder,
            review_model,
            review_diff,
            None,
            |_, _, _| Box::pin(async { Err("submit failed".to_string()) }),
        )
        .await;

        // Assert
        let error = result.expect_err("submit failure should be returned");
        assert!(
            matches!(error, AppError::Workflow(_)),
            "expected AppError::Workflow, got: {error:?}"
        );
        assert_eq!(error.to_string(), "submit failed");
    }

    #[test]
    /// Verifies review-assist event mapping preserves successful review text.
    fn review_app_event_maps_successful_review_output() {
        // Arrange
        let diff_hash = 7;
        let review_result = Ok("Flagged one missing error branch.".to_string());
        let session_id = "session-7".to_string();

        // Act
        let app_event = TaskService::review_app_event(diff_hash, review_result, session_id.into());

        // Assert
        assert_eq!(
            app_event,
            AppEvent::ReviewPrepared {
                diff_hash: 7,
                review_text: "Flagged one missing error branch.".to_string(),
                session_id: "session-7".into(),
            }
        );
    }

    #[test]
    /// Verifies review-assist event mapping preserves failure details for the
    /// reducer and view-mode status text.
    fn review_app_event_maps_failure_output() {
        // Arrange
        let diff_hash = 9;
        let review_result = Err(AppError::Workflow("empty response".to_string()));
        let session_id = "session-9".to_string();

        // Act
        let app_event = TaskService::review_app_event(diff_hash, review_result, session_id.into());

        // Assert
        assert_eq!(
            app_event,
            AppEvent::ReviewPreparationFailed {
                diff_hash: 9,
                error: "empty response".to_string(),
                session_id: "session-9".into(),
            }
        );
    }

    #[test]
    /// Verifies review output text is trimmed before it is stored in app
    /// state.
    fn review_output_text_trims_agent_response_text() {
        // Arrange
        let agent_response = AgentResponse::plain("  Review looks good.  \n");

        // Act
        let review_text = TaskService::review_output_text(&agent_response)
            .expect("non-empty output should be accepted");

        // Assert
        assert_eq!(review_text, "Review looks good.");
    }

    #[test]
    /// Verifies whitespace-only review output is rejected as
    /// [`AppError::Workflow`] so users see a clear error instead of a blank
    /// review pane.
    fn review_output_text_rejects_blank_agent_response_text() {
        // Arrange
        let agent_response = AgentResponse::plain(" \n\t ");

        // Act
        let result = TaskService::review_output_text(&agent_response);

        // Assert
        let error = result.expect_err("blank output should be rejected");
        assert!(
            matches!(error, AppError::Workflow(_)),
            "expected AppError::Workflow, got: {error:?}"
        );
        assert_eq!(error.to_string(), "Review assist returned empty output");
    }

    #[test]
    /// Ensures review prompt rendering includes read-only constraints
    /// while keeping internet and non-editing verification options available.
    fn test_review_assist_prompt_enforces_read_only_constraints() {
        // Arrange
        let review_diff = "diff --git a/src/lib.rs b/src/lib.rs";
        let session_summary = Some("Refactor parser error mapping.");

        // Act
        let prompt = TaskService::review_assist_prompt(review_diff, session_summary)
            .expect("review prompt should render");

        // Assert
        assert!(prompt.contains("put the Markdown review body in `answer`"));
        assert!(prompt.contains("leave `questions` empty"));
        assert!(prompt.contains("set `summary` to null"));
        assert!(!prompt.contains("Return Markdown only."));
        assert!(prompt.contains("You are in read-only review mode."));
        assert!(prompt.contains("Do not create, modify, rename, or delete files."));
        assert!(prompt.contains("You may browse the internet when needed."));
        assert!(prompt.contains("You may run non-editing CLI commands"));
        assert!(prompt.contains("Use the surrounding Agentty protocol for file-reference"));
        let fenced_diff = format!("```diff\n{review_diff}\n```");
        assert!(
            prompt.contains(&fenced_diff),
            "review prompt must wrap the diff in a ```diff``` fence so `@`-prefixed decorator \
             tokens are not misread as file mentions"
        );
        assert!(prompt.contains("`@`-prefixed tokens inside the diff"));
    }

    #[test]
    /// Ensures the review prompt widens the outer code fence when the diff
    /// contains a triple-backtick sequence of its own so the Markdown boundary
    /// cannot be terminated by the diff content itself.
    fn test_review_assist_prompt_escapes_triple_backtick_fence_in_diff() {
        // Arrange
        let review_diff = concat!(
            "diff --git a/notes.md b/notes.md\n",
            "+```\n",
            "+example fenced block\n",
            "+```\n",
        );
        let session_summary: Option<&str> = None;

        // Act
        let prompt = TaskService::review_assist_prompt(review_diff, session_summary)
            .expect("review prompt should render");

        // Assert
        assert!(
            prompt.contains("````diff\n"),
            "outer fence must be longer than the longest backtick run in the diff to preserve \
             prompt boundaries"
        );
        let matches = prompt.matches("\n````").count();
        assert!(
            matches >= 2,
            "prompt must contain an opening and closing 4-backtick fence, got {matches} \
             occurrences"
        );
        assert!(prompt.contains("+```\n"));
    }

    #[test]
    /// Verifies that structured `AgentResponse` JSON is unwrapped to plain
    /// display text for focused review rendering.
    fn test_structured_agent_response_is_unwrapped_to_display_text() {
        // Arrange
        let structured_json = r#"{"answer":"Review looks good.","questions":[],"summary":null}"#;

        // Act
        let agent_response = agent::protocol::parse_agent_response_strict(structured_json)
            .expect("structured response should parse");
        let display_text = agent_response.to_display_text();

        // Assert
        assert_eq!(display_text.trim(), "Review looks good.");
    }

    #[test]
    /// Verifies that `UpdateStatusChanged` events for in-progress, complete,
    /// and failed states can be constructed and compared.
    fn update_status_changed_event_roundtrips_all_variants() {
        // Arrange / Act
        let in_progress = AppEvent::UpdateStatusChanged {
            update_status: UpdateStatus::InProgress {
                version: "v1.0.0".to_string(),
            },
        };
        let complete = AppEvent::UpdateStatusChanged {
            update_status: UpdateStatus::Complete {
                version: "v1.0.0".to_string(),
            },
        };
        let failed = AppEvent::UpdateStatusChanged {
            update_status: UpdateStatus::Failed {
                version: "v1.0.0".to_string(),
            },
        };

        // Assert
        assert_ne!(in_progress, complete);
        assert_ne!(complete, failed);
        assert_ne!(in_progress, failed);
    }
}