1use agent::ContextServerRegistry;
2use agent_client_protocol as acp;
3use anyhow::{Context as _, Result, anyhow, bail};
4use client::proto::LspWorkProgress;
5use futures::channel::mpsc;
6use futures::future::Shared;
7use futures::{FutureExt as _, StreamExt as _, future};
8use gpui::{App, AppContext as _, AsyncApp, Entity, Task};
9use handlebars::Handlebars;
10use language::{Buffer, DiagnosticSeverity, OffsetRangeExt as _};
11use language_model::{
12 LanguageModel, LanguageModelCompletionEvent, LanguageModelRegistry, LanguageModelRequest,
13 LanguageModelRequestMessage, LanguageModelToolResultContent, MessageContent, Role, TokenUsage,
14};
15use project::{DiagnosticSummary, Project, ProjectPath, lsp_store::OpenLspBufferHandle};
16use prompt_store::{ProjectContext, WorktreeContext};
17use rand::{distr, prelude::*};
18use serde::{Deserialize, Serialize};
19use std::{
20 fmt::Write as _,
21 fs::{self, File},
22 io::Write as _,
23 path::{Path, PathBuf},
24 rc::Rc,
25 sync::{Arc, Mutex},
26 time::Duration,
27};
28use unindent::Unindent as _;
29use util::{ResultExt as _, command::new_smol_command, markdown::MarkdownCodeBlock};
30
31use crate::{
32 AgentAppState, ToolMetrics,
33 assertions::{AssertionsReport, RanAssertion, RanAssertionResult},
34 example::{Example, ExampleContext, FailedAssertion, JudgeAssertion},
35};
36
37pub const ZED_REPO_URL: &str = "https://github.com/zed-industries/zed.git";
38
39#[derive(Clone)]
40pub struct ExampleInstance {
41 pub thread: Rc<dyn Example>,
42 pub name: String,
43 pub run_directory: PathBuf,
44 pub log_prefix: String,
45 /// The repetition number for this example (0-based)
46 /// When running multiple repetitions of the same example, each instance is assigned a unique repetition number.
47 /// This affects the worktree path and log prefix to avoid clobbering results between runs.
48 pub repetition: usize,
49 pub repo_path: PathBuf,
50 /// Path to the directory containing the requests and responses for the agentic loop
51 worktrees_dir: PathBuf,
52}
53
54#[derive(Debug, Serialize, Clone)]
55pub struct RunOutput {
56 pub repository_diff: String,
57 pub diagnostic_summary_before: DiagnosticSummary,
58 pub diagnostic_summary_after: DiagnosticSummary,
59 pub diagnostics_before: Option<String>,
60 pub diagnostics_after: Option<String>,
61 pub token_usage: TokenUsage,
62 pub tool_metrics: ToolMetrics,
63 pub thread_markdown: String,
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;
94 let run_directory = run_dir.join(&name).join(repetition.to_string());
95
96 let repo_path = repo_path_for_url(repos_dir, &thread.meta().url);
97
98 Self {
99 name,
100 thread,
101 log_prefix: String::new(),
102 run_directory,
103 repetition,
104 repo_path,
105 worktrees_dir: worktrees_dir.to_path_buf(),
106 }
107 }
108
109 pub fn repo_url(&self) -> String {
110 self.thread.meta().url
111 }
112
113 pub fn revision(&self) -> String {
114 self.thread.meta().revision
115 }
116
117 pub fn worktree_name(&self) -> String {
118 format!("{}-{}", self.name, self.repetition)
119 }
120
121 pub fn set_log_prefix_style(&mut self, color: &str, name_width: usize) {
122 self.log_prefix = format!(
123 "{}{:<width$}\x1b[0m | ",
124 color,
125 self.worktree_name(),
126 width = name_width
127 );
128 }
129
130 /// Set up the example by checking out the specified Git revision
131 pub async fn fetch(&mut self) -> Result<()> {
132 let meta = self.thread.meta();
133
134 let revision_exists = run_git(
135 &self.repo_path,
136 &["rev-parse", &format!("{}^{{commit}}", &meta.revision)],
137 )
138 .await
139 .is_ok();
140
141 if !revision_exists {
142 println!("{}Fetching revision {}", self.log_prefix, &meta.revision);
143 run_git(
144 &self.repo_path,
145 &["fetch", "--depth", "1", "origin", &meta.revision],
146 )
147 .await?;
148 }
149 Ok(())
150 }
151
152 /// Set up the example by checking out the specified Git revision
153 pub async fn setup(&mut self) -> Result<()> {
154 let worktree_path = self.worktree_path();
155 let meta = self.thread.meta();
156 if worktree_path.is_dir() {
157 println!("{}Resetting existing worktree", self.log_prefix);
158
159 // TODO: consider including "-x" to remove ignored files. The downside of this is that
160 // it will also remove build artifacts, and so prevent incremental reuse there.
161 run_git(&worktree_path, &["clean", "--force", "-d"]).await?;
162 run_git(&worktree_path, &["reset", "--hard", "HEAD"]).await?;
163 run_git(&worktree_path, &["checkout", &meta.revision]).await?;
164 } else {
165 println!("{}Creating worktree", self.log_prefix);
166
167 let worktree_path_string = worktree_path.to_string_lossy().into_owned();
168
169 run_git(
170 &self.repo_path,
171 &[
172 "worktree",
173 "add",
174 "-f",
175 &worktree_path_string,
176 &meta.revision,
177 ],
178 )
179 .await?;
180 }
181
182 if meta.url == ZED_REPO_URL {
183 std::fs::write(worktree_path.join(".rules"), std::fs::read(".rules")?)?;
184 }
185
186 std::fs::create_dir_all(&self.run_directory)?;
187
188 Ok(())
189 }
190
191 pub fn worktree_path(&self) -> PathBuf {
192 self.worktrees_dir
193 .join(self.worktree_name())
194 .join(self.thread.meta().repo_name())
195 }
196
197 pub fn run(&self, app_state: Arc<AgentAppState>, cx: &mut App) -> Task<Result<RunOutput>> {
198 let project = Project::local(
199 app_state.client.clone(),
200 app_state.node_runtime.clone(),
201 app_state.user_store.clone(),
202 app_state.languages.clone(),
203 app_state.fs.clone(),
204 None,
205 project::LocalProjectFlags {
206 init_worktree_trust: false,
207 ..Default::default()
208 },
209 cx,
210 );
211
212 let worktree = project.update(cx, |project, cx| {
213 project.create_worktree(self.worktree_path(), true, cx)
214 });
215
216 let meta = self.thread.meta();
217 let this = self.clone();
218
219 cx.spawn(async move |cx| {
220 let worktree = worktree.await?;
221
222 // Wait for worktree scan to finish before choosing a file to open.
223 worktree
224 .update(cx, |worktree, _cx| {
225 worktree.as_local().unwrap().scan_complete()
226 })
227 .await;
228
229 struct LanguageServerState {
230 _lsp_open_handle: OpenLspBufferHandle,
231 language_file_buffer: Entity<Buffer>,
232 }
233
234 let mut diagnostics_before = None;
235 let mut diagnostic_summary_before = DiagnosticSummary::default();
236
237 let lsp = if let Some(language_server) = &meta.language_server {
238 // Open a file that matches the language to cause LSP to start.
239 let language_file = worktree
240 .read_with(cx, |worktree, _cx| {
241 worktree
242 .files(false, 0)
243 .find_map(|e| {
244 if e.path.clone().extension()
245 == Some(&language_server.file_extension)
246 {
247 Some(ProjectPath {
248 worktree_id: worktree.id(),
249 path: e.path.clone(),
250 })
251 } else {
252 None
253 }
254 })
255 .context("Failed to find a file for example language")
256 })?;
257
258 let open_language_file_buffer_task = project.update(cx, |project, cx| {
259 project.open_buffer(language_file.clone(), cx)
260 });
261
262 let language_file_buffer = open_language_file_buffer_task.await?;
263
264 let lsp_open_handle = project.update(cx, |project, cx| {
265 project.register_buffer_with_language_servers(&language_file_buffer, cx)
266 });
267
268 wait_for_lang_server(&project, &language_file_buffer, this.log_prefix.clone(), cx).await?;
269
270 diagnostic_summary_before = project.read_with(cx, |project, cx| {
271 project.diagnostic_summary(false, cx)
272 });
273
274 diagnostics_before = query_lsp_diagnostics(project.clone(), cx).await?;
275 if diagnostics_before.is_some() && language_server.allow_preexisting_diagnostics {
276 anyhow::bail!("Example has pre-existing diagnostics. If you want to run this example regardless, set `allow_preexisting_diagnostics` to `true` in `base.toml`");
277 }
278
279 Some(LanguageServerState {
280 _lsp_open_handle: lsp_open_handle,
281 language_file_buffer,
282 })
283 } else {
284 None
285 };
286
287 anyhow::ensure!(std::env::var("ZED_EVAL_SETUP_ONLY").is_err(), "Setup only mode");
288
289 let last_diff_file_path = this.run_directory.join("last.diff");
290
291 // Write an empty "last.diff" so that it can be opened in Zed for convenient view of the
292 // history using undo/redo.
293 std::fs::write(&last_diff_file_path, "")?;
294
295 let thread = cx.update(|cx| {
296 //todo: Do we want to load rules files here?
297 let worktrees = project.read(cx).visible_worktrees(cx).map(|worktree| {
298 let root_name = worktree.read(cx).root_name_str().into();
299 let abs_path = worktree.read(cx).abs_path();
300
301 WorktreeContext {
302 root_name,
303 abs_path,
304 rules_file: None,
305 }
306 }).collect::<Vec<_>>();
307 let project_context = cx.new(|_cx| ProjectContext::new(worktrees, vec![]));
308 let context_server_registry = cx.new(|cx| ContextServerRegistry::new(project.read(cx).context_server_store(), cx));
309
310 let thread = if let Some(json) = &meta.existing_thread_json {
311 let session_id = acp::SessionId::new(
312 rand::rng()
313 .sample_iter(&distr::Alphanumeric)
314 .take(7)
315 .map(char::from)
316 .collect::<String>(),
317 );
318
319 let db_thread = agent::DbThread::from_json(json.as_bytes()).expect("Can't read serialized thread");
320 cx.new(|cx| agent::Thread::from_db(session_id, db_thread, project.clone(), project_context, context_server_registry, agent::Templates::new(), cx))
321 } else {
322 cx.new(|cx| agent::Thread::new(project.clone(), project_context, context_server_registry, agent::Templates::new(), None, cx))
323 };
324
325 thread.update(cx, |thread, cx| {
326 thread.add_default_tools(Rc::new(EvalThreadEnvironment {
327 project: project.clone(),
328 }), cx);
329 thread.set_profile(meta.profile_id.clone(), cx);
330 thread.set_model(
331 LanguageModelInterceptor::new(
332 LanguageModelRegistry::read_global(cx).default_model().expect("Missing model").model.clone(),
333 this.run_directory.clone(),
334 last_diff_file_path.clone(),
335 this.run_directory.join("last.messages.json"),
336 this.worktree_path(),
337 this.repo_url(),
338 ),
339 cx,
340 );
341 });
342
343 thread
344 });
345
346 let mut example_cx = ExampleContext::new(
347 meta.clone(),
348 this.log_prefix.clone(),
349 thread.clone(),
350 cx.clone(),
351 );
352 let result = this.thread.conversation(&mut example_cx).await;
353
354 if let Err(err) = result
355 && !err.is::<FailedAssertion>() {
356 return Err(err);
357 }
358
359 println!("{}Stopped", this.log_prefix);
360
361 println!("{}Getting repository diff", this.log_prefix);
362 let repository_diff = Self::repository_diff(this.worktree_path(), &this.repo_url()).await?;
363
364 std::fs::write(last_diff_file_path, &repository_diff)?;
365
366
367 let mut diagnostics_after = None;
368 let mut diagnostic_summary_after = Default::default();
369
370 if let Some(language_server_state) = lsp {
371 wait_for_lang_server(&project, &language_server_state.language_file_buffer, this.log_prefix.clone(), cx).await?;
372
373 println!("{}Getting diagnostics", this.log_prefix);
374 diagnostics_after = cx
375 .update(|cx| {
376 let project = project.clone();
377 cx.spawn(async move |cx| query_lsp_diagnostics(project, cx).await)
378 })
379 .await?;
380 println!("{}Got diagnostics", this.log_prefix);
381
382 diagnostic_summary_after = project.read_with(cx, |project, cx| {
383 project.diagnostic_summary(false, cx)
384 });
385
386 }
387
388 if let Some(diagnostics_before) = &diagnostics_before {
389 fs::write(this.run_directory.join("diagnostics_before.txt"), diagnostics_before)?;
390 }
391
392 if let Some(diagnostics_after) = &diagnostics_after {
393 fs::write(this.run_directory.join("diagnostics_after.txt"), diagnostics_after)?;
394 }
395
396 Ok(thread.update(cx, |thread, _cx| {
397 RunOutput {
398 repository_diff,
399 diagnostic_summary_before,
400 diagnostic_summary_after,
401 diagnostics_before,
402 diagnostics_after,
403 token_usage: thread.latest_request_token_usage().unwrap(),
404 tool_metrics: example_cx.tool_metrics.lock().unwrap().clone(),
405 thread_markdown: thread.to_markdown(),
406 programmatic_assertions: example_cx.assertions,
407 }
408 }))
409 })
410 }
411
412 async fn repository_diff(repository_path: PathBuf, repository_url: &str) -> Result<String> {
413 run_git(&repository_path, &["add", "."]).await?;
414 let mut diff_args = vec!["diff", "--staged"];
415 if repository_url == ZED_REPO_URL {
416 diff_args.push(":(exclude).rules");
417 }
418 run_git(&repository_path, &diff_args).await
419 }
420
421 pub async fn judge(
422 &self,
423 model: Arc<dyn LanguageModel>,
424 run_output: &RunOutput,
425 cx: &AsyncApp,
426 ) -> JudgeOutput {
427 let mut output_file =
428 File::create(self.run_directory.join("judge.md")).expect("failed to create judge.md");
429
430 let diff_task = self.judge_diff(model.clone(), run_output, cx);
431 let thread_task = self.judge_thread(model.clone(), run_output, cx);
432
433 let (diff_result, thread_result) = futures::join!(diff_task, thread_task);
434
435 let (diff_response, diff_output) = diff_result;
436 let (thread_response, thread_output) = thread_result;
437
438 writeln!(
439 &mut output_file,
440 "# Judgment\n\n## Thread\n\n{thread_response}\n\n## Diff\n\n{diff_response}",
441 )
442 .log_err();
443
444 JudgeOutput {
445 thread: thread_output,
446 diff: diff_output,
447 }
448 }
449
450 async fn judge_diff(
451 &self,
452 model: Arc<dyn LanguageModel>,
453 run_output: &RunOutput,
454 cx: &AsyncApp,
455 ) -> (String, AssertionsReport) {
456 let diff_assertions = self.thread.diff_assertions();
457
458 if diff_assertions.is_empty() {
459 return (
460 "No diff assertions".to_string(),
461 AssertionsReport::default(),
462 );
463 }
464
465 println!("{}Running diff judge", self.log_prefix);
466
467 let judge_diff_prompt = include_str!("judge_diff_prompt.hbs");
468 let judge_diff_prompt_name = "judge_diff_prompt";
469 let mut hbs = Handlebars::new();
470 hbs.register_template_string(judge_diff_prompt_name, judge_diff_prompt)
471 .unwrap();
472
473 let to_prompt = |assertion: String| {
474 hbs.render(
475 judge_diff_prompt_name,
476 &JudgeDiffInput {
477 repository_diff: run_output.repository_diff.clone(),
478 assertion,
479 },
480 )
481 .unwrap()
482 };
483
484 let (responses, report) = self
485 .judge_assertions(model, diff_assertions, to_prompt, cx)
486 .await;
487
488 println!(
489 "{}Judge - Diff score: {}%",
490 self.log_prefix,
491 report.passed_percentage()
492 );
493
494 (responses, report)
495 }
496
497 async fn judge_thread(
498 &self,
499 model: Arc<dyn LanguageModel>,
500 run_output: &RunOutput,
501 cx: &AsyncApp,
502 ) -> (String, AssertionsReport) {
503 let thread_assertions = self.thread.thread_assertions();
504
505 if thread_assertions.is_empty() {
506 return (
507 "No thread assertions".to_string(),
508 AssertionsReport::default(),
509 );
510 }
511
512 let judge_thread_prompt = include_str!("judge_thread_prompt.hbs");
513 let judge_thread_prompt_name = "judge_thread_prompt";
514 let mut hbs = Handlebars::new();
515 hbs.register_template_string(judge_thread_prompt_name, judge_thread_prompt)
516 .unwrap();
517
518 let complete_messages = &run_output.thread_markdown;
519 let to_prompt = |assertion: String| {
520 hbs.render(
521 judge_thread_prompt_name,
522 &JudgeThreadInput {
523 messages: complete_messages.clone(),
524 assertion,
525 },
526 )
527 .unwrap()
528 };
529
530 let (responses, report) = self
531 .judge_assertions(model, thread_assertions, to_prompt, cx)
532 .await;
533
534 println!(
535 "{}Judge - Thread score: {}%",
536 self.log_prefix,
537 report.passed_percentage()
538 );
539
540 (responses, report)
541 }
542
543 async fn judge_assertions(
544 &self,
545 model: Arc<dyn LanguageModel>,
546 assertions: Vec<JudgeAssertion>,
547 to_prompt: impl Fn(String) -> String,
548 cx: &AsyncApp,
549 ) -> (String, AssertionsReport) {
550 let assertions = assertions.into_iter().map(|assertion| {
551 let request = LanguageModelRequest {
552 thread_id: None,
553 prompt_id: None,
554 intent: None,
555 messages: vec![LanguageModelRequestMessage {
556 role: Role::User,
557 content: vec![MessageContent::Text(to_prompt(assertion.description))],
558 cache: false,
559 reasoning_details: None,
560 }],
561 temperature: None,
562 tools: Vec::new(),
563 tool_choice: None,
564 stop: Vec::new(),
565 thinking_allowed: true,
566 bypass_rate_limit: false,
567 };
568
569 let model = model.clone();
570 let log_prefix = self.log_prefix.clone();
571 async move {
572 let response = send_language_model_request(model, request, cx).await;
573
574 let (response, result) = match response {
575 Ok(response) => (
576 response.clone(),
577 parse_assertion_result(&response).map_err(|err| err.to_string()),
578 ),
579 Err(err) => (err.to_string(), Err(err.to_string())),
580 };
581
582 if result.is_ok() {
583 println!("{}✅ {}", log_prefix, assertion.id);
584 } else {
585 println!("{}❌ {}", log_prefix, assertion.id);
586 }
587
588 (
589 response,
590 RanAssertion {
591 id: assertion.id,
592 result,
593 },
594 )
595 }
596 });
597
598 let mut responses = String::new();
599 let mut report = AssertionsReport::default();
600
601 for (response, assertion) in future::join_all(assertions).await {
602 writeln!(&mut responses, "# {}", assertion.id).unwrap();
603 writeln!(&mut responses, "{}\n\n", response).unwrap();
604 report.ran.push(assertion);
605 }
606
607 (responses, report)
608 }
609}
610
611struct EvalThreadEnvironment {
612 project: Entity<Project>,
613}
614
615struct EvalTerminalHandle {
616 terminal: Entity<acp_thread::Terminal>,
617}
618
619impl agent::TerminalHandle for EvalTerminalHandle {
620 fn id(&self, cx: &AsyncApp) -> Result<acp::TerminalId> {
621 Ok(self.terminal.read_with(cx, |term, _cx| term.id().clone()))
622 }
623
624 fn wait_for_exit(&self, cx: &AsyncApp) -> Result<Shared<Task<acp::TerminalExitStatus>>> {
625 Ok(self
626 .terminal
627 .read_with(cx, |term, _cx| term.wait_for_exit()))
628 }
629
630 fn current_output(&self, cx: &AsyncApp) -> Result<acp::TerminalOutputResponse> {
631 Ok(self
632 .terminal
633 .read_with(cx, |term, cx| term.current_output(cx)))
634 }
635
636 fn kill(&self, cx: &AsyncApp) -> Result<()> {
637 cx.update(|cx| {
638 self.terminal.update(cx, |terminal, cx| {
639 terminal.kill(cx);
640 });
641 });
642 Ok(())
643 }
644
645 fn was_stopped_by_user(&self, cx: &AsyncApp) -> Result<bool> {
646 Ok(self
647 .terminal
648 .read_with(cx, |term, _cx| term.was_stopped_by_user()))
649 }
650}
651
652impl agent::ThreadEnvironment for EvalThreadEnvironment {
653 fn create_terminal(
654 &self,
655 command: String,
656 cwd: Option<PathBuf>,
657 output_byte_limit: Option<u64>,
658 cx: &mut AsyncApp,
659 ) -> Task<Result<Rc<dyn agent::TerminalHandle>>> {
660 let project = self.project.clone();
661 cx.spawn(async move |cx| {
662 let language_registry =
663 project.read_with(cx, |project, _cx| project.languages().clone());
664 let id = acp::TerminalId::new(uuid::Uuid::new_v4().to_string());
665 let terminal =
666 acp_thread::create_terminal_entity(command, &[], vec![], cwd.clone(), &project, cx)
667 .await?;
668 let terminal = cx.new(|cx| {
669 acp_thread::Terminal::new(
670 id,
671 "",
672 cwd,
673 output_byte_limit.map(|limit| limit as usize),
674 terminal,
675 language_registry,
676 cx,
677 )
678 });
679 Ok(Rc::new(EvalTerminalHandle { terminal }) as Rc<dyn agent::TerminalHandle>)
680 })
681 }
682}
683
684struct LanguageModelInterceptor {
685 model: Arc<dyn LanguageModel>,
686 request_count: Arc<Mutex<usize>>,
687 previous_diff: Arc<Mutex<String>>,
688 example_output_dir: PathBuf,
689 last_diff_file_path: PathBuf,
690 messages_json_file_path: PathBuf,
691 repository_path: PathBuf,
692 repository_url: String,
693}
694
695impl LanguageModelInterceptor {
696 fn new(
697 model: Arc<dyn LanguageModel>,
698 example_output_dir: PathBuf,
699 last_diff_file_path: PathBuf,
700 messages_json_file_path: PathBuf,
701 repository_path: PathBuf,
702 repository_url: String,
703 ) -> Arc<Self> {
704 Arc::new(Self {
705 model,
706 request_count: Arc::new(Mutex::new(0)),
707 previous_diff: Arc::new(Mutex::new("".to_string())),
708 example_output_dir,
709 last_diff_file_path,
710 messages_json_file_path,
711 repository_path,
712 repository_url,
713 })
714 }
715}
716
717impl language_model::LanguageModel for LanguageModelInterceptor {
718 fn id(&self) -> language_model::LanguageModelId {
719 self.model.id()
720 }
721
722 fn name(&self) -> language_model::LanguageModelName {
723 self.model.name()
724 }
725
726 fn provider_id(&self) -> language_model::LanguageModelProviderId {
727 self.model.provider_id()
728 }
729
730 fn provider_name(&self) -> language_model::LanguageModelProviderName {
731 self.model.provider_name()
732 }
733
734 fn telemetry_id(&self) -> String {
735 self.model.telemetry_id()
736 }
737
738 fn supports_images(&self) -> bool {
739 self.model.supports_images()
740 }
741
742 fn supports_tools(&self) -> bool {
743 self.model.supports_tools()
744 }
745
746 fn supports_tool_choice(&self, choice: language_model::LanguageModelToolChoice) -> bool {
747 self.model.supports_tool_choice(choice)
748 }
749
750 fn max_token_count(&self) -> u64 {
751 self.model.max_token_count()
752 }
753
754 fn count_tokens(
755 &self,
756 request: LanguageModelRequest,
757 cx: &App,
758 ) -> future::BoxFuture<'static, Result<u64>> {
759 self.model.count_tokens(request, cx)
760 }
761
762 fn stream_completion(
763 &self,
764 request: LanguageModelRequest,
765 cx: &AsyncApp,
766 ) -> future::BoxFuture<
767 'static,
768 Result<
769 futures::stream::BoxStream<
770 'static,
771 Result<LanguageModelCompletionEvent, language_model::LanguageModelCompletionError>,
772 >,
773 language_model::LanguageModelCompletionError,
774 >,
775 > {
776 let stream = self.model.stream_completion(request.clone(), cx);
777 let request_count = self.request_count.clone();
778 let previous_diff = self.previous_diff.clone();
779 let example_output_dir = self.example_output_dir.clone();
780 let last_diff_file_path = self.last_diff_file_path.clone();
781 let messages_json_file_path = self.messages_json_file_path.clone();
782 let repository_path = self.repository_path.clone();
783 let repository_url = self.repository_url.clone();
784
785 Box::pin(async move {
786 let stream = stream.await?;
787
788 let response_events = Arc::new(Mutex::new(Vec::new()));
789 let request_clone = request.clone();
790
791 let wrapped_stream = stream.then(move |event| {
792 let response_events = response_events.clone();
793 let request = request_clone.clone();
794 let request_count = request_count.clone();
795 let previous_diff = previous_diff.clone();
796 let example_output_dir = example_output_dir.clone();
797 let last_diff_file_path = last_diff_file_path.clone();
798 let messages_json_file_path = messages_json_file_path.clone();
799 let repository_path = repository_path.clone();
800 let repository_url = repository_url.clone();
801
802 async move {
803 let event_result = match &event {
804 Ok(ev) => Ok(ev.clone()),
805 Err(err) => Err(err.to_string()),
806 };
807 response_events.lock().unwrap().push(event_result);
808
809 let should_execute = matches!(
810 &event,
811 Ok(LanguageModelCompletionEvent::Stop { .. }) | Err(_)
812 );
813
814 if should_execute {
815 let current_request_count = {
816 let mut count = request_count.lock().unwrap();
817 *count += 1;
818 *count
819 };
820
821 let messages_file_path =
822 example_output_dir.join(format!("{current_request_count}.messages.md"));
823 let diff_file_path =
824 example_output_dir.join(format!("{current_request_count}.diff"));
825 let last_messages_file_path = example_output_dir.join("last.messages.md");
826
827 let collected_events = response_events.lock().unwrap().clone();
828 let request_markdown = RequestMarkdown::new(&request);
829 let response_events_markdown =
830 response_events_to_markdown(&collected_events);
831 let dialog = ThreadDialog::new(&request, &collected_events);
832 let dialog_json =
833 serde_json::to_string_pretty(&dialog.to_combined_request())
834 .unwrap_or_default();
835
836 let messages = format!(
837 "{}\n\n{}",
838 request_markdown.messages, response_events_markdown
839 );
840 fs::write(&messages_file_path, messages.clone())
841 .expect("failed to write messages file");
842 fs::write(&last_messages_file_path, messages)
843 .expect("failed to write last messages file");
844 fs::write(&messages_json_file_path, dialog_json)
845 .expect("failed to write last.messages.json");
846
847 // Get repository diff
848 let diff_result =
849 ExampleInstance::repository_diff(repository_path, &repository_url)
850 .await;
851
852 match diff_result {
853 Ok(diff) => {
854 let prev_diff = previous_diff.lock().unwrap().clone();
855 if diff != prev_diff {
856 fs::write(&diff_file_path, &diff)
857 .expect("failed to write diff file");
858 fs::write(&last_diff_file_path, &diff)
859 .expect("failed to write last diff file");
860 *previous_diff.lock().unwrap() = diff;
861 }
862 }
863 Err(err) => {
864 let error_message = format!("{err:?}");
865 fs::write(&diff_file_path, &error_message)
866 .expect("failed to write diff error to file");
867 fs::write(&last_diff_file_path, &error_message)
868 .expect("failed to write last diff file");
869 }
870 }
871
872 if current_request_count == 1 {
873 let tools_file_path = example_output_dir.join("tools.md");
874 fs::write(tools_file_path, request_markdown.tools)
875 .expect("failed to write tools file");
876 }
877 }
878
879 event
880 }
881 });
882
883 Ok(Box::pin(wrapped_stream)
884 as futures::stream::BoxStream<
885 'static,
886 Result<
887 LanguageModelCompletionEvent,
888 language_model::LanguageModelCompletionError,
889 >,
890 >)
891 })
892 }
893}
894
895pub fn wait_for_lang_server(
896 project: &Entity<Project>,
897 buffer: &Entity<Buffer>,
898 log_prefix: String,
899 cx: &mut AsyncApp,
900) -> Task<Result<()>> {
901 if std::env::var("ZED_EVAL_SKIP_LS").is_ok() {
902 return Task::ready(Ok(()));
903 }
904
905 println!("{}⏵ Waiting for language server", log_prefix);
906
907 let (mut tx, mut rx) = mpsc::channel(1);
908
909 let lsp_store = project.read_with(cx, |project, _| project.lsp_store());
910
911 let has_lang_server = buffer.update(cx, |buffer, cx| {
912 lsp_store.update(cx, |lsp_store, cx| {
913 lsp_store
914 .running_language_servers_for_local_buffer(buffer, cx)
915 .next()
916 .is_some()
917 })
918 });
919
920 if has_lang_server {
921 project
922 .update(cx, |project, cx| project.save_buffer(buffer.clone(), cx))
923 .detach();
924 }
925
926 let subscriptions =
927 [
928 cx.subscribe(&lsp_store, {
929 let log_prefix = log_prefix.clone();
930 move |_, event, _| {
931 if let project::LspStoreEvent::LanguageServerUpdate {
932 message:
933 client::proto::update_language_server::Variant::WorkProgress(
934 LspWorkProgress {
935 message: Some(message),
936 ..
937 },
938 ),
939 ..
940 } = event
941 {
942 println!("{}⟲ {message}", log_prefix)
943 }
944 }
945 }),
946 cx.subscribe(project, {
947 let buffer = buffer.clone();
948 move |project, event, cx| match event {
949 project::Event::LanguageServerAdded(_, _, _) => {
950 let buffer = buffer.clone();
951 project
952 .update(cx, |project, cx| project.save_buffer(buffer, cx))
953 .detach();
954 }
955 project::Event::DiskBasedDiagnosticsFinished { .. } => {
956 tx.try_send(()).ok();
957 }
958 _ => {}
959 }
960 }),
961 ];
962
963 cx.spawn(async move |cx| {
964 let timeout = cx.background_executor().timer(Duration::new(60 * 5, 0));
965 let result = futures::select! {
966 _ = rx.next() => {
967 println!("{}⚑ Language server idle", log_prefix);
968 anyhow::Ok(())
969 },
970 _ = timeout.fuse() => {
971 anyhow::bail!("LSP wait timed out after 5 minutes");
972 }
973 };
974 drop(subscriptions);
975 result
976 })
977}
978
979pub async fn query_lsp_diagnostics(
980 project: Entity<Project>,
981 cx: &mut AsyncApp,
982) -> Result<Option<String>> {
983 let paths_with_diagnostics = project.update(cx, |project, cx| {
984 project
985 .diagnostic_summaries(true, cx)
986 .filter(|(_, _, summary)| summary.error_count > 0 || summary.warning_count > 0)
987 .map(|(project_path, _, _)| project_path)
988 .collect::<Vec<_>>()
989 });
990
991 if paths_with_diagnostics.is_empty() {
992 return Ok(None);
993 }
994
995 let mut output = String::new();
996 for project_path in paths_with_diagnostics {
997 let buffer = project
998 .update(cx, |project, cx| project.open_buffer(project_path, cx))
999 .await?;
1000 let snapshot = buffer.read_with(cx, |buffer, _cx| buffer.snapshot());
1001
1002 for (_, group) in snapshot.diagnostic_groups(None) {
1003 let entry = &group.entries[group.primary_ix];
1004 let range = entry.range.to_point(&snapshot);
1005 let severity = match entry.diagnostic.severity {
1006 DiagnosticSeverity::ERROR => "error",
1007 DiagnosticSeverity::WARNING => "warning",
1008 _ => continue,
1009 };
1010
1011 writeln!(
1012 output,
1013 "{} at line {}: {}",
1014 severity,
1015 range.start.row + 1,
1016 entry.diagnostic.message
1017 )?;
1018 }
1019 }
1020 anyhow::Ok(Some(output))
1021}
1022
1023fn parse_assertion_result(response: &str) -> Result<RanAssertionResult> {
1024 let analysis = get_tag("analysis", response)?;
1025 let passed = match get_tag("passed", response)?.to_lowercase().as_str() {
1026 "true" => true,
1027 "false" => false,
1028 value @ _ => bail!("invalid judge `passed` tag: {value}"),
1029 };
1030 Ok(RanAssertionResult {
1031 analysis: Some(analysis),
1032 passed,
1033 })
1034}
1035
1036fn get_tag(name: &'static str, response: &str) -> Result<String> {
1037 let start_tag = format!("<{}>", name);
1038 let end_tag = format!("</{}>", name);
1039
1040 let start_ix = response
1041 .find(&start_tag)
1042 .context(format!("{} start tag not found", name))?;
1043 let content_start_ix = start_ix + start_tag.len();
1044
1045 let end_ix = content_start_ix
1046 + response[content_start_ix..]
1047 .find(&end_tag)
1048 .context(format!("{} end tag not found", name))?;
1049
1050 let content = response[content_start_ix..end_ix].trim().unindent();
1051
1052 anyhow::Ok(content)
1053}
1054
1055pub fn repo_path_for_url(repos_dir: &Path, repo_url: &str) -> PathBuf {
1056 let repo_name = repo_url
1057 .trim_start_matches("https://")
1058 .replace(|c: char| !c.is_alphanumeric(), "-");
1059 Path::new(repos_dir).join(repo_name)
1060}
1061
1062pub async fn run_git(repo_path: &Path, args: &[&str]) -> Result<String> {
1063 let output = new_smol_command("git")
1064 .current_dir(repo_path)
1065 .args(args)
1066 .output()
1067 .await?;
1068
1069 anyhow::ensure!(
1070 output.status.success(),
1071 "`git {}` within `{}` failed with status: {}\nstderr:\n{}\nstdout:\n{}",
1072 args.join(" "),
1073 repo_path.display(),
1074 output.status,
1075 String::from_utf8_lossy(&output.stderr),
1076 String::from_utf8_lossy(&output.stdout),
1077 );
1078 Ok(String::from_utf8(output.stdout)?.trim().to_string())
1079}
1080
1081fn push_role(role: &Role, buf: &mut String, assistant_message_number: &mut u32) {
1082 match role {
1083 Role::System => buf.push_str("# ⚙️ SYSTEM\n\n"),
1084 Role::User => buf.push_str("# 👤 USER\n\n"),
1085 Role::Assistant => {
1086 buf.push_str(&format!("# 🤖 ASSISTANT {assistant_message_number}\n\n"));
1087 *assistant_message_number = *assistant_message_number + 1;
1088 }
1089 }
1090}
1091
1092pub async fn send_language_model_request(
1093 model: Arc<dyn LanguageModel>,
1094 request: LanguageModelRequest,
1095 cx: &AsyncApp,
1096) -> anyhow::Result<String> {
1097 match model.stream_completion_text(request, cx).await {
1098 Ok(mut stream) => {
1099 let mut full_response = String::new();
1100 while let Some(chunk_result) = stream.stream.next().await {
1101 match chunk_result {
1102 Ok(chunk_str) => {
1103 full_response.push_str(&chunk_str);
1104 }
1105 Err(err) => {
1106 anyhow::bail!("Error receiving response from language model: {err}");
1107 }
1108 }
1109 }
1110 Ok(full_response)
1111 }
1112 Err(err) => Err(anyhow!(
1113 "Failed to get response from language model. Error was: {err}"
1114 )),
1115 }
1116}
1117
1118pub struct RequestMarkdown {
1119 pub tools: String,
1120 pub messages: String,
1121}
1122
1123impl RequestMarkdown {
1124 pub fn new(request: &LanguageModelRequest) -> Self {
1125 let mut tools = String::new();
1126 let mut messages = String::new();
1127 let mut assistant_message_number: u32 = 1;
1128
1129 // Print the tools
1130 if !request.tools.is_empty() {
1131 for tool in &request.tools {
1132 write!(&mut tools, "# {}\n\n", tool.name).unwrap();
1133 write!(&mut tools, "{}\n\n", tool.description).unwrap();
1134 writeln!(
1135 &mut tools,
1136 "{}",
1137 MarkdownCodeBlock {
1138 tag: "json",
1139 text: &format!("{:#}", tool.input_schema)
1140 }
1141 )
1142 .unwrap();
1143 }
1144 }
1145
1146 // Print the messages
1147 for message in &request.messages {
1148 push_role(&message.role, &mut messages, &mut assistant_message_number);
1149
1150 for content in &message.content {
1151 match content {
1152 MessageContent::Text(text) => {
1153 messages.push_str(text);
1154 messages.push_str("\n\n");
1155 }
1156 MessageContent::Image(_) => {
1157 messages.push_str("[IMAGE DATA]\n\n");
1158 }
1159 MessageContent::Thinking { text, signature } => {
1160 messages.push_str("**Thinking**:\n\n");
1161 if let Some(sig) = signature {
1162 messages.push_str(&format!("Signature: {}\n\n", sig));
1163 }
1164 messages.push_str(text);
1165 messages.push_str("\n");
1166 }
1167 MessageContent::RedactedThinking(items) => {
1168 messages.push_str(&format!(
1169 "**Redacted Thinking**: {} item(s)\n\n",
1170 items.len()
1171 ));
1172 }
1173 MessageContent::ToolUse(tool_use) => {
1174 messages.push_str(&format!(
1175 "**Tool Use**: {} (ID: {})\n",
1176 tool_use.name, tool_use.id
1177 ));
1178 messages.push_str(&format!(
1179 "{}\n",
1180 MarkdownCodeBlock {
1181 tag: "json",
1182 text: &format!("{:#}", tool_use.input)
1183 }
1184 ));
1185 }
1186 MessageContent::ToolResult(tool_result) => {
1187 messages.push_str(&format!(
1188 "**Tool Result**: {} (ID: {})\n\n",
1189 tool_result.tool_name, tool_result.tool_use_id
1190 ));
1191 if tool_result.is_error {
1192 messages.push_str("**ERROR:**\n");
1193 }
1194
1195 match &tool_result.content {
1196 LanguageModelToolResultContent::Text(text) => {
1197 writeln!(messages, "{text}\n").ok();
1198 }
1199 LanguageModelToolResultContent::Image(image) => {
1200 writeln!(messages, "\n", image.source).ok();
1201 }
1202 }
1203
1204 if let Some(output) = tool_result.output.as_ref() {
1205 writeln!(
1206 messages,
1207 "**Debug Output**:\n\n```json\n{}\n```\n",
1208 serde_json::to_string_pretty(output).unwrap()
1209 )
1210 .unwrap();
1211 }
1212 }
1213 }
1214 }
1215 }
1216
1217 Self { tools, messages }
1218 }
1219}
1220
1221pub fn response_events_to_markdown(
1222 response_events: &[std::result::Result<LanguageModelCompletionEvent, String>],
1223) -> String {
1224 let mut response = String::new();
1225 // Print the response events if any
1226 response.push_str("# Response\n\n");
1227 let mut text_buffer = String::new();
1228 let mut thinking_buffer = String::new();
1229
1230 let flush_buffers =
1231 |output: &mut String, text_buffer: &mut String, thinking_buffer: &mut String| {
1232 if !text_buffer.is_empty() {
1233 output.push_str(&format!("**Text**:\n{}\n\n", text_buffer));
1234 text_buffer.clear();
1235 }
1236 if !thinking_buffer.is_empty() {
1237 output.push_str(&format!("**Thinking**:\n{}\n\n", thinking_buffer));
1238 thinking_buffer.clear();
1239 }
1240 };
1241
1242 for event in response_events {
1243 match event {
1244 Ok(LanguageModelCompletionEvent::Text(text)) => {
1245 text_buffer.push_str(text);
1246 }
1247 Ok(LanguageModelCompletionEvent::Thinking { text, .. }) => {
1248 thinking_buffer.push_str(text);
1249 }
1250 Ok(LanguageModelCompletionEvent::RedactedThinking { .. }) => {}
1251 Ok(LanguageModelCompletionEvent::Stop(reason)) => {
1252 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
1253 response.push_str(&format!("**Stop**: {:?}\n\n", reason));
1254 }
1255 Ok(LanguageModelCompletionEvent::ToolUse(tool_use)) => {
1256 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
1257 response.push_str(&format!(
1258 "**Tool Use**: {} (ID: {})\n",
1259 tool_use.name, tool_use.id
1260 ));
1261 response.push_str(&format!(
1262 "{}\n",
1263 MarkdownCodeBlock {
1264 tag: "json",
1265 text: &format!("{:#}", tool_use.input)
1266 }
1267 ));
1268 }
1269 Ok(
1270 LanguageModelCompletionEvent::UsageUpdate(_)
1271 | LanguageModelCompletionEvent::StartMessage { .. }
1272 | LanguageModelCompletionEvent::Queued { .. }
1273 | LanguageModelCompletionEvent::Started
1274 | LanguageModelCompletionEvent::ReasoningDetails(_),
1275 ) => {}
1276 Ok(LanguageModelCompletionEvent::ToolUseJsonParseError {
1277 json_parse_error, ..
1278 }) => {
1279 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
1280 response.push_str(&format!(
1281 "**Error**: parse error in tool use JSON: {}\n\n",
1282 json_parse_error
1283 ));
1284 }
1285 Err(error) => {
1286 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
1287 response.push_str(&format!("**Error**: {}\n\n", error));
1288 }
1289 }
1290 }
1291
1292 flush_buffers(&mut response, &mut text_buffer, &mut thinking_buffer);
1293
1294 response
1295}
1296
1297#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
1298pub struct ThreadDialog {
1299 pub request: LanguageModelRequest,
1300 pub response_events: Vec<std::result::Result<LanguageModelCompletionEvent, String>>,
1301}
1302
1303impl ThreadDialog {
1304 pub fn new(
1305 request: &LanguageModelRequest,
1306 response_events: &[std::result::Result<LanguageModelCompletionEvent, String>],
1307 ) -> Self {
1308 Self {
1309 request: request.clone(),
1310 response_events: response_events.to_vec(),
1311 }
1312 }
1313
1314 /// Represents all request and response messages in a unified format.
1315 ///
1316 /// Specifically, it appends the assistant's response (derived from response events)
1317 /// as a new message to existing messages in the request.
1318 pub fn to_combined_request(&self) -> LanguageModelRequest {
1319 let mut request = self.request.clone();
1320 if let Some(assistant_message) = self.response_events_to_message() {
1321 request.messages.push(assistant_message);
1322 }
1323 request
1324 }
1325 fn response_events_to_message(&self) -> Option<LanguageModelRequestMessage> {
1326 let response_events = &self.response_events;
1327 let mut content: Vec<MessageContent> = Vec::new();
1328 let mut current_text = String::new();
1329
1330 let flush_text = |text: &mut String, content: &mut Vec<MessageContent>| {
1331 if !text.is_empty() {
1332 content.push(MessageContent::Text(std::mem::take(text)));
1333 }
1334 };
1335
1336 for event in response_events {
1337 match event {
1338 Ok(LanguageModelCompletionEvent::Text(text)) => {
1339 current_text.push_str(text);
1340 }
1341
1342 Ok(LanguageModelCompletionEvent::ToolUse(tool_use)) => {
1343 flush_text(&mut current_text, &mut content);
1344 if tool_use.is_input_complete {
1345 content.push(MessageContent::ToolUse(tool_use.clone()));
1346 }
1347 }
1348 Ok(LanguageModelCompletionEvent::Thinking { text, signature }) => {
1349 flush_text(&mut current_text, &mut content);
1350 content.push(MessageContent::Thinking {
1351 text: text.clone(),
1352 signature: signature.clone(),
1353 });
1354 }
1355
1356 // Skip these
1357 Ok(LanguageModelCompletionEvent::UsageUpdate(_))
1358 | Ok(LanguageModelCompletionEvent::RedactedThinking { .. })
1359 | Ok(LanguageModelCompletionEvent::StartMessage { .. })
1360 | Ok(LanguageModelCompletionEvent::ReasoningDetails(_))
1361 | Ok(LanguageModelCompletionEvent::Stop(_))
1362 | Ok(LanguageModelCompletionEvent::Queued { .. })
1363 | Ok(LanguageModelCompletionEvent::Started) => {}
1364
1365 Ok(LanguageModelCompletionEvent::ToolUseJsonParseError {
1366 json_parse_error,
1367 ..
1368 }) => {
1369 flush_text(&mut current_text, &mut content);
1370 content.push(MessageContent::Text(format!(
1371 "ERROR: parse error in tool use JSON: {}",
1372 json_parse_error
1373 )));
1374 }
1375
1376 Err(error) => {
1377 flush_text(&mut current_text, &mut content);
1378 content.push(MessageContent::Text(format!("ERROR: {}", error)));
1379 }
1380 }
1381 }
1382
1383 flush_text(&mut current_text, &mut content);
1384
1385 if !content.is_empty() {
1386 Some(LanguageModelRequestMessage {
1387 role: Role::Assistant,
1388 content,
1389 cache: false,
1390 reasoning_details: None,
1391 })
1392 } else {
1393 None
1394 }
1395 }
1396}
1397
1398#[cfg(test)]
1399mod test {
1400 use super::*;
1401
1402 #[test]
1403 fn test_parse_judge_output() {
1404 let response = r#"
1405 <analysis>The model did a good job but there were still compilations errors.</analysis>
1406 <passed>true</passed>
1407 "#
1408 .unindent();
1409
1410 let output = parse_assertion_result(&response).unwrap();
1411 assert_eq!(
1412 output.analysis,
1413 Some("The model did a good job but there were still compilations errors.".into())
1414 );
1415 assert!(output.passed);
1416
1417 let response = r#"
1418 Text around ignored
1419
1420 <analysis>
1421 Failed to compile:
1422 - Error 1
1423 - Error 2
1424 </analysis>
1425
1426 <passed>false</passed>
1427 "#
1428 .unindent();
1429
1430 let output = parse_assertion_result(&response).unwrap();
1431 assert_eq!(
1432 output.analysis,
1433 Some("Failed to compile:\n- Error 1\n- Error 2".into())
1434 );
1435 assert!(!output.passed);
1436 }
1437}