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