1use agent::ThreadStore;
2use anyhow::{Context, Result, anyhow, bail};
3use assistant_tool::ToolWorkingSet;
4use client::proto::LspWorkProgress;
5use futures::channel::mpsc;
6use futures::{FutureExt as _, StreamExt as _, future};
7use gpui::{App, AppContext as _, AsyncApp, Entity, Task};
8use handlebars::Handlebars;
9use language::{Buffer, DiagnosticSeverity, OffsetRangeExt as _};
10use language_model::{
11 LanguageModel, LanguageModelCompletionEvent, LanguageModelRequest, LanguageModelRequestMessage,
12 MessageContent, Role, TokenUsage,
13};
14use project::lsp_store::OpenLspBufferHandle;
15use project::{DiagnosticSummary, Project, ProjectPath};
16use serde::{Deserialize, Serialize};
17use std::cell::RefCell;
18use std::fmt::Write as _;
19use std::fs;
20use std::fs::File;
21use std::io::Write as _;
22use std::path::Path;
23use std::path::PathBuf;
24use std::rc::Rc;
25use std::sync::Arc;
26use std::time::Duration;
27use unindent::Unindent as _;
28use util::ResultExt as _;
29use util::command::new_smol_command;
30use util::markdown::MarkdownString;
31
32use crate::assertions::{AssertionsReport, RanAssertion, RanAssertionResult};
33use crate::example::{Example, ExampleContext, FailedAssertion, JudgeAssertion};
34use crate::{AgentAppState, ToolMetrics};
35
36pub const ZED_REPO_URL: &str = "https://github.com/zed-industries/zed.git";
37
38#[derive(Clone)]
39pub struct ExampleInstance {
40 pub thread: Rc<dyn Example>,
41 pub name: String,
42 pub run_directory: PathBuf,
43 pub log_prefix: String,
44 /// The repetition number for this example (0-based)
45 /// When running multiple repetitions of the same example, each instance is assigned a unique repetition number.
46 /// This affects the worktree path and log prefix to avoid clobbering results between runs.
47 pub repetition: usize,
48 pub repo_path: PathBuf,
49 /// Path to the directory containing the requests and responses for the agentic loop
50 worktrees_dir: PathBuf,
51}
52
53#[derive(Debug, Serialize, Clone)]
54pub struct RunOutput {
55 pub repository_diff: String,
56 pub diagnostic_summary_before: DiagnosticSummary,
57 pub diagnostic_summary_after: DiagnosticSummary,
58 pub diagnostics_before: Option<String>,
59 pub diagnostics_after: Option<String>,
60 pub response_count: usize,
61 pub token_usage: TokenUsage,
62 pub tool_metrics: ToolMetrics,
63 pub last_request: LanguageModelRequest,
64 pub programmatic_assertions: AssertionsReport,
65}
66
67#[derive(Debug, Clone, Serialize, Deserialize)]
68pub struct JudgeDiffInput {
69 pub repository_diff: String,
70 pub assertion: String,
71}
72
73#[derive(Debug, Clone, Serialize, Deserialize)]
74pub struct JudgeThreadInput {
75 pub messages: String,
76 pub assertion: String,
77}
78
79#[derive(Debug, Clone, Serialize, Deserialize)]
80pub struct JudgeOutput {
81 pub thread: AssertionsReport,
82 pub diff: AssertionsReport,
83}
84
85impl ExampleInstance {
86 pub fn new(
87 thread: Rc<dyn Example>,
88 repos_dir: &Path,
89 run_dir: &Path,
90 worktrees_dir: &Path,
91 repetition: usize,
92 ) -> Self {
93 let name = thread.meta().name.to_string();
94 let run_directory = run_dir
95 .join(&name)
96 .join(repetition.to_string())
97 .to_path_buf();
98
99 let repo_path = repo_path_for_url(repos_dir, &thread.meta().url);
100
101 Self {
102 name,
103 thread,
104 log_prefix: String::new(),
105 run_directory,
106 repetition,
107 repo_path,
108 worktrees_dir: worktrees_dir.to_path_buf(),
109 }
110 }
111
112 pub fn repo_url(&self) -> String {
113 self.thread.meta().url
114 }
115
116 pub fn revision(&self) -> String {
117 self.thread.meta().revision
118 }
119
120 pub fn worktree_name(&self) -> String {
121 format!("{}-{}", self.name, self.repetition)
122 }
123
124 pub fn set_log_prefix_style(&mut self, color: &str, name_width: usize) {
125 self.log_prefix = format!(
126 "{}{:<width$}\x1b[0m | ",
127 color,
128 self.worktree_name(),
129 width = name_width
130 );
131 }
132
133 /// Set up the example by checking out the specified Git revision
134 pub async fn fetch(&mut self) -> Result<()> {
135 let meta = self.thread.meta();
136
137 let revision_exists = run_git(
138 &self.repo_path,
139 &["rev-parse", &format!("{}^{{commit}}", &meta.revision)],
140 )
141 .await
142 .is_ok();
143
144 if !revision_exists {
145 println!("{}Fetching revision {}", self.log_prefix, &meta.revision);
146 run_git(
147 &self.repo_path,
148 &["fetch", "--depth", "1", "origin", &meta.revision],
149 )
150 .await?;
151 }
152 Ok(())
153 }
154
155 /// Set up the example by checking out the specified Git revision
156 pub async fn setup(&mut self) -> Result<()> {
157 let worktree_path = self.worktree_path();
158 let meta = self.thread.meta();
159 if worktree_path.is_dir() {
160 println!("{}Resetting existing worktree", self.log_prefix);
161
162 // TODO: consider including "-x" to remove ignored files. The downside of this is that
163 // it will also remove build artifacts, and so prevent incremental reuse there.
164 run_git(&worktree_path, &["clean", "--force", "-d"]).await?;
165 run_git(&worktree_path, &["reset", "--hard", "HEAD"]).await?;
166 run_git(&worktree_path, &["checkout", &meta.revision]).await?;
167 } else {
168 println!("{}Creating worktree", self.log_prefix);
169
170 let worktree_path_string = worktree_path.to_string_lossy().to_string();
171
172 run_git(
173 &self.repo_path,
174 &[
175 "worktree",
176 "add",
177 "-f",
178 &worktree_path_string,
179 &meta.revision,
180 ],
181 )
182 .await?;
183 }
184
185 if meta.url == ZED_REPO_URL {
186 std::fs::write(worktree_path.join(".rules"), std::fs::read(".rules")?)?;
187 }
188
189 std::fs::create_dir_all(&self.run_directory)?;
190
191 Ok(())
192 }
193
194 pub fn worktree_path(&self) -> PathBuf {
195 self.worktrees_dir
196 .join(self.worktree_name())
197 .join(self.thread.meta().repo_name())
198 }
199
200 pub fn run(
201 &self,
202 model: Arc<dyn LanguageModel>,
203 app_state: Arc<AgentAppState>,
204 cx: &mut App,
205 ) -> Task<Result<RunOutput>> {
206 let project = Project::local(
207 app_state.client.clone(),
208 app_state.node_runtime.clone(),
209 app_state.user_store.clone(),
210 app_state.languages.clone(),
211 app_state.fs.clone(),
212 None,
213 cx,
214 );
215
216 let worktree = project.update(cx, |project, cx| {
217 project.create_worktree(self.worktree_path(), true, cx)
218 });
219
220 let tools = cx.new(|_| ToolWorkingSet::default());
221 let thread_store =
222 ThreadStore::load(project.clone(), tools, app_state.prompt_builder.clone(), cx);
223 let meta = self.thread.meta();
224 let this = self.clone();
225
226 cx.spawn(async move |cx| {
227 let worktree = worktree.await?;
228
229 // Wait for worktree scan to finish before choosing a file to open.
230 worktree
231 .update(cx, |worktree, _cx| {
232 worktree.as_local().unwrap().scan_complete()
233 })?
234 .await;
235
236 struct LanguageServerState {
237 _lsp_open_handle: OpenLspBufferHandle,
238 language_file_buffer: Entity<Buffer>,
239 }
240
241 let mut diagnostics_before = None;
242 let mut diagnostic_summary_before = DiagnosticSummary::default();
243
244 let lsp = if let Some(language_server) = &meta.language_server {
245 // Open a file that matches the language to cause LSP to start.
246 let language_file = worktree.read_with(cx, |worktree, _cx| {
247 worktree
248 .files(false, 0)
249 .find_map(|e| {
250 if e.path.clone().extension().and_then(|ext| ext.to_str())
251 == Some(&language_server.file_extension)
252 {
253 Some(ProjectPath {
254 worktree_id: worktree.id(),
255 path: e.path.clone(),
256 })
257 } else {
258 None
259 }
260 })
261 .context("Failed to find a file for example language")
262 })??;
263
264 let open_language_file_buffer_task = project.update(cx, |project, cx| {
265 project.open_buffer(language_file.clone(), cx)
266 })?;
267
268 let language_file_buffer = open_language_file_buffer_task.await?;
269
270 let lsp_open_handle = project.update(cx, |project, cx| {
271 project.register_buffer_with_language_servers(&language_file_buffer, cx)
272 })?;
273
274 wait_for_lang_server(&project, &language_file_buffer, this.log_prefix.clone(), cx).await?;
275
276 diagnostic_summary_before = project.read_with(cx, |project, cx| {
277 project.diagnostic_summary(false, cx)
278 })?;
279
280 diagnostics_before = query_lsp_diagnostics(project.clone(), cx).await?;
281 if diagnostics_before.is_some() && language_server.allow_preexisting_diagnostics {
282 return Err(anyhow!("Example has pre-existing diagnostics. If you want to run this example regardless, set `allow_preexisting_diagnostics` to `true` in `base.toml`"));
283 }
284
285 Some(LanguageServerState {
286 _lsp_open_handle: lsp_open_handle,
287 language_file_buffer,
288 })
289 } else {
290 None
291 };
292
293 if std::env::var("ZED_EVAL_SETUP_ONLY").is_ok() {
294 return Err(anyhow!("Setup only mode"));
295 }
296
297 let last_diff_file_path = this.run_directory.join("last.diff");
298
299 // Write an empty "last.diff" so that it can be opened in Zed for convenient view of the
300 // history using undo/redo.
301 std::fs::write(&last_diff_file_path, "")?;
302
303 let thread_store = thread_store.await?;
304 let thread =
305 thread_store.update(cx, |thread_store, cx| thread_store.create_thread(cx))?;
306 let last_request = Rc::new(RefCell::new(None));
307
308 thread.update(cx, |thread, _cx| {
309 let mut request_count = 0;
310 let last_request = Rc::clone(&last_request);
311 let previous_diff = Rc::new(RefCell::new("".to_string()));
312 let example_output_dir = this.run_directory.clone();
313 let last_diff_file_path = last_diff_file_path.clone();
314 let messages_json_file_path = example_output_dir.join("last.messages.json");
315 let this = this.clone();
316 thread.set_request_callback(move |request, response_events| {
317 *last_request.borrow_mut() = Some(request.clone());
318
319 request_count += 1;
320 let messages_file_path = example_output_dir.join(format!("{request_count}.messages.md"));
321 let diff_file_path = example_output_dir.join(format!("{request_count}.diff"));
322 let last_messages_file_path = example_output_dir.join("last.messages.md");
323 let request_markdown = RequestMarkdown::new(request);
324 let response_events_markdown = response_events_to_markdown(response_events);
325 let dialog = ThreadDialog::new(request, response_events);
326 let dialog_json = serde_json::to_string_pretty(&dialog.to_combined_request()).unwrap_or_default();
327
328 let messages = format!("{}\n\n{}", request_markdown.messages, response_events_markdown);
329 fs::write(&messages_file_path, messages.clone()).expect("failed to write messages file");
330 fs::write(&last_messages_file_path, messages).expect("failed to write last messages file");
331 fs::write(&messages_json_file_path, dialog_json).expect("failed to write last.messages.json");
332
333 let diff_result = smol::block_on(this.repository_diff());
334 match diff_result {
335 Ok(diff) => {
336 if diff != previous_diff.borrow().clone() {
337 fs::write(&diff_file_path, &diff).expect("failed to write diff file");
338 fs::write(&last_diff_file_path, &diff).expect("failed to write last diff file");
339 *previous_diff.borrow_mut() = diff;
340 }
341 }
342 Err(err) => {
343 let error_message = format!("{err:?}");
344 fs::write(&diff_file_path, &error_message).expect("failed to write diff error to file");
345 fs::write(&last_diff_file_path, &error_message).expect("failed to write last diff file");
346 }
347 }
348
349 if request_count == 1 {
350 let tools_file_path = example_output_dir.join("tools.md");
351 fs::write(tools_file_path, request_markdown.tools).expect("failed to write tools file");
352 }
353 });
354 })?;
355
356 let mut example_cx = ExampleContext::new(meta.clone(), this.log_prefix.clone(), thread.clone(), model.clone(), cx.clone());
357 let result = this.thread.conversation(&mut example_cx).await;
358
359 if let Err(err) = result {
360 if !err.is::<FailedAssertion>() {
361 return Err(err);
362 }
363 }
364
365 println!("{}Stopped", this.log_prefix);
366
367 println!("{}Getting repository diff", this.log_prefix);
368 let repository_diff = this.repository_diff().await?;
369
370 std::fs::write(last_diff_file_path, &repository_diff)?;
371
372
373 let mut diagnostics_after = None;
374 let mut diagnostic_summary_after = Default::default();
375
376 if let Some(language_server_state) = lsp {
377 wait_for_lang_server(&project, &language_server_state.language_file_buffer, this.log_prefix.clone(), cx).await?;
378
379 println!("{}Getting diagnostics", this.log_prefix);
380 diagnostics_after = cx
381 .update(|cx| {
382 let project = project.clone();
383 cx.spawn(async move |cx| query_lsp_diagnostics(project, cx).await)
384 })?
385 .await?;
386 println!("{}Got diagnostics", this.log_prefix);
387
388 diagnostic_summary_after = project.read_with(cx, |project, cx| {
389 project.diagnostic_summary(false, cx)
390 })?;
391
392 }
393
394 let Some(last_request) = last_request.borrow_mut().take() else {
395 return Err(anyhow!("No requests ran."));
396 };
397
398 if let Some(diagnostics_before) = &diagnostics_before {
399 fs::write(this.run_directory.join("diagnostics_before.txt"), diagnostics_before)?;
400 }
401
402 if let Some(diagnostics_after) = &diagnostics_after {
403 fs::write(this.run_directory.join("diagnostics_after.txt"), diagnostics_after)?;
404 }
405
406 thread.update(cx, |thread, _cx| {
407 let response_count = thread
408 .messages()
409 .filter(|message| message.role == language_model::Role::Assistant)
410 .count();
411 RunOutput {
412 repository_diff,
413 diagnostic_summary_before,
414 diagnostic_summary_after,
415 diagnostics_before,
416 diagnostics_after,
417 response_count,
418 token_usage: thread.cumulative_token_usage(),
419 tool_metrics: example_cx.tool_metrics.lock().unwrap().clone(),
420 last_request,
421 programmatic_assertions: example_cx.assertions,
422 }
423 })
424 })
425 }
426
427 async fn repository_diff(&self) -> Result<String> {
428 let worktree_path = self.worktree_path();
429 run_git(&worktree_path, &["add", "."]).await?;
430 let mut diff_args = vec!["diff", "--staged"];
431 if self.thread.meta().url == ZED_REPO_URL {
432 diff_args.push(":(exclude).rules");
433 }
434 run_git(&worktree_path, &diff_args).await
435 }
436
437 pub async fn judge(
438 &self,
439 model: Arc<dyn LanguageModel>,
440 run_output: &RunOutput,
441 cx: &AsyncApp,
442 ) -> JudgeOutput {
443 let mut output_file =
444 File::create(self.run_directory.join("judge.md")).expect("failed to create judge.md");
445
446 let diff_task = self.judge_diff(model.clone(), &run_output, cx);
447 let thread_task = self.judge_thread(model.clone(), &run_output, cx);
448
449 let (diff_result, thread_result) = futures::join!(diff_task, thread_task);
450
451 let (diff_response, diff_output) = diff_result;
452 let (thread_response, thread_output) = thread_result;
453
454 writeln!(
455 &mut output_file,
456 "# Judgment\n\n## Thread\n\n{thread_response}\n\n## Diff\n\n{diff_response}",
457 )
458 .log_err();
459
460 JudgeOutput {
461 thread: thread_output,
462 diff: diff_output,
463 }
464 }
465
466 async fn judge_diff(
467 &self,
468 model: Arc<dyn LanguageModel>,
469 run_output: &RunOutput,
470 cx: &AsyncApp,
471 ) -> (String, AssertionsReport) {
472 let diff_assertions = self.thread.diff_assertions();
473
474 if diff_assertions.is_empty() {
475 return (
476 "No diff assertions".to_string(),
477 AssertionsReport::default(),
478 );
479 }
480
481 println!("{}Running diff judge", self.log_prefix);
482
483 let judge_diff_prompt = include_str!("judge_diff_prompt.hbs");
484 let judge_diff_prompt_name = "judge_diff_prompt";
485 let mut hbs = Handlebars::new();
486 hbs.register_template_string(judge_diff_prompt_name, judge_diff_prompt)
487 .unwrap();
488
489 let to_prompt = |assertion: String| {
490 hbs.render(
491 judge_diff_prompt_name,
492 &JudgeDiffInput {
493 repository_diff: run_output.repository_diff.clone(),
494 assertion,
495 },
496 )
497 .unwrap()
498 };
499
500 let (responses, report) = self
501 .judge_assertions(model, diff_assertions, to_prompt, cx)
502 .await;
503
504 println!(
505 "{}Judge - Diff score: {}%",
506 self.log_prefix,
507 report.passed_percentage()
508 );
509
510 (responses, report)
511 }
512
513 async fn judge_thread(
514 &self,
515 model: Arc<dyn LanguageModel>,
516 run_output: &RunOutput,
517 cx: &AsyncApp,
518 ) -> (String, AssertionsReport) {
519 let thread_assertions = self.thread.thread_assertions();
520
521 if thread_assertions.is_empty() {
522 return (
523 "No diff assertions".to_string(),
524 AssertionsReport::default(),
525 );
526 }
527
528 let judge_thread_prompt = include_str!("judge_thread_prompt.hbs");
529 let judge_diff_prompt_name = "judge_thread_prompt";
530 let mut hbs = Handlebars::new();
531 hbs.register_template_string(judge_diff_prompt_name, judge_thread_prompt)
532 .unwrap();
533
534 let request_markdown = RequestMarkdown::new(&run_output.last_request);
535 let to_prompt = |assertion: String| {
536 hbs.render(
537 judge_diff_prompt_name,
538 &JudgeThreadInput {
539 messages: request_markdown.messages.clone(),
540 assertion,
541 },
542 )
543 .unwrap()
544 };
545
546 let (responses, report) = self
547 .judge_assertions(model, thread_assertions, to_prompt, cx)
548 .await;
549
550 println!(
551 "{}Judge - Thread score: {}%",
552 self.log_prefix,
553 report.passed_percentage()
554 );
555
556 (responses, report)
557 }
558
559 async fn judge_assertions(
560 &self,
561 model: Arc<dyn LanguageModel>,
562 assertions: Vec<JudgeAssertion>,
563 to_prompt: impl Fn(String) -> String,
564 cx: &AsyncApp,
565 ) -> (String, AssertionsReport) {
566 let assertions = assertions.into_iter().map(|assertion| {
567 let request = LanguageModelRequest {
568 thread_id: None,
569 prompt_id: None,
570 messages: vec![LanguageModelRequestMessage {
571 role: Role::User,
572 content: vec![MessageContent::Text(to_prompt(assertion.description))],
573 cache: false,
574 }],
575 temperature: None,
576 tools: Vec::new(),
577 stop: Vec::new(),
578 };
579
580 let model = model.clone();
581 let log_prefix = self.log_prefix.clone();
582 async move {
583 let response = send_language_model_request(model, request, cx).await;
584
585 let (response, result) = match response {
586 Ok(response) => (
587 response.clone(),
588 parse_assertion_result(&response).map_err(|err| err.to_string()),
589 ),
590 Err(err) => (err.to_string(), Err(err.to_string())),
591 };
592
593 if result.is_ok() {
594 println!("{}✅ {}", log_prefix, assertion.id);
595 } else {
596 println!("{}❌ {}", log_prefix, assertion.id);
597 }
598
599 (
600 response,
601 RanAssertion {
602 id: assertion.id,
603 result,
604 },
605 )
606 }
607 });
608
609 let mut responses = String::new();
610 let mut report = AssertionsReport::default();
611
612 for (response, assertion) in future::join_all(assertions).await {
613 writeln!(&mut responses, "# {}", assertion.id).unwrap();
614 writeln!(&mut responses, "{}\n\n", response).unwrap();
615 report.ran.push(assertion);
616 }
617
618 (responses, report)
619 }
620}
621
622pub fn wait_for_lang_server(
623 project: &Entity<Project>,
624 buffer: &Entity<Buffer>,
625 log_prefix: String,
626 cx: &mut AsyncApp,
627) -> Task<Result<()>> {
628 if std::env::var("ZED_EVAL_SKIP_LS").is_ok() {
629 return Task::ready(Ok(()));
630 }
631
632 println!("{}⏵ Waiting for language server", log_prefix);
633
634 let (mut tx, mut rx) = mpsc::channel(1);
635
636 let lsp_store = project
637 .update(cx, |project, _| project.lsp_store())
638 .unwrap();
639
640 let has_lang_server = buffer
641 .update(cx, |buffer, cx| {
642 lsp_store.update(cx, |lsp_store, cx| {
643 lsp_store
644 .language_servers_for_local_buffer(&buffer, cx)
645 .next()
646 .is_some()
647 })
648 })
649 .unwrap_or(false);
650
651 if has_lang_server {
652 project
653 .update(cx, |project, cx| project.save_buffer(buffer.clone(), cx))
654 .unwrap()
655 .detach();
656 }
657
658 let subscriptions =
659 [
660 cx.subscribe(&lsp_store, {
661 let log_prefix = log_prefix.clone();
662 move |_, event, _| match event {
663 project::LspStoreEvent::LanguageServerUpdate {
664 message:
665 client::proto::update_language_server::Variant::WorkProgress(
666 LspWorkProgress {
667 message: Some(message),
668 ..
669 },
670 ),
671 ..
672 } => println!("{}⟲ {message}", log_prefix),
673 _ => {}
674 }
675 }),
676 cx.subscribe(&project, {
677 let buffer = buffer.clone();
678 move |project, event, cx| match event {
679 project::Event::LanguageServerAdded(_, _, _) => {
680 let buffer = buffer.clone();
681 project
682 .update(cx, |project, cx| project.save_buffer(buffer, cx))
683 .detach();
684 }
685 project::Event::DiskBasedDiagnosticsFinished { .. } => {
686 tx.try_send(()).ok();
687 }
688 _ => {}
689 }
690 }),
691 ];
692
693 cx.spawn(async move |cx| {
694 let timeout = cx.background_executor().timer(Duration::new(60 * 5, 0));
695 let result = futures::select! {
696 _ = rx.next() => {
697 println!("{}⚑ Language server idle", log_prefix);
698 anyhow::Ok(())
699 },
700 _ = timeout.fuse() => {
701 Err(anyhow!("LSP wait timed out after 5 minutes"))
702 }
703 };
704 drop(subscriptions);
705 result
706 })
707}
708
709pub async fn query_lsp_diagnostics(
710 project: Entity<Project>,
711 cx: &mut AsyncApp,
712) -> Result<Option<String>> {
713 let paths_with_diagnostics = project.update(cx, |project, cx| {
714 project
715 .diagnostic_summaries(true, cx)
716 .filter(|(_, _, summary)| summary.error_count > 0 || summary.warning_count > 0)
717 .map(|(project_path, _, _)| project_path)
718 .collect::<Vec<_>>()
719 })?;
720
721 if paths_with_diagnostics.is_empty() {
722 return Ok(None);
723 }
724
725 let mut output = String::new();
726 for project_path in paths_with_diagnostics {
727 let buffer = project
728 .update(cx, |project, cx| project.open_buffer(project_path, cx))?
729 .await?;
730 let snapshot = buffer.read_with(cx, |buffer, _cx| buffer.snapshot())?;
731
732 for (_, group) in snapshot.diagnostic_groups(None) {
733 let entry = &group.entries[group.primary_ix];
734 let range = entry.range.to_point(&snapshot);
735 let severity = match entry.diagnostic.severity {
736 DiagnosticSeverity::ERROR => "error",
737 DiagnosticSeverity::WARNING => "warning",
738 _ => continue,
739 };
740
741 writeln!(
742 output,
743 "{} at line {}: {}",
744 severity,
745 range.start.row + 1,
746 entry.diagnostic.message
747 )?;
748 }
749 }
750 anyhow::Ok(Some(output))
751}
752
753fn parse_assertion_result(response: &str) -> Result<RanAssertionResult> {
754 let analysis = get_tag("analysis", response)?.to_string();
755 let passed = match get_tag("passed", response)?.to_lowercase().as_str() {
756 "true" => true,
757 "false" => false,
758 value @ _ => bail!("invalid judge `passed` tag: {value}"),
759 };
760 Ok(RanAssertionResult {
761 analysis: Some(analysis),
762 passed,
763 })
764}
765
766fn get_tag(name: &'static str, response: &str) -> Result<String> {
767 let start_tag = format!("<{}>", name);
768 let end_tag = format!("</{}>", name);
769
770 let start_ix = response
771 .find(&start_tag)
772 .context(format!("{} start tag not found", name))?;
773 let content_start_ix = start_ix + start_tag.len();
774
775 let end_ix = content_start_ix
776 + response[content_start_ix..]
777 .find(&end_tag)
778 .context(format!("{} end tag not found", name))?;
779
780 let content = response[content_start_ix..end_ix].trim().unindent();
781
782 anyhow::Ok(content)
783}
784
785pub fn repo_path_for_url(repos_dir: &Path, repo_url: &str) -> PathBuf {
786 let repo_name = repo_url
787 .trim_start_matches("https://")
788 .replace(|c: char| !c.is_alphanumeric(), "-");
789 Path::new(repos_dir).join(repo_name)
790}
791
792pub async fn run_git(repo_path: &Path, args: &[&str]) -> Result<String> {
793 let output = new_smol_command("git")
794 .current_dir(repo_path)
795 .args(args)
796 .output()
797 .await?;
798
799 if output.status.success() {
800 Ok(String::from_utf8(output.stdout)?.trim().to_string())
801 } else {
802 Err(anyhow!(
803 "`git {}` within `{}` failed with status: {}\nstderr:\n{}\nstdout:\n{}",
804 args.join(" "),
805 repo_path.display(),
806 output.status,
807 String::from_utf8_lossy(&output.stderr),
808 String::from_utf8_lossy(&output.stdout),
809 ))
810 }
811}
812
813pub async fn send_language_model_request(
814 model: Arc<dyn LanguageModel>,
815 request: LanguageModelRequest,
816 cx: &AsyncApp,
817) -> anyhow::Result<String> {
818 match model.stream_completion_text(request, &cx).await {
819 Ok(mut stream) => {
820 let mut full_response = String::new();
821 while let Some(chunk_result) = stream.stream.next().await {
822 match chunk_result {
823 Ok(chunk_str) => {
824 full_response.push_str(&chunk_str);
825 }
826 Err(err) => {
827 return Err(anyhow!(
828 "Error receiving response from language model: {err}"
829 ));
830 }
831 }
832 }
833 Ok(full_response)
834 }
835 Err(err) => Err(anyhow!(
836 "Failed to get response from language model. Error was: {err}"
837 )),
838 }
839}
840
841pub struct RequestMarkdown {
842 pub tools: String,
843 pub messages: String,
844}
845
846impl RequestMarkdown {
847 pub fn new(request: &LanguageModelRequest) -> Self {
848 let mut tools = String::new();
849 let mut messages = String::new();
850 let mut assistant_message_number: u32 = 1;
851
852 // Print the tools
853 if !request.tools.is_empty() {
854 for tool in &request.tools {
855 write!(&mut tools, "# {}\n\n", tool.name).unwrap();
856 write!(&mut tools, "{}\n\n", tool.description).unwrap();
857 write!(
858 &mut tools,
859 "{}\n",
860 MarkdownString::code_block("json", &format!("{:#}", tool.input_schema))
861 )
862 .unwrap();
863 }
864 }
865
866 // Print the messages
867 for message in &request.messages {
868 match message.role {
869 Role::System => messages.push_str("# ⚙️ SYSTEM\n\n"),
870 Role::User => messages.push_str("# 👤 USER\n\n"),
871 Role::Assistant => {
872 messages.push_str(&format!("# 🤖 ASSISTANT {assistant_message_number}\n\n"));
873 assistant_message_number += 1;
874 }
875 };
876
877 for content in &message.content {
878 match content {
879 MessageContent::Text(text) => {
880 messages.push_str(text);
881 messages.push_str("\n\n");
882 }
883 MessageContent::Image(_) => {
884 messages.push_str("[IMAGE DATA]\n\n");
885 }
886 MessageContent::Thinking { text, signature } => {
887 messages.push_str("**Thinking**:\n\n");
888 if let Some(sig) = signature {
889 messages.push_str(&format!("Signature: {}\n\n", sig));
890 }
891 messages.push_str(text);
892 messages.push_str("\n");
893 }
894 MessageContent::RedactedThinking(items) => {
895 messages.push_str(&format!(
896 "**Redacted Thinking**: {} item(s)\n\n",
897 items.len()
898 ));
899 }
900 MessageContent::ToolUse(tool_use) => {
901 messages.push_str(&format!(
902 "**Tool Use**: {} (ID: {})\n",
903 tool_use.name, tool_use.id
904 ));
905 messages.push_str(&format!(
906 "{}\n",
907 MarkdownString::code_block("json", &format!("{:#}", tool_use.input))
908 ));
909 }
910 MessageContent::ToolResult(tool_result) => {
911 messages.push_str(&format!(
912 "**Tool Result**: {} (ID: {})\n\n",
913 tool_result.tool_name, tool_result.tool_use_id
914 ));
915 if tool_result.is_error {
916 messages.push_str("**ERROR:**\n");
917 }
918 messages.push_str(&format!("{}\n\n", tool_result.content));
919 }
920 }
921 }
922 }
923
924 Self { tools, messages }
925 }
926}
927
928pub fn response_events_to_markdown(
929 response_events: &[std::result::Result<LanguageModelCompletionEvent, String>],
930) -> String {
931 let mut response = String::new();
932 // Print the response events if any
933 response.push_str("# Response\n\n");
934 let mut text_buffer = String::new();
935 let mut thinking_buffer = String::new();
936
937 let flush_buffers =
938 |output: &mut String, text_buffer: &mut String, thinking_buffer: &mut String| {
939 if !text_buffer.is_empty() {
940 output.push_str(&format!("**Text**:\n{}\n\n", text_buffer));
941 text_buffer.clear();
942 }
943 if !thinking_buffer.is_empty() {
944 output.push_str(&format!("**Thinking**:\n{}\n\n", thinking_buffer));
945 thinking_buffer.clear();
946 }
947 };
948
949 for event in response_events {
950 match event {
951 Ok(LanguageModelCompletionEvent::Text(text)) => {
952 text_buffer.push_str(text);
953 }
954 Ok(LanguageModelCompletionEvent::Thinking { text, .. }) => {
955 thinking_buffer.push_str(text);
956 }
957 Ok(LanguageModelCompletionEvent::Stop(reason)) => {
958 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
959 response.push_str(&format!("**Stop**: {:?}\n\n", reason));
960 }
961 Ok(LanguageModelCompletionEvent::ToolUse(tool_use)) => {
962 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
963 response.push_str(&format!(
964 "**Tool Use**: {} (ID: {})\n",
965 tool_use.name, tool_use.id
966 ));
967 response.push_str(&format!(
968 "{}\n",
969 MarkdownString::code_block("json", &format!("{:#}", tool_use.input))
970 ));
971 }
972 Ok(
973 LanguageModelCompletionEvent::UsageUpdate(_)
974 | LanguageModelCompletionEvent::StartMessage { .. },
975 ) => {}
976 Err(error) => {
977 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
978 response.push_str(&format!("**Error**: {}\n\n", error));
979 }
980 }
981 }
982
983 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
984
985 response
986}
987
988#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
989pub struct ThreadDialog {
990 pub request: LanguageModelRequest,
991 pub response_events: Vec<std::result::Result<LanguageModelCompletionEvent, String>>,
992}
993
994impl ThreadDialog {
995 pub fn new(
996 request: &LanguageModelRequest,
997 response_events: &[std::result::Result<LanguageModelCompletionEvent, String>],
998 ) -> Self {
999 Self {
1000 request: request.clone(),
1001 response_events: response_events.to_vec(),
1002 }
1003 }
1004
1005 /// Represents all request and response messages in a unified format.
1006 ///
1007 /// Specifically, it appends the assistant's response (derived from response events)
1008 /// as a new message to existing messages in the request.
1009 pub fn to_combined_request(&self) -> LanguageModelRequest {
1010 let mut request = self.request.clone();
1011 if let Some(assistant_message) = self.response_events_to_message() {
1012 request.messages.push(assistant_message);
1013 }
1014 request
1015 }
1016 fn response_events_to_message(&self) -> Option<LanguageModelRequestMessage> {
1017 let response_events = &self.response_events;
1018 let mut content: Vec<MessageContent> = Vec::new();
1019 let mut current_text = String::new();
1020
1021 let flush_text = |text: &mut String, content: &mut Vec<MessageContent>| {
1022 if !text.is_empty() {
1023 content.push(MessageContent::Text(std::mem::take(text)));
1024 }
1025 };
1026
1027 for event in response_events {
1028 match event {
1029 Ok(LanguageModelCompletionEvent::Text(text)) => {
1030 current_text.push_str(text);
1031 }
1032
1033 Ok(LanguageModelCompletionEvent::ToolUse(tool_use)) => {
1034 flush_text(&mut current_text, &mut content);
1035 if tool_use.is_input_complete {
1036 content.push(MessageContent::ToolUse(tool_use.clone()));
1037 }
1038 }
1039 Ok(LanguageModelCompletionEvent::Thinking { text, signature }) => {
1040 flush_text(&mut current_text, &mut content);
1041 content.push(MessageContent::Thinking {
1042 text: text.clone(),
1043 signature: signature.clone(),
1044 });
1045 }
1046
1047 // Skip these
1048 Ok(LanguageModelCompletionEvent::UsageUpdate(_))
1049 | Ok(LanguageModelCompletionEvent::StartMessage { .. })
1050 | Ok(LanguageModelCompletionEvent::Stop(_)) => {}
1051
1052 Err(error) => {
1053 flush_text(&mut current_text, &mut content);
1054 content.push(MessageContent::Text(format!("ERROR: {}", error)));
1055 }
1056 }
1057 }
1058
1059 flush_text(&mut current_text, &mut content);
1060
1061 if !content.is_empty() {
1062 Some(LanguageModelRequestMessage {
1063 role: Role::Assistant,
1064 content,
1065 cache: false,
1066 })
1067 } else {
1068 None
1069 }
1070 }
1071}
1072
1073#[cfg(test)]
1074mod test {
1075 use super::*;
1076
1077 #[test]
1078 fn test_parse_judge_output() {
1079 let response = r#"
1080 <analysis>The model did a good job but there were still compilations errors.</analysis>
1081 <passed>true</passed>
1082 "#
1083 .unindent();
1084
1085 let output = parse_assertion_result(&response).unwrap();
1086 assert_eq!(
1087 output.analysis,
1088 Some("The model did a good job but there were still compilations errors.".into())
1089 );
1090 assert_eq!(output.passed, true);
1091
1092 let response = r#"
1093 Text around ignored
1094
1095 <analysis>
1096 Failed to compile:
1097 - Error 1
1098 - Error 2
1099 </analysis>
1100
1101 <passed>false</passed>
1102 "#
1103 .unindent();
1104
1105 let output = parse_assertion_result(&response).unwrap();
1106 assert_eq!(
1107 output.analysis,
1108 Some("Failed to compile:\n- Error 1\n- Error 2".into())
1109 );
1110 assert_eq!(output.passed, false);
1111 }
1112}