1mod completion_diff_element;
2mod init;
3mod input_excerpt;
4mod license_detection;
5mod onboarding_modal;
6mod onboarding_telemetry;
7mod rate_completion_modal;
8
9pub(crate) use completion_diff_element::*;
10use db::kvp::{Dismissable, KEY_VALUE_STORE};
11use edit_prediction::DataCollectionState;
12pub use init::*;
13use license_detection::LicenseDetectionWatcher;
14pub use rate_completion_modal::*;
15
16use anyhow::{Context as _, Result, anyhow};
17use arrayvec::ArrayVec;
18use client::{Client, EditPredictionUsage, UserStore};
19use cloud_llm_client::{
20 AcceptEditPredictionBody, EXPIRED_LLM_TOKEN_HEADER_NAME, MINIMUM_REQUIRED_VERSION_HEADER_NAME,
21 PredictEditsBody, PredictEditsGitInfo, PredictEditsResponse, ZED_VERSION_HEADER_NAME,
22};
23use collections::{HashMap, HashSet, VecDeque};
24use futures::AsyncReadExt;
25use gpui::{
26 App, AppContext as _, AsyncApp, Context, Entity, EntityId, Global, SemanticVersion,
27 Subscription, Task, WeakEntity, actions,
28};
29use http_client::{AsyncBody, HttpClient, Method, Request, Response};
30use input_excerpt::excerpt_for_cursor_position;
31use language::{
32 Anchor, Buffer, BufferSnapshot, EditPreview, OffsetRangeExt, ToOffset, ToPoint, text_diff,
33};
34use language_model::{LlmApiToken, RefreshLlmTokenListener};
35use project::{Project, ProjectPath};
36use release_channel::AppVersion;
37use settings::WorktreeId;
38use std::str::FromStr;
39use std::{
40 cmp,
41 fmt::Write,
42 future::Future,
43 mem,
44 ops::Range,
45 path::Path,
46 rc::Rc,
47 sync::Arc,
48 time::{Duration, Instant},
49};
50use telemetry_events::EditPredictionRating;
51use thiserror::Error;
52use util::ResultExt;
53use uuid::Uuid;
54use workspace::Workspace;
55use workspace::notifications::{ErrorMessagePrompt, NotificationId};
56use worktree::Worktree;
57
58const CURSOR_MARKER: &'static str = "<|user_cursor_is_here|>";
59const START_OF_FILE_MARKER: &'static str = "<|start_of_file|>";
60const EDITABLE_REGION_START_MARKER: &'static str = "<|editable_region_start|>";
61const EDITABLE_REGION_END_MARKER: &'static str = "<|editable_region_end|>";
62const BUFFER_CHANGE_GROUPING_INTERVAL: Duration = Duration::from_secs(1);
63const ZED_PREDICT_DATA_COLLECTION_CHOICE: &str = "zed_predict_data_collection_choice";
64
65const MAX_CONTEXT_TOKENS: usize = 150;
66const MAX_REWRITE_TOKENS: usize = 350;
67const MAX_EVENT_TOKENS: usize = 500;
68const MAX_DIAGNOSTIC_GROUPS: usize = 10;
69
70/// Maximum number of events to track.
71const MAX_EVENT_COUNT: usize = 16;
72
73actions!(
74 edit_prediction,
75 [
76 /// Clears the edit prediction history.
77 ClearHistory
78 ]
79);
80
81#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash)]
82pub struct EditPredictionId(Uuid);
83
84impl From<EditPredictionId> for gpui::ElementId {
85 fn from(value: EditPredictionId) -> Self {
86 gpui::ElementId::Uuid(value.0)
87 }
88}
89
90impl std::fmt::Display for EditPredictionId {
91 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
92 write!(f, "{}", self.0)
93 }
94}
95
96struct ZedPredictUpsell;
97
98impl Dismissable for ZedPredictUpsell {
99 const KEY: &'static str = "dismissed-edit-predict-upsell";
100
101 fn dismissed() -> bool {
102 // To make this backwards compatible with older versions of Zed, we
103 // check if the user has seen the previous Edit Prediction Onboarding
104 // before, by checking the data collection choice which was written to
105 // the database once the user clicked on "Accept and Enable"
106 if KEY_VALUE_STORE
107 .read_kvp(ZED_PREDICT_DATA_COLLECTION_CHOICE)
108 .log_err()
109 .map_or(false, |s| s.is_some())
110 {
111 return true;
112 }
113
114 KEY_VALUE_STORE
115 .read_kvp(Self::KEY)
116 .log_err()
117 .map_or(false, |s| s.is_some())
118 }
119}
120
121pub fn should_show_upsell_modal(user_store: &Entity<UserStore>, cx: &App) -> bool {
122 if user_store.read(cx).has_accepted_terms_of_service() {
123 !ZedPredictUpsell::dismissed()
124 } else {
125 true
126 }
127}
128
129#[derive(Clone)]
130struct ZetaGlobal(Entity<Zeta>);
131
132impl Global for ZetaGlobal {}
133
134#[derive(Clone)]
135pub struct EditPrediction {
136 id: EditPredictionId,
137 path: Arc<Path>,
138 excerpt_range: Range<usize>,
139 cursor_offset: usize,
140 edits: Arc<[(Range<Anchor>, String)]>,
141 snapshot: BufferSnapshot,
142 edit_preview: EditPreview,
143 input_outline: Arc<str>,
144 input_events: Arc<str>,
145 input_excerpt: Arc<str>,
146 output_excerpt: Arc<str>,
147 buffer_snapshotted_at: Instant,
148 response_received_at: Instant,
149}
150
151impl EditPrediction {
152 fn latency(&self) -> Duration {
153 self.response_received_at
154 .duration_since(self.buffer_snapshotted_at)
155 }
156
157 fn interpolate(&self, new_snapshot: &BufferSnapshot) -> Option<Vec<(Range<Anchor>, String)>> {
158 interpolate(&self.snapshot, new_snapshot, self.edits.clone())
159 }
160}
161
162fn interpolate(
163 old_snapshot: &BufferSnapshot,
164 new_snapshot: &BufferSnapshot,
165 current_edits: Arc<[(Range<Anchor>, String)]>,
166) -> Option<Vec<(Range<Anchor>, String)>> {
167 let mut edits = Vec::new();
168
169 let mut model_edits = current_edits.into_iter().peekable();
170 for user_edit in new_snapshot.edits_since::<usize>(&old_snapshot.version) {
171 while let Some((model_old_range, _)) = model_edits.peek() {
172 let model_old_range = model_old_range.to_offset(old_snapshot);
173 if model_old_range.end < user_edit.old.start {
174 let (model_old_range, model_new_text) = model_edits.next().unwrap();
175 edits.push((model_old_range.clone(), model_new_text.clone()));
176 } else {
177 break;
178 }
179 }
180
181 if let Some((model_old_range, model_new_text)) = model_edits.peek() {
182 let model_old_offset_range = model_old_range.to_offset(old_snapshot);
183 if user_edit.old == model_old_offset_range {
184 let user_new_text = new_snapshot
185 .text_for_range(user_edit.new.clone())
186 .collect::<String>();
187
188 if let Some(model_suffix) = model_new_text.strip_prefix(&user_new_text) {
189 if !model_suffix.is_empty() {
190 let anchor = old_snapshot.anchor_after(user_edit.old.end);
191 edits.push((anchor..anchor, model_suffix.to_string()));
192 }
193
194 model_edits.next();
195 continue;
196 }
197 }
198 }
199
200 return None;
201 }
202
203 edits.extend(model_edits.cloned());
204
205 if edits.is_empty() { None } else { Some(edits) }
206}
207
208impl std::fmt::Debug for EditPrediction {
209 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
210 f.debug_struct("EditPrediction")
211 .field("id", &self.id)
212 .field("path", &self.path)
213 .field("edits", &self.edits)
214 .finish_non_exhaustive()
215 }
216}
217
218pub struct Zeta {
219 workspace: Option<WeakEntity<Workspace>>,
220 client: Arc<Client>,
221 events: VecDeque<Event>,
222 registered_buffers: HashMap<gpui::EntityId, RegisteredBuffer>,
223 shown_completions: VecDeque<EditPrediction>,
224 rated_completions: HashSet<EditPredictionId>,
225 data_collection_choice: Entity<DataCollectionChoice>,
226 llm_token: LlmApiToken,
227 _llm_token_subscription: Subscription,
228 /// Whether an update to a newer version of Zed is required to continue using Zeta.
229 update_required: bool,
230 user_store: Entity<UserStore>,
231 license_detection_watchers: HashMap<WorktreeId, Rc<LicenseDetectionWatcher>>,
232}
233
234impl Zeta {
235 pub fn global(cx: &mut App) -> Option<Entity<Self>> {
236 cx.try_global::<ZetaGlobal>().map(|global| global.0.clone())
237 }
238
239 pub fn register(
240 workspace: Option<WeakEntity<Workspace>>,
241 worktree: Option<Entity<Worktree>>,
242 client: Arc<Client>,
243 user_store: Entity<UserStore>,
244 cx: &mut App,
245 ) -> Entity<Self> {
246 let this = Self::global(cx).unwrap_or_else(|| {
247 let entity = cx.new(|cx| Self::new(workspace, client, user_store, cx));
248 cx.set_global(ZetaGlobal(entity.clone()));
249 entity
250 });
251
252 this.update(cx, move |this, cx| {
253 if let Some(worktree) = worktree {
254 let worktree_id = worktree.read(cx).id();
255 this.license_detection_watchers
256 .entry(worktree_id)
257 .or_insert_with(|| Rc::new(LicenseDetectionWatcher::new(&worktree, cx)));
258 }
259 });
260
261 this
262 }
263
264 pub fn clear_history(&mut self) {
265 self.events.clear();
266 }
267
268 pub fn usage(&self, cx: &App) -> Option<EditPredictionUsage> {
269 self.user_store.read(cx).edit_prediction_usage()
270 }
271
272 fn new(
273 workspace: Option<WeakEntity<Workspace>>,
274 client: Arc<Client>,
275 user_store: Entity<UserStore>,
276 cx: &mut Context<Self>,
277 ) -> Self {
278 let refresh_llm_token_listener = RefreshLlmTokenListener::global(cx);
279
280 let data_collection_choice = Self::load_data_collection_choices();
281 let data_collection_choice = cx.new(|_| data_collection_choice);
282
283 Self {
284 workspace,
285 client,
286 events: VecDeque::new(),
287 shown_completions: VecDeque::new(),
288 rated_completions: HashSet::default(),
289 registered_buffers: HashMap::default(),
290 data_collection_choice,
291 llm_token: LlmApiToken::default(),
292 _llm_token_subscription: cx.subscribe(
293 &refresh_llm_token_listener,
294 |this, _listener, _event, cx| {
295 let client = this.client.clone();
296 let llm_token = this.llm_token.clone();
297 cx.spawn(async move |_this, _cx| {
298 llm_token.refresh(&client).await?;
299 anyhow::Ok(())
300 })
301 .detach_and_log_err(cx);
302 },
303 ),
304 update_required: false,
305 license_detection_watchers: HashMap::default(),
306 user_store,
307 }
308 }
309
310 fn push_event(&mut self, event: Event) {
311 if let Some(Event::BufferChange {
312 new_snapshot: last_new_snapshot,
313 timestamp: last_timestamp,
314 ..
315 }) = self.events.back_mut()
316 {
317 // Coalesce edits for the same buffer when they happen one after the other.
318 let Event::BufferChange {
319 old_snapshot,
320 new_snapshot,
321 timestamp,
322 } = &event;
323
324 if timestamp.duration_since(*last_timestamp) <= BUFFER_CHANGE_GROUPING_INTERVAL
325 && old_snapshot.remote_id() == last_new_snapshot.remote_id()
326 && old_snapshot.version == last_new_snapshot.version
327 {
328 *last_new_snapshot = new_snapshot.clone();
329 *last_timestamp = *timestamp;
330 return;
331 }
332 }
333
334 self.events.push_back(event);
335 if self.events.len() >= MAX_EVENT_COUNT {
336 // These are halved instead of popping to improve prompt caching.
337 self.events.drain(..MAX_EVENT_COUNT / 2);
338 }
339 }
340
341 pub fn register_buffer(&mut self, buffer: &Entity<Buffer>, cx: &mut Context<Self>) {
342 let buffer_id = buffer.entity_id();
343 let weak_buffer = buffer.downgrade();
344
345 if let std::collections::hash_map::Entry::Vacant(entry) =
346 self.registered_buffers.entry(buffer_id)
347 {
348 let snapshot = buffer.read(cx).snapshot();
349
350 entry.insert(RegisteredBuffer {
351 snapshot,
352 _subscriptions: [
353 cx.subscribe(buffer, move |this, buffer, event, cx| {
354 this.handle_buffer_event(buffer, event, cx);
355 }),
356 cx.observe_release(buffer, move |this, _buffer, _cx| {
357 this.registered_buffers.remove(&weak_buffer.entity_id());
358 }),
359 ],
360 });
361 };
362 }
363
364 fn handle_buffer_event(
365 &mut self,
366 buffer: Entity<Buffer>,
367 event: &language::BufferEvent,
368 cx: &mut Context<Self>,
369 ) {
370 if let language::BufferEvent::Edited = event {
371 self.report_changes_for_buffer(&buffer, cx);
372 }
373 }
374
375 fn request_completion_impl<F, R>(
376 &mut self,
377 workspace: Option<Entity<Workspace>>,
378 project: Option<&Entity<Project>>,
379 buffer: &Entity<Buffer>,
380 cursor: language::Anchor,
381 can_collect_data: bool,
382 cx: &mut Context<Self>,
383 perform_predict_edits: F,
384 ) -> Task<Result<Option<EditPrediction>>>
385 where
386 F: FnOnce(PerformPredictEditsParams) -> R + 'static,
387 R: Future<Output = Result<(PredictEditsResponse, Option<EditPredictionUsage>)>>
388 + Send
389 + 'static,
390 {
391 let buffer = buffer.clone();
392 let buffer_snapshotted_at = Instant::now();
393 let snapshot = self.report_changes_for_buffer(&buffer, cx);
394 let zeta = cx.entity();
395 let events = self.events.clone();
396 let client = self.client.clone();
397 let llm_token = self.llm_token.clone();
398 let app_version = AppVersion::global(cx);
399
400 let git_info = if let (true, Some(project), Some(file)) =
401 (can_collect_data, project, snapshot.file())
402 {
403 git_info_for_file(project, &ProjectPath::from_file(file.as_ref(), cx), cx)
404 } else {
405 None
406 };
407
408 let full_path: Arc<Path> = snapshot
409 .file()
410 .map(|f| Arc::from(f.full_path(cx).as_path()))
411 .unwrap_or_else(|| Arc::from(Path::new("untitled")));
412 let full_path_str = full_path.to_string_lossy().to_string();
413 let cursor_point = cursor.to_point(&snapshot);
414 let cursor_offset = cursor_point.to_offset(&snapshot);
415 let make_events_prompt = move || prompt_for_events(&events, MAX_EVENT_TOKENS);
416 let gather_task = gather_context(
417 project,
418 full_path_str,
419 &snapshot,
420 cursor_point,
421 make_events_prompt,
422 can_collect_data,
423 git_info,
424 cx,
425 );
426
427 cx.spawn(async move |this, cx| {
428 let GatherContextOutput {
429 body,
430 editable_range,
431 } = gather_task.await?;
432
433 log::debug!(
434 "Events:\n{}\nExcerpt:\n{:?}",
435 body.input_events,
436 body.input_excerpt
437 );
438
439 let input_outline = body.outline.clone().unwrap_or_default();
440 let input_events = body.input_events.clone();
441 let input_excerpt = body.input_excerpt.clone();
442
443 let response = perform_predict_edits(PerformPredictEditsParams {
444 client,
445 llm_token,
446 app_version,
447 body,
448 })
449 .await;
450 let (response, usage) = match response {
451 Ok(response) => response,
452 Err(err) => {
453 if err.is::<ZedUpdateRequiredError>() {
454 cx.update(|cx| {
455 zeta.update(cx, |zeta, _cx| {
456 zeta.update_required = true;
457 });
458
459 if let Some(workspace) = workspace {
460 workspace.update(cx, |workspace, cx| {
461 workspace.show_notification(
462 NotificationId::unique::<ZedUpdateRequiredError>(),
463 cx,
464 |cx| {
465 cx.new(|cx| {
466 ErrorMessagePrompt::new(err.to_string(), cx)
467 .with_link_button(
468 "Update Zed",
469 "https://zed.dev/releases",
470 )
471 })
472 },
473 );
474 });
475 }
476 })
477 .ok();
478 }
479
480 return Err(err);
481 }
482 };
483
484 log::debug!("completion response: {}", &response.output_excerpt);
485
486 if let Some(usage) = usage {
487 this.update(cx, |this, cx| {
488 this.user_store.update(cx, |user_store, cx| {
489 user_store.update_edit_prediction_usage(usage, cx);
490 });
491 })
492 .ok();
493 }
494
495 Self::process_completion_response(
496 response,
497 buffer,
498 &snapshot,
499 editable_range,
500 cursor_offset,
501 full_path,
502 input_outline,
503 input_events,
504 input_excerpt,
505 buffer_snapshotted_at,
506 &cx,
507 )
508 .await
509 })
510 }
511
512 // Generates several example completions of various states to fill the Zeta completion modal
513 #[cfg(any(test, feature = "test-support"))]
514 pub fn fill_with_fake_completions(&mut self, cx: &mut Context<Self>) -> Task<()> {
515 use language::Point;
516
517 let test_buffer_text = indoc::indoc! {r#"a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
518 And maybe a short line
519
520 Then a few lines
521
522 and then another
523 "#};
524
525 let project = None;
526 let buffer = cx.new(|cx| Buffer::local(test_buffer_text, cx));
527 let position = buffer.read(cx).anchor_before(Point::new(1, 0));
528
529 let completion_tasks = vec![
530 self.fake_completion(
531 project,
532 &buffer,
533 position,
534 PredictEditsResponse {
535 request_id: Uuid::parse_str("e7861db5-0cea-4761-b1c5-ad083ac53a80").unwrap(),
536 output_excerpt: format!("{EDITABLE_REGION_START_MARKER}
537a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
538[here's an edit]
539And maybe a short line
540Then a few lines
541and then another
542{EDITABLE_REGION_END_MARKER}
543 ", ),
544 },
545 cx,
546 ),
547 self.fake_completion(
548 project,
549 &buffer,
550 position,
551 PredictEditsResponse {
552 request_id: Uuid::parse_str("077c556a-2c49-44e2-bbc6-dafc09032a5e").unwrap(),
553 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
554a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
555And maybe a short line
556[and another edit]
557Then a few lines
558and then another
559{EDITABLE_REGION_END_MARKER}
560 "#),
561 },
562 cx,
563 ),
564 self.fake_completion(
565 project,
566 &buffer,
567 position,
568 PredictEditsResponse {
569 request_id: Uuid::parse_str("df8c7b23-3d1d-4f99-a306-1f6264a41277").unwrap(),
570 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
571a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
572And maybe a short line
573
574Then a few lines
575
576and then another
577{EDITABLE_REGION_END_MARKER}
578 "#),
579 },
580 cx,
581 ),
582 self.fake_completion(
583 project,
584 &buffer,
585 position,
586 PredictEditsResponse {
587 request_id: Uuid::parse_str("c743958d-e4d8-44a8-aa5b-eb1e305c5f5c").unwrap(),
588 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
589a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
590And maybe a short line
591
592Then a few lines
593
594and then another
595{EDITABLE_REGION_END_MARKER}
596 "#),
597 },
598 cx,
599 ),
600 self.fake_completion(
601 project,
602 &buffer,
603 position,
604 PredictEditsResponse {
605 request_id: Uuid::parse_str("ff5cd7ab-ad06-4808-986e-d3391e7b8355").unwrap(),
606 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
607a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
608And maybe a short line
609Then a few lines
610[a third completion]
611and then another
612{EDITABLE_REGION_END_MARKER}
613 "#),
614 },
615 cx,
616 ),
617 self.fake_completion(
618 project,
619 &buffer,
620 position,
621 PredictEditsResponse {
622 request_id: Uuid::parse_str("83cafa55-cdba-4b27-8474-1865ea06be94").unwrap(),
623 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
624a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
625And maybe a short line
626and then another
627[fourth completion example]
628{EDITABLE_REGION_END_MARKER}
629 "#),
630 },
631 cx,
632 ),
633 self.fake_completion(
634 project,
635 &buffer,
636 position,
637 PredictEditsResponse {
638 request_id: Uuid::parse_str("d5bd3afd-8723-47c7-bd77-15a3a926867b").unwrap(),
639 output_excerpt: format!(r#"{EDITABLE_REGION_START_MARKER}
640a longggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggggg line
641And maybe a short line
642Then a few lines
643and then another
644[fifth and final completion]
645{EDITABLE_REGION_END_MARKER}
646 "#),
647 },
648 cx,
649 ),
650 ];
651
652 cx.spawn(async move |zeta, cx| {
653 for task in completion_tasks {
654 task.await.unwrap();
655 }
656
657 zeta.update(cx, |zeta, _cx| {
658 zeta.shown_completions.get_mut(2).unwrap().edits = Arc::new([]);
659 zeta.shown_completions.get_mut(3).unwrap().edits = Arc::new([]);
660 })
661 .ok();
662 })
663 }
664
665 #[cfg(any(test, feature = "test-support"))]
666 pub fn fake_completion(
667 &mut self,
668 project: Option<&Entity<Project>>,
669 buffer: &Entity<Buffer>,
670 position: language::Anchor,
671 response: PredictEditsResponse,
672 cx: &mut Context<Self>,
673 ) -> Task<Result<Option<EditPrediction>>> {
674 use std::future::ready;
675
676 self.request_completion_impl(None, project, buffer, position, false, cx, |_params| {
677 ready(Ok((response, None)))
678 })
679 }
680
681 pub fn request_completion(
682 &mut self,
683 project: Option<&Entity<Project>>,
684 buffer: &Entity<Buffer>,
685 position: language::Anchor,
686 can_collect_data: bool,
687 cx: &mut Context<Self>,
688 ) -> Task<Result<Option<EditPrediction>>> {
689 let workspace = self
690 .workspace
691 .as_ref()
692 .and_then(|workspace| workspace.upgrade());
693 self.request_completion_impl(
694 workspace,
695 project,
696 buffer,
697 position,
698 can_collect_data,
699 cx,
700 Self::perform_predict_edits,
701 )
702 }
703
704 pub fn perform_predict_edits(
705 params: PerformPredictEditsParams,
706 ) -> impl Future<Output = Result<(PredictEditsResponse, Option<EditPredictionUsage>)>> {
707 async move {
708 let PerformPredictEditsParams {
709 client,
710 llm_token,
711 app_version,
712 body,
713 ..
714 } = params;
715
716 let http_client = client.http_client();
717 let mut token = llm_token.acquire(&client).await?;
718 let mut did_retry = false;
719
720 loop {
721 let request_builder = http_client::Request::builder().method(Method::POST);
722 let request_builder =
723 if let Ok(predict_edits_url) = std::env::var("ZED_PREDICT_EDITS_URL") {
724 request_builder.uri(predict_edits_url)
725 } else {
726 request_builder.uri(
727 http_client
728 .build_zed_llm_url("/predict_edits/v2", &[])?
729 .as_ref(),
730 )
731 };
732 let request = request_builder
733 .header("Content-Type", "application/json")
734 .header("Authorization", format!("Bearer {}", token))
735 .header(ZED_VERSION_HEADER_NAME, app_version.to_string())
736 .body(serde_json::to_string(&body)?.into())?;
737
738 let mut response = http_client.send(request).await?;
739
740 if let Some(minimum_required_version) = response
741 .headers()
742 .get(MINIMUM_REQUIRED_VERSION_HEADER_NAME)
743 .and_then(|version| SemanticVersion::from_str(version.to_str().ok()?).ok())
744 {
745 anyhow::ensure!(
746 app_version >= minimum_required_version,
747 ZedUpdateRequiredError {
748 minimum_version: minimum_required_version
749 }
750 );
751 }
752
753 if response.status().is_success() {
754 let usage = EditPredictionUsage::from_headers(response.headers()).ok();
755
756 let mut body = String::new();
757 response.body_mut().read_to_string(&mut body).await?;
758 return Ok((serde_json::from_str(&body)?, usage));
759 } else if !did_retry
760 && response
761 .headers()
762 .get(EXPIRED_LLM_TOKEN_HEADER_NAME)
763 .is_some()
764 {
765 did_retry = true;
766 token = llm_token.refresh(&client).await?;
767 } else {
768 let mut body = String::new();
769 response.body_mut().read_to_string(&mut body).await?;
770 anyhow::bail!(
771 "error predicting edits.\nStatus: {:?}\nBody: {}",
772 response.status(),
773 body
774 );
775 }
776 }
777 }
778 }
779
780 fn accept_edit_prediction(
781 &mut self,
782 request_id: EditPredictionId,
783 cx: &mut Context<Self>,
784 ) -> Task<Result<()>> {
785 let client = self.client.clone();
786 let llm_token = self.llm_token.clone();
787 let app_version = AppVersion::global(cx);
788 cx.spawn(async move |this, cx| {
789 let http_client = client.http_client();
790 let mut response = llm_token_retry(&llm_token, &client, |token| {
791 let request_builder = http_client::Request::builder().method(Method::POST);
792 let request_builder =
793 if let Ok(accept_prediction_url) = std::env::var("ZED_ACCEPT_PREDICTION_URL") {
794 request_builder.uri(accept_prediction_url)
795 } else {
796 request_builder.uri(
797 http_client
798 .build_zed_llm_url("/predict_edits/accept", &[])?
799 .as_ref(),
800 )
801 };
802 Ok(request_builder
803 .header("Content-Type", "application/json")
804 .header("Authorization", format!("Bearer {}", token))
805 .header(ZED_VERSION_HEADER_NAME, app_version.to_string())
806 .body(
807 serde_json::to_string(&AcceptEditPredictionBody {
808 request_id: request_id.0,
809 })?
810 .into(),
811 )?)
812 })
813 .await?;
814
815 if let Some(minimum_required_version) = response
816 .headers()
817 .get(MINIMUM_REQUIRED_VERSION_HEADER_NAME)
818 .and_then(|version| SemanticVersion::from_str(version.to_str().ok()?).ok())
819 {
820 if app_version < minimum_required_version {
821 return Err(anyhow!(ZedUpdateRequiredError {
822 minimum_version: minimum_required_version
823 }));
824 }
825 }
826
827 if response.status().is_success() {
828 if let Some(usage) = EditPredictionUsage::from_headers(response.headers()).ok() {
829 this.update(cx, |this, cx| {
830 this.user_store.update(cx, |user_store, cx| {
831 user_store.update_edit_prediction_usage(usage, cx);
832 });
833 })?;
834 }
835
836 Ok(())
837 } else {
838 let mut body = String::new();
839 response.body_mut().read_to_string(&mut body).await?;
840 Err(anyhow!(
841 "error accepting edit prediction.\nStatus: {:?}\nBody: {}",
842 response.status(),
843 body
844 ))
845 }
846 })
847 }
848
849 fn process_completion_response(
850 prediction_response: PredictEditsResponse,
851 buffer: Entity<Buffer>,
852 snapshot: &BufferSnapshot,
853 editable_range: Range<usize>,
854 cursor_offset: usize,
855 path: Arc<Path>,
856 input_outline: String,
857 input_events: String,
858 input_excerpt: String,
859 buffer_snapshotted_at: Instant,
860 cx: &AsyncApp,
861 ) -> Task<Result<Option<EditPrediction>>> {
862 let snapshot = snapshot.clone();
863 let request_id = prediction_response.request_id;
864 let output_excerpt = prediction_response.output_excerpt;
865 cx.spawn(async move |cx| {
866 let output_excerpt: Arc<str> = output_excerpt.into();
867
868 let edits: Arc<[(Range<Anchor>, String)]> = cx
869 .background_spawn({
870 let output_excerpt = output_excerpt.clone();
871 let editable_range = editable_range.clone();
872 let snapshot = snapshot.clone();
873 async move { Self::parse_edits(output_excerpt, editable_range, &snapshot) }
874 })
875 .await?
876 .into();
877
878 let Some((edits, snapshot, edit_preview)) = buffer.read_with(cx, {
879 let edits = edits.clone();
880 |buffer, cx| {
881 let new_snapshot = buffer.snapshot();
882 let edits: Arc<[(Range<Anchor>, String)]> =
883 interpolate(&snapshot, &new_snapshot, edits)?.into();
884 Some((edits.clone(), new_snapshot, buffer.preview_edits(edits, cx)))
885 }
886 })?
887 else {
888 return anyhow::Ok(None);
889 };
890
891 let edit_preview = edit_preview.await;
892
893 Ok(Some(EditPrediction {
894 id: EditPredictionId(request_id),
895 path,
896 excerpt_range: editable_range,
897 cursor_offset,
898 edits,
899 edit_preview,
900 snapshot,
901 input_outline: input_outline.into(),
902 input_events: input_events.into(),
903 input_excerpt: input_excerpt.into(),
904 output_excerpt,
905 buffer_snapshotted_at,
906 response_received_at: Instant::now(),
907 }))
908 })
909 }
910
911 fn parse_edits(
912 output_excerpt: Arc<str>,
913 editable_range: Range<usize>,
914 snapshot: &BufferSnapshot,
915 ) -> Result<Vec<(Range<Anchor>, String)>> {
916 let content = output_excerpt.replace(CURSOR_MARKER, "");
917
918 let start_markers = content
919 .match_indices(EDITABLE_REGION_START_MARKER)
920 .collect::<Vec<_>>();
921 anyhow::ensure!(
922 start_markers.len() == 1,
923 "expected exactly one start marker, found {}",
924 start_markers.len()
925 );
926
927 let end_markers = content
928 .match_indices(EDITABLE_REGION_END_MARKER)
929 .collect::<Vec<_>>();
930 anyhow::ensure!(
931 end_markers.len() == 1,
932 "expected exactly one end marker, found {}",
933 end_markers.len()
934 );
935
936 let sof_markers = content
937 .match_indices(START_OF_FILE_MARKER)
938 .collect::<Vec<_>>();
939 anyhow::ensure!(
940 sof_markers.len() <= 1,
941 "expected at most one start-of-file marker, found {}",
942 sof_markers.len()
943 );
944
945 let codefence_start = start_markers[0].0;
946 let content = &content[codefence_start..];
947
948 let newline_ix = content.find('\n').context("could not find newline")?;
949 let content = &content[newline_ix + 1..];
950
951 let codefence_end = content
952 .rfind(&format!("\n{EDITABLE_REGION_END_MARKER}"))
953 .context("could not find end marker")?;
954 let new_text = &content[..codefence_end];
955
956 let old_text = snapshot
957 .text_for_range(editable_range.clone())
958 .collect::<String>();
959
960 Ok(Self::compute_edits(
961 old_text,
962 new_text,
963 editable_range.start,
964 &snapshot,
965 ))
966 }
967
968 pub fn compute_edits(
969 old_text: String,
970 new_text: &str,
971 offset: usize,
972 snapshot: &BufferSnapshot,
973 ) -> Vec<(Range<Anchor>, String)> {
974 text_diff(&old_text, &new_text)
975 .into_iter()
976 .map(|(mut old_range, new_text)| {
977 old_range.start += offset;
978 old_range.end += offset;
979
980 let prefix_len = common_prefix(
981 snapshot.chars_for_range(old_range.clone()),
982 new_text.chars(),
983 );
984 old_range.start += prefix_len;
985
986 let suffix_len = common_prefix(
987 snapshot.reversed_chars_for_range(old_range.clone()),
988 new_text[prefix_len..].chars().rev(),
989 );
990 old_range.end = old_range.end.saturating_sub(suffix_len);
991
992 let new_text = new_text[prefix_len..new_text.len() - suffix_len].to_string();
993 let range = if old_range.is_empty() {
994 let anchor = snapshot.anchor_after(old_range.start);
995 anchor..anchor
996 } else {
997 snapshot.anchor_after(old_range.start)..snapshot.anchor_before(old_range.end)
998 };
999 (range, new_text)
1000 })
1001 .collect()
1002 }
1003
1004 pub fn is_completion_rated(&self, completion_id: EditPredictionId) -> bool {
1005 self.rated_completions.contains(&completion_id)
1006 }
1007
1008 pub fn completion_shown(&mut self, completion: &EditPrediction, cx: &mut Context<Self>) {
1009 self.shown_completions.push_front(completion.clone());
1010 if self.shown_completions.len() > 50 {
1011 let completion = self.shown_completions.pop_back().unwrap();
1012 self.rated_completions.remove(&completion.id);
1013 }
1014 cx.notify();
1015 }
1016
1017 pub fn rate_completion(
1018 &mut self,
1019 completion: &EditPrediction,
1020 rating: EditPredictionRating,
1021 feedback: String,
1022 cx: &mut Context<Self>,
1023 ) {
1024 self.rated_completions.insert(completion.id);
1025 telemetry::event!(
1026 "Edit Prediction Rated",
1027 rating,
1028 input_events = completion.input_events,
1029 input_excerpt = completion.input_excerpt,
1030 input_outline = completion.input_outline,
1031 output_excerpt = completion.output_excerpt,
1032 feedback
1033 );
1034 self.client.telemetry().flush_events().detach();
1035 cx.notify();
1036 }
1037
1038 pub fn shown_completions(&self) -> impl DoubleEndedIterator<Item = &EditPrediction> {
1039 self.shown_completions.iter()
1040 }
1041
1042 pub fn shown_completions_len(&self) -> usize {
1043 self.shown_completions.len()
1044 }
1045
1046 fn report_changes_for_buffer(
1047 &mut self,
1048 buffer: &Entity<Buffer>,
1049 cx: &mut Context<Self>,
1050 ) -> BufferSnapshot {
1051 self.register_buffer(buffer, cx);
1052
1053 let registered_buffer = self
1054 .registered_buffers
1055 .get_mut(&buffer.entity_id())
1056 .unwrap();
1057 let new_snapshot = buffer.read(cx).snapshot();
1058
1059 if new_snapshot.version != registered_buffer.snapshot.version {
1060 let old_snapshot = mem::replace(&mut registered_buffer.snapshot, new_snapshot.clone());
1061 self.push_event(Event::BufferChange {
1062 old_snapshot,
1063 new_snapshot: new_snapshot.clone(),
1064 timestamp: Instant::now(),
1065 });
1066 }
1067
1068 new_snapshot
1069 }
1070
1071 fn load_data_collection_choices() -> DataCollectionChoice {
1072 let choice = KEY_VALUE_STORE
1073 .read_kvp(ZED_PREDICT_DATA_COLLECTION_CHOICE)
1074 .log_err()
1075 .flatten();
1076
1077 match choice.as_deref() {
1078 Some("true") => DataCollectionChoice::Enabled,
1079 Some("false") => DataCollectionChoice::Disabled,
1080 Some(_) => {
1081 log::error!("unknown value in '{ZED_PREDICT_DATA_COLLECTION_CHOICE}'");
1082 DataCollectionChoice::NotAnswered
1083 }
1084 None => DataCollectionChoice::NotAnswered,
1085 }
1086 }
1087}
1088
1089pub struct PerformPredictEditsParams {
1090 pub client: Arc<Client>,
1091 pub llm_token: LlmApiToken,
1092 pub app_version: SemanticVersion,
1093 pub body: PredictEditsBody,
1094}
1095
1096#[derive(Error, Debug)]
1097#[error(
1098 "You must update to Zed version {minimum_version} or higher to continue using edit predictions."
1099)]
1100pub struct ZedUpdateRequiredError {
1101 minimum_version: SemanticVersion,
1102}
1103
1104fn common_prefix<T1: Iterator<Item = char>, T2: Iterator<Item = char>>(a: T1, b: T2) -> usize {
1105 a.zip(b)
1106 .take_while(|(a, b)| a == b)
1107 .map(|(a, _)| a.len_utf8())
1108 .sum()
1109}
1110
1111fn git_info_for_file(
1112 project: &Entity<Project>,
1113 project_path: &ProjectPath,
1114 cx: &App,
1115) -> Option<PredictEditsGitInfo> {
1116 let git_store = project.read(cx).git_store().read(cx);
1117 if let Some((repository, _repo_path)) =
1118 git_store.repository_and_path_for_project_path(project_path, cx)
1119 {
1120 let repository = repository.read(cx);
1121 let head_sha = repository
1122 .head_commit
1123 .as_ref()
1124 .map(|head_commit| head_commit.sha.to_string());
1125 let remote_origin_url = repository.remote_origin_url.clone();
1126 let remote_upstream_url = repository.remote_upstream_url.clone();
1127 if head_sha.is_none() && remote_origin_url.is_none() && remote_upstream_url.is_none() {
1128 return None;
1129 }
1130 Some(PredictEditsGitInfo {
1131 head_sha,
1132 remote_origin_url,
1133 remote_upstream_url,
1134 })
1135 } else {
1136 None
1137 }
1138}
1139
1140pub struct GatherContextOutput {
1141 pub body: PredictEditsBody,
1142 pub editable_range: Range<usize>,
1143}
1144
1145pub fn gather_context(
1146 project: Option<&Entity<Project>>,
1147 full_path_str: String,
1148 snapshot: &BufferSnapshot,
1149 cursor_point: language::Point,
1150 make_events_prompt: impl FnOnce() -> String + Send + 'static,
1151 can_collect_data: bool,
1152 git_info: Option<PredictEditsGitInfo>,
1153 cx: &App,
1154) -> Task<Result<GatherContextOutput>> {
1155 let local_lsp_store =
1156 project.and_then(|project| project.read(cx).lsp_store().read(cx).as_local());
1157 let diagnostic_groups: Vec<(String, serde_json::Value)> =
1158 if can_collect_data && let Some(local_lsp_store) = local_lsp_store {
1159 snapshot
1160 .diagnostic_groups(None)
1161 .into_iter()
1162 .filter_map(|(language_server_id, diagnostic_group)| {
1163 let language_server =
1164 local_lsp_store.running_language_server_for_id(language_server_id)?;
1165 let diagnostic_group = diagnostic_group.resolve::<usize>(&snapshot);
1166 let language_server_name = language_server.name().to_string();
1167 let serialized = serde_json::to_value(diagnostic_group).unwrap();
1168 Some((language_server_name, serialized))
1169 })
1170 .collect::<Vec<_>>()
1171 } else {
1172 Vec::new()
1173 };
1174
1175 cx.background_spawn({
1176 let snapshot = snapshot.clone();
1177 async move {
1178 let diagnostic_groups = if diagnostic_groups.is_empty()
1179 || diagnostic_groups.len() >= MAX_DIAGNOSTIC_GROUPS
1180 {
1181 None
1182 } else {
1183 Some(diagnostic_groups)
1184 };
1185
1186 let input_excerpt = excerpt_for_cursor_position(
1187 cursor_point,
1188 &full_path_str,
1189 &snapshot,
1190 MAX_REWRITE_TOKENS,
1191 MAX_CONTEXT_TOKENS,
1192 );
1193 let input_events = make_events_prompt();
1194 let editable_range = input_excerpt.editable_range.to_offset(&snapshot);
1195
1196 let body = PredictEditsBody {
1197 input_events,
1198 input_excerpt: input_excerpt.prompt,
1199 can_collect_data,
1200 diagnostic_groups,
1201 git_info,
1202 outline: None,
1203 speculated_output: None,
1204 };
1205
1206 Ok(GatherContextOutput {
1207 body,
1208 editable_range,
1209 })
1210 }
1211 })
1212}
1213
1214fn prompt_for_events(events: &VecDeque<Event>, mut remaining_tokens: usize) -> String {
1215 let mut result = String::new();
1216 for event in events.iter().rev() {
1217 let event_string = event.to_prompt();
1218 let event_tokens = tokens_for_bytes(event_string.len());
1219 if event_tokens > remaining_tokens {
1220 break;
1221 }
1222
1223 if !result.is_empty() {
1224 result.insert_str(0, "\n\n");
1225 }
1226 result.insert_str(0, &event_string);
1227 remaining_tokens -= event_tokens;
1228 }
1229 result
1230}
1231
1232struct RegisteredBuffer {
1233 snapshot: BufferSnapshot,
1234 _subscriptions: [gpui::Subscription; 2],
1235}
1236
1237#[derive(Clone)]
1238pub enum Event {
1239 BufferChange {
1240 old_snapshot: BufferSnapshot,
1241 new_snapshot: BufferSnapshot,
1242 timestamp: Instant,
1243 },
1244}
1245
1246impl Event {
1247 fn to_prompt(&self) -> String {
1248 match self {
1249 Event::BufferChange {
1250 old_snapshot,
1251 new_snapshot,
1252 ..
1253 } => {
1254 let mut prompt = String::new();
1255
1256 let old_path = old_snapshot
1257 .file()
1258 .map(|f| f.path().as_ref())
1259 .unwrap_or(Path::new("untitled"));
1260 let new_path = new_snapshot
1261 .file()
1262 .map(|f| f.path().as_ref())
1263 .unwrap_or(Path::new("untitled"));
1264 if old_path != new_path {
1265 writeln!(prompt, "User renamed {:?} to {:?}\n", old_path, new_path).unwrap();
1266 }
1267
1268 let diff = language::unified_diff(&old_snapshot.text(), &new_snapshot.text());
1269 if !diff.is_empty() {
1270 write!(
1271 prompt,
1272 "User edited {:?}:\n```diff\n{}\n```",
1273 new_path, diff
1274 )
1275 .unwrap();
1276 }
1277
1278 prompt
1279 }
1280 }
1281 }
1282}
1283
1284#[derive(Debug, Clone)]
1285struct CurrentEditPrediction {
1286 buffer_id: EntityId,
1287 completion: EditPrediction,
1288}
1289
1290impl CurrentEditPrediction {
1291 fn should_replace_completion(&self, old_completion: &Self, snapshot: &BufferSnapshot) -> bool {
1292 if self.buffer_id != old_completion.buffer_id {
1293 return true;
1294 }
1295
1296 let Some(old_edits) = old_completion.completion.interpolate(&snapshot) else {
1297 return true;
1298 };
1299 let Some(new_edits) = self.completion.interpolate(&snapshot) else {
1300 return false;
1301 };
1302
1303 if old_edits.len() == 1 && new_edits.len() == 1 {
1304 let (old_range, old_text) = &old_edits[0];
1305 let (new_range, new_text) = &new_edits[0];
1306 new_range == old_range && new_text.starts_with(old_text)
1307 } else {
1308 true
1309 }
1310 }
1311}
1312
1313struct PendingCompletion {
1314 id: usize,
1315 _task: Task<()>,
1316}
1317
1318#[derive(Debug, Clone, Copy)]
1319pub enum DataCollectionChoice {
1320 NotAnswered,
1321 Enabled,
1322 Disabled,
1323}
1324
1325impl DataCollectionChoice {
1326 pub fn is_enabled(self) -> bool {
1327 match self {
1328 Self::Enabled => true,
1329 Self::NotAnswered | Self::Disabled => false,
1330 }
1331 }
1332
1333 pub fn is_answered(self) -> bool {
1334 match self {
1335 Self::Enabled | Self::Disabled => true,
1336 Self::NotAnswered => false,
1337 }
1338 }
1339
1340 pub fn toggle(&self) -> DataCollectionChoice {
1341 match self {
1342 Self::Enabled => Self::Disabled,
1343 Self::Disabled => Self::Enabled,
1344 Self::NotAnswered => Self::Enabled,
1345 }
1346 }
1347}
1348
1349impl From<bool> for DataCollectionChoice {
1350 fn from(value: bool) -> Self {
1351 match value {
1352 true => DataCollectionChoice::Enabled,
1353 false => DataCollectionChoice::Disabled,
1354 }
1355 }
1356}
1357
1358pub struct ProviderDataCollection {
1359 /// When set to None, data collection is not possible in the provider buffer
1360 choice: Option<Entity<DataCollectionChoice>>,
1361 license_detection_watcher: Option<Rc<LicenseDetectionWatcher>>,
1362}
1363
1364impl ProviderDataCollection {
1365 pub fn new(zeta: Entity<Zeta>, buffer: Option<Entity<Buffer>>, cx: &mut App) -> Self {
1366 let choice_and_watcher = buffer.and_then(|buffer| {
1367 let file = buffer.read(cx).file()?;
1368
1369 if !file.is_local() || file.is_private() {
1370 return None;
1371 }
1372
1373 let zeta = zeta.read(cx);
1374 let choice = zeta.data_collection_choice.clone();
1375
1376 let license_detection_watcher = zeta
1377 .license_detection_watchers
1378 .get(&file.worktree_id(cx))
1379 .cloned()?;
1380
1381 Some((choice, license_detection_watcher))
1382 });
1383
1384 if let Some((choice, watcher)) = choice_and_watcher {
1385 ProviderDataCollection {
1386 choice: Some(choice),
1387 license_detection_watcher: Some(watcher),
1388 }
1389 } else {
1390 ProviderDataCollection {
1391 choice: None,
1392 license_detection_watcher: None,
1393 }
1394 }
1395 }
1396
1397 pub fn can_collect_data(&self, cx: &App) -> bool {
1398 self.is_data_collection_enabled(cx) && self.is_project_open_source()
1399 }
1400
1401 pub fn is_data_collection_enabled(&self, cx: &App) -> bool {
1402 self.choice
1403 .as_ref()
1404 .is_some_and(|choice| choice.read(cx).is_enabled())
1405 }
1406
1407 fn is_project_open_source(&self) -> bool {
1408 self.license_detection_watcher
1409 .as_ref()
1410 .is_some_and(|watcher| watcher.is_project_open_source())
1411 }
1412
1413 pub fn toggle(&mut self, cx: &mut App) {
1414 if let Some(choice) = self.choice.as_mut() {
1415 let new_choice = choice.update(cx, |choice, _cx| {
1416 let new_choice = choice.toggle();
1417 *choice = new_choice;
1418 new_choice
1419 });
1420
1421 db::write_and_log(cx, move || {
1422 KEY_VALUE_STORE.write_kvp(
1423 ZED_PREDICT_DATA_COLLECTION_CHOICE.into(),
1424 new_choice.is_enabled().to_string(),
1425 )
1426 });
1427 }
1428 }
1429}
1430
1431async fn llm_token_retry(
1432 llm_token: &LlmApiToken,
1433 client: &Arc<Client>,
1434 build_request: impl Fn(String) -> Result<Request<AsyncBody>>,
1435) -> Result<Response<AsyncBody>> {
1436 let mut did_retry = false;
1437 let http_client = client.http_client();
1438 let mut token = llm_token.acquire(client).await?;
1439 loop {
1440 let request = build_request(token.clone())?;
1441 let response = http_client.send(request).await?;
1442
1443 if !did_retry
1444 && !response.status().is_success()
1445 && response
1446 .headers()
1447 .get(EXPIRED_LLM_TOKEN_HEADER_NAME)
1448 .is_some()
1449 {
1450 did_retry = true;
1451 token = llm_token.refresh(client).await?;
1452 continue;
1453 }
1454
1455 return Ok(response);
1456 }
1457}
1458
1459pub struct ZetaEditPredictionProvider {
1460 zeta: Entity<Zeta>,
1461 pending_completions: ArrayVec<PendingCompletion, 2>,
1462 next_pending_completion_id: usize,
1463 current_completion: Option<CurrentEditPrediction>,
1464 /// None if this is entirely disabled for this provider
1465 provider_data_collection: ProviderDataCollection,
1466 last_request_timestamp: Instant,
1467}
1468
1469impl ZetaEditPredictionProvider {
1470 pub const THROTTLE_TIMEOUT: Duration = Duration::from_millis(300);
1471
1472 pub fn new(zeta: Entity<Zeta>, provider_data_collection: ProviderDataCollection) -> Self {
1473 Self {
1474 zeta,
1475 pending_completions: ArrayVec::new(),
1476 next_pending_completion_id: 0,
1477 current_completion: None,
1478 provider_data_collection,
1479 last_request_timestamp: Instant::now(),
1480 }
1481 }
1482}
1483
1484impl edit_prediction::EditPredictionProvider for ZetaEditPredictionProvider {
1485 fn name() -> &'static str {
1486 "zed-predict"
1487 }
1488
1489 fn display_name() -> &'static str {
1490 "Zed's Edit Predictions"
1491 }
1492
1493 fn show_completions_in_menu() -> bool {
1494 true
1495 }
1496
1497 fn show_tab_accept_marker() -> bool {
1498 true
1499 }
1500
1501 fn data_collection_state(&self, cx: &App) -> DataCollectionState {
1502 let is_project_open_source = self.provider_data_collection.is_project_open_source();
1503
1504 if self.provider_data_collection.is_data_collection_enabled(cx) {
1505 DataCollectionState::Enabled {
1506 is_project_open_source,
1507 }
1508 } else {
1509 DataCollectionState::Disabled {
1510 is_project_open_source,
1511 }
1512 }
1513 }
1514
1515 fn toggle_data_collection(&mut self, cx: &mut App) {
1516 self.provider_data_collection.toggle(cx);
1517 }
1518
1519 fn usage(&self, cx: &App) -> Option<EditPredictionUsage> {
1520 self.zeta.read(cx).usage(cx)
1521 }
1522
1523 fn is_enabled(
1524 &self,
1525 _buffer: &Entity<Buffer>,
1526 _cursor_position: language::Anchor,
1527 _cx: &App,
1528 ) -> bool {
1529 true
1530 }
1531
1532 fn needs_terms_acceptance(&self, cx: &App) -> bool {
1533 !self
1534 .zeta
1535 .read(cx)
1536 .user_store
1537 .read(cx)
1538 .has_accepted_terms_of_service()
1539 }
1540
1541 fn is_refreshing(&self) -> bool {
1542 !self.pending_completions.is_empty()
1543 }
1544
1545 fn refresh(
1546 &mut self,
1547 project: Option<Entity<Project>>,
1548 buffer: Entity<Buffer>,
1549 position: language::Anchor,
1550 _debounce: bool,
1551 cx: &mut Context<Self>,
1552 ) {
1553 if self.needs_terms_acceptance(cx) {
1554 return;
1555 }
1556
1557 if self.zeta.read(cx).update_required {
1558 return;
1559 }
1560
1561 if self
1562 .zeta
1563 .read(cx)
1564 .user_store
1565 .read_with(cx, |user_store, _cx| {
1566 user_store.account_too_young() || user_store.has_overdue_invoices()
1567 })
1568 {
1569 return;
1570 }
1571
1572 if let Some(current_completion) = self.current_completion.as_ref() {
1573 let snapshot = buffer.read(cx).snapshot();
1574 if current_completion
1575 .completion
1576 .interpolate(&snapshot)
1577 .is_some()
1578 {
1579 return;
1580 }
1581 }
1582
1583 let pending_completion_id = self.next_pending_completion_id;
1584 self.next_pending_completion_id += 1;
1585 let can_collect_data = self.provider_data_collection.can_collect_data(cx);
1586 let last_request_timestamp = self.last_request_timestamp;
1587
1588 let task = cx.spawn(async move |this, cx| {
1589 if let Some(timeout) = (last_request_timestamp + Self::THROTTLE_TIMEOUT)
1590 .checked_duration_since(Instant::now())
1591 {
1592 cx.background_executor().timer(timeout).await;
1593 }
1594
1595 let completion_request = this.update(cx, |this, cx| {
1596 this.last_request_timestamp = Instant::now();
1597 this.zeta.update(cx, |zeta, cx| {
1598 zeta.request_completion(
1599 project.as_ref(),
1600 &buffer,
1601 position,
1602 can_collect_data,
1603 cx,
1604 )
1605 })
1606 });
1607
1608 let completion = match completion_request {
1609 Ok(completion_request) => {
1610 let completion_request = completion_request.await;
1611 completion_request.map(|c| {
1612 c.map(|completion| CurrentEditPrediction {
1613 buffer_id: buffer.entity_id(),
1614 completion,
1615 })
1616 })
1617 }
1618 Err(error) => Err(error),
1619 };
1620 let Some(new_completion) = completion
1621 .context("edit prediction failed")
1622 .log_err()
1623 .flatten()
1624 else {
1625 this.update(cx, |this, cx| {
1626 if this.pending_completions[0].id == pending_completion_id {
1627 this.pending_completions.remove(0);
1628 } else {
1629 this.pending_completions.clear();
1630 }
1631
1632 cx.notify();
1633 })
1634 .ok();
1635 return;
1636 };
1637
1638 this.update(cx, |this, cx| {
1639 if this.pending_completions[0].id == pending_completion_id {
1640 this.pending_completions.remove(0);
1641 } else {
1642 this.pending_completions.clear();
1643 }
1644
1645 if let Some(old_completion) = this.current_completion.as_ref() {
1646 let snapshot = buffer.read(cx).snapshot();
1647 if new_completion.should_replace_completion(&old_completion, &snapshot) {
1648 this.zeta.update(cx, |zeta, cx| {
1649 zeta.completion_shown(&new_completion.completion, cx);
1650 });
1651 this.current_completion = Some(new_completion);
1652 }
1653 } else {
1654 this.zeta.update(cx, |zeta, cx| {
1655 zeta.completion_shown(&new_completion.completion, cx);
1656 });
1657 this.current_completion = Some(new_completion);
1658 }
1659
1660 cx.notify();
1661 })
1662 .ok();
1663 });
1664
1665 // We always maintain at most two pending completions. When we already
1666 // have two, we replace the newest one.
1667 if self.pending_completions.len() <= 1 {
1668 self.pending_completions.push(PendingCompletion {
1669 id: pending_completion_id,
1670 _task: task,
1671 });
1672 } else if self.pending_completions.len() == 2 {
1673 self.pending_completions.pop();
1674 self.pending_completions.push(PendingCompletion {
1675 id: pending_completion_id,
1676 _task: task,
1677 });
1678 }
1679 }
1680
1681 fn cycle(
1682 &mut self,
1683 _buffer: Entity<Buffer>,
1684 _cursor_position: language::Anchor,
1685 _direction: edit_prediction::Direction,
1686 _cx: &mut Context<Self>,
1687 ) {
1688 // Right now we don't support cycling.
1689 }
1690
1691 fn accept(&mut self, cx: &mut Context<Self>) {
1692 let completion_id = self
1693 .current_completion
1694 .as_ref()
1695 .map(|completion| completion.completion.id);
1696 if let Some(completion_id) = completion_id {
1697 self.zeta
1698 .update(cx, |zeta, cx| {
1699 zeta.accept_edit_prediction(completion_id, cx)
1700 })
1701 .detach();
1702 }
1703 self.pending_completions.clear();
1704 }
1705
1706 fn discard(&mut self, _cx: &mut Context<Self>) {
1707 self.pending_completions.clear();
1708 self.current_completion.take();
1709 }
1710
1711 fn suggest(
1712 &mut self,
1713 buffer: &Entity<Buffer>,
1714 cursor_position: language::Anchor,
1715 cx: &mut Context<Self>,
1716 ) -> Option<edit_prediction::EditPrediction> {
1717 let CurrentEditPrediction {
1718 buffer_id,
1719 completion,
1720 ..
1721 } = self.current_completion.as_mut()?;
1722
1723 // Invalidate previous completion if it was generated for a different buffer.
1724 if *buffer_id != buffer.entity_id() {
1725 self.current_completion.take();
1726 return None;
1727 }
1728
1729 let buffer = buffer.read(cx);
1730 let Some(edits) = completion.interpolate(&buffer.snapshot()) else {
1731 self.current_completion.take();
1732 return None;
1733 };
1734
1735 let cursor_row = cursor_position.to_point(buffer).row;
1736 let (closest_edit_ix, (closest_edit_range, _)) =
1737 edits.iter().enumerate().min_by_key(|(_, (range, _))| {
1738 let distance_from_start = cursor_row.abs_diff(range.start.to_point(buffer).row);
1739 let distance_from_end = cursor_row.abs_diff(range.end.to_point(buffer).row);
1740 cmp::min(distance_from_start, distance_from_end)
1741 })?;
1742
1743 let mut edit_start_ix = closest_edit_ix;
1744 for (range, _) in edits[..edit_start_ix].iter().rev() {
1745 let distance_from_closest_edit =
1746 closest_edit_range.start.to_point(buffer).row - range.end.to_point(buffer).row;
1747 if distance_from_closest_edit <= 1 {
1748 edit_start_ix -= 1;
1749 } else {
1750 break;
1751 }
1752 }
1753
1754 let mut edit_end_ix = closest_edit_ix + 1;
1755 for (range, _) in &edits[edit_end_ix..] {
1756 let distance_from_closest_edit =
1757 range.start.to_point(buffer).row - closest_edit_range.end.to_point(buffer).row;
1758 if distance_from_closest_edit <= 1 {
1759 edit_end_ix += 1;
1760 } else {
1761 break;
1762 }
1763 }
1764
1765 Some(edit_prediction::EditPrediction {
1766 id: Some(completion.id.to_string().into()),
1767 edits: edits[edit_start_ix..edit_end_ix].to_vec(),
1768 edit_preview: Some(completion.edit_preview.clone()),
1769 })
1770 }
1771}
1772
1773fn tokens_for_bytes(bytes: usize) -> usize {
1774 /// Typical number of string bytes per token for the purposes of limiting model input. This is
1775 /// intentionally low to err on the side of underestimating limits.
1776 const BYTES_PER_TOKEN_GUESS: usize = 3;
1777 bytes / BYTES_PER_TOKEN_GUESS
1778}
1779
1780#[cfg(test)]
1781mod tests {
1782 use client::UserStore;
1783 use client::test::FakeServer;
1784 use clock::FakeSystemClock;
1785 use cloud_api_types::{CreateLlmTokenResponse, LlmToken};
1786 use gpui::TestAppContext;
1787 use http_client::FakeHttpClient;
1788 use indoc::indoc;
1789 use language::Point;
1790 use settings::SettingsStore;
1791
1792 use super::*;
1793
1794 #[gpui::test]
1795 async fn test_edit_prediction_basic_interpolation(cx: &mut TestAppContext) {
1796 let buffer = cx.new(|cx| Buffer::local("Lorem ipsum dolor", cx));
1797 let edits: Arc<[(Range<Anchor>, String)]> = cx.update(|cx| {
1798 to_completion_edits(
1799 [(2..5, "REM".to_string()), (9..11, "".to_string())],
1800 &buffer,
1801 cx,
1802 )
1803 .into()
1804 });
1805
1806 let edit_preview = cx
1807 .read(|cx| buffer.read(cx).preview_edits(edits.clone(), cx))
1808 .await;
1809
1810 let completion = EditPrediction {
1811 edits,
1812 edit_preview,
1813 path: Path::new("").into(),
1814 snapshot: cx.read(|cx| buffer.read(cx).snapshot()),
1815 id: EditPredictionId(Uuid::new_v4()),
1816 excerpt_range: 0..0,
1817 cursor_offset: 0,
1818 input_outline: "".into(),
1819 input_events: "".into(),
1820 input_excerpt: "".into(),
1821 output_excerpt: "".into(),
1822 buffer_snapshotted_at: Instant::now(),
1823 response_received_at: Instant::now(),
1824 };
1825
1826 cx.update(|cx| {
1827 assert_eq!(
1828 from_completion_edits(
1829 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1830 &buffer,
1831 cx
1832 ),
1833 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1834 );
1835
1836 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "")], None, cx));
1837 assert_eq!(
1838 from_completion_edits(
1839 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1840 &buffer,
1841 cx
1842 ),
1843 vec![(2..2, "REM".to_string()), (6..8, "".to_string())]
1844 );
1845
1846 buffer.update(cx, |buffer, cx| buffer.undo(cx));
1847 assert_eq!(
1848 from_completion_edits(
1849 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1850 &buffer,
1851 cx
1852 ),
1853 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1854 );
1855
1856 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "R")], None, cx));
1857 assert_eq!(
1858 from_completion_edits(
1859 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1860 &buffer,
1861 cx
1862 ),
1863 vec![(3..3, "EM".to_string()), (7..9, "".to_string())]
1864 );
1865
1866 buffer.update(cx, |buffer, cx| buffer.edit([(3..3, "E")], None, cx));
1867 assert_eq!(
1868 from_completion_edits(
1869 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1870 &buffer,
1871 cx
1872 ),
1873 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1874 );
1875
1876 buffer.update(cx, |buffer, cx| buffer.edit([(4..4, "M")], None, cx));
1877 assert_eq!(
1878 from_completion_edits(
1879 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1880 &buffer,
1881 cx
1882 ),
1883 vec![(9..11, "".to_string())]
1884 );
1885
1886 buffer.update(cx, |buffer, cx| buffer.edit([(4..5, "")], None, cx));
1887 assert_eq!(
1888 from_completion_edits(
1889 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1890 &buffer,
1891 cx
1892 ),
1893 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1894 );
1895
1896 buffer.update(cx, |buffer, cx| buffer.edit([(8..10, "")], None, cx));
1897 assert_eq!(
1898 from_completion_edits(
1899 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1900 &buffer,
1901 cx
1902 ),
1903 vec![(4..4, "M".to_string())]
1904 );
1905
1906 buffer.update(cx, |buffer, cx| buffer.edit([(4..6, "")], None, cx));
1907 assert_eq!(completion.interpolate(&buffer.read(cx).snapshot()), None);
1908 })
1909 }
1910
1911 #[gpui::test]
1912 async fn test_clean_up_diff(cx: &mut TestAppContext) {
1913 cx.update(|cx| {
1914 let settings_store = SettingsStore::test(cx);
1915 cx.set_global(settings_store);
1916 client::init_settings(cx);
1917 });
1918
1919 let edits = edits_for_prediction(
1920 indoc! {"
1921 fn main() {
1922 let word_1 = \"lorem\";
1923 let range = word.len()..word.len();
1924 }
1925 "},
1926 indoc! {"
1927 <|editable_region_start|>
1928 fn main() {
1929 let word_1 = \"lorem\";
1930 let range = word_1.len()..word_1.len();
1931 }
1932
1933 <|editable_region_end|>
1934 "},
1935 cx,
1936 )
1937 .await;
1938 assert_eq!(
1939 edits,
1940 [
1941 (Point::new(2, 20)..Point::new(2, 20), "_1".to_string()),
1942 (Point::new(2, 32)..Point::new(2, 32), "_1".to_string()),
1943 ]
1944 );
1945
1946 let edits = edits_for_prediction(
1947 indoc! {"
1948 fn main() {
1949 let story = \"the quick\"
1950 }
1951 "},
1952 indoc! {"
1953 <|editable_region_start|>
1954 fn main() {
1955 let story = \"the quick brown fox jumps over the lazy dog\";
1956 }
1957
1958 <|editable_region_end|>
1959 "},
1960 cx,
1961 )
1962 .await;
1963 assert_eq!(
1964 edits,
1965 [
1966 (
1967 Point::new(1, 26)..Point::new(1, 26),
1968 " brown fox jumps over the lazy dog".to_string()
1969 ),
1970 (Point::new(1, 27)..Point::new(1, 27), ";".to_string()),
1971 ]
1972 );
1973 }
1974
1975 #[gpui::test]
1976 async fn test_edit_prediction_end_of_buffer(cx: &mut TestAppContext) {
1977 cx.update(|cx| {
1978 let settings_store = SettingsStore::test(cx);
1979 cx.set_global(settings_store);
1980 client::init_settings(cx);
1981 });
1982
1983 let buffer_content = "lorem\n";
1984 let completion_response = indoc! {"
1985 ```animals.js
1986 <|start_of_file|>
1987 <|editable_region_start|>
1988 lorem
1989 ipsum
1990 <|editable_region_end|>
1991 ```"};
1992
1993 let http_client = FakeHttpClient::create(move |req| async move {
1994 match (req.method(), req.uri().path()) {
1995 (&Method::POST, "/client/llm_tokens") => Ok(http_client::Response::builder()
1996 .status(200)
1997 .body(
1998 serde_json::to_string(&CreateLlmTokenResponse {
1999 token: LlmToken("the-llm-token".to_string()),
2000 })
2001 .unwrap()
2002 .into(),
2003 )
2004 .unwrap()),
2005 (&Method::POST, "/predict_edits/v2") => Ok(http_client::Response::builder()
2006 .status(200)
2007 .body(
2008 serde_json::to_string(&PredictEditsResponse {
2009 request_id: Uuid::parse_str("7e86480f-3536-4d2c-9334-8213e3445d45")
2010 .unwrap(),
2011 output_excerpt: completion_response.to_string(),
2012 })
2013 .unwrap()
2014 .into(),
2015 )
2016 .unwrap()),
2017 _ => Ok(http_client::Response::builder()
2018 .status(404)
2019 .body("Not Found".into())
2020 .unwrap()),
2021 }
2022 });
2023
2024 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
2025 cx.update(|cx| {
2026 RefreshLlmTokenListener::register(client.clone(), cx);
2027 });
2028 // Construct the fake server to authenticate.
2029 let _server = FakeServer::for_client(42, &client, cx).await;
2030 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
2031 let zeta = cx.new(|cx| Zeta::new(None, client, user_store.clone(), cx));
2032
2033 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
2034 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
2035 let completion_task = zeta.update(cx, |zeta, cx| {
2036 zeta.request_completion(None, &buffer, cursor, false, cx)
2037 });
2038
2039 let completion = completion_task.await.unwrap().unwrap();
2040 buffer.update(cx, |buffer, cx| {
2041 buffer.edit(completion.edits.iter().cloned(), None, cx)
2042 });
2043 assert_eq!(
2044 buffer.read_with(cx, |buffer, _| buffer.text()),
2045 "lorem\nipsum"
2046 );
2047 }
2048
2049 async fn edits_for_prediction(
2050 buffer_content: &str,
2051 completion_response: &str,
2052 cx: &mut TestAppContext,
2053 ) -> Vec<(Range<Point>, String)> {
2054 let completion_response = completion_response.to_string();
2055 let http_client = FakeHttpClient::create(move |req| {
2056 let completion = completion_response.clone();
2057 async move {
2058 match (req.method(), req.uri().path()) {
2059 (&Method::POST, "/client/llm_tokens") => Ok(http_client::Response::builder()
2060 .status(200)
2061 .body(
2062 serde_json::to_string(&CreateLlmTokenResponse {
2063 token: LlmToken("the-llm-token".to_string()),
2064 })
2065 .unwrap()
2066 .into(),
2067 )
2068 .unwrap()),
2069 (&Method::POST, "/predict_edits/v2") => Ok(http_client::Response::builder()
2070 .status(200)
2071 .body(
2072 serde_json::to_string(&PredictEditsResponse {
2073 request_id: Uuid::new_v4(),
2074 output_excerpt: completion,
2075 })
2076 .unwrap()
2077 .into(),
2078 )
2079 .unwrap()),
2080 _ => Ok(http_client::Response::builder()
2081 .status(404)
2082 .body("Not Found".into())
2083 .unwrap()),
2084 }
2085 }
2086 });
2087
2088 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
2089 cx.update(|cx| {
2090 RefreshLlmTokenListener::register(client.clone(), cx);
2091 });
2092 // Construct the fake server to authenticate.
2093 let _server = FakeServer::for_client(42, &client, cx).await;
2094 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
2095 let zeta = cx.new(|cx| Zeta::new(None, client, user_store.clone(), cx));
2096
2097 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
2098 let snapshot = buffer.read_with(cx, |buffer, _| buffer.snapshot());
2099 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
2100 let completion_task = zeta.update(cx, |zeta, cx| {
2101 zeta.request_completion(None, &buffer, cursor, false, cx)
2102 });
2103
2104 let completion = completion_task.await.unwrap().unwrap();
2105 completion
2106 .edits
2107 .into_iter()
2108 .map(|(old_range, new_text)| (old_range.to_point(&snapshot), new_text.clone()))
2109 .collect::<Vec<_>>()
2110 }
2111
2112 fn to_completion_edits(
2113 iterator: impl IntoIterator<Item = (Range<usize>, String)>,
2114 buffer: &Entity<Buffer>,
2115 cx: &App,
2116 ) -> Vec<(Range<Anchor>, String)> {
2117 let buffer = buffer.read(cx);
2118 iterator
2119 .into_iter()
2120 .map(|(range, text)| {
2121 (
2122 buffer.anchor_after(range.start)..buffer.anchor_before(range.end),
2123 text,
2124 )
2125 })
2126 .collect()
2127 }
2128
2129 fn from_completion_edits(
2130 editor_edits: &[(Range<Anchor>, String)],
2131 buffer: &Entity<Buffer>,
2132 cx: &App,
2133 ) -> Vec<(Range<usize>, String)> {
2134 let buffer = buffer.read(cx);
2135 editor_edits
2136 .iter()
2137 .map(|(range, text)| {
2138 (
2139 range.start.to_offset(buffer)..range.end.to_offset(buffer),
2140 text.clone(),
2141 )
2142 })
2143 .collect()
2144 }
2145
2146 #[ctor::ctor]
2147 fn init_logger() {
2148 zlog::init_test();
2149 }
2150}