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 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 return Err(anyhow!(ZedUpdateRequiredError {
841 minimum_version: minimum_required_version
842 }));
843 }
844
845 if response.status().is_success() {
846 if let Some(usage) = EditPredictionUsage::from_headers(response.headers()).ok() {
847 this.update(cx, |this, cx| {
848 this.user_store.update(cx, |user_store, cx| {
849 user_store.update_edit_prediction_usage(usage, cx);
850 });
851 })?;
852 }
853
854 Ok(())
855 } else {
856 let mut body = String::new();
857 response.body_mut().read_to_string(&mut body).await?;
858 Err(anyhow!(
859 "error accepting edit prediction.\nStatus: {:?}\nBody: {}",
860 response.status(),
861 body
862 ))
863 }
864 })
865 }
866
867 fn process_completion_response(
868 prediction_response: PredictEditsResponse,
869 buffer: Entity<Buffer>,
870 snapshot: &BufferSnapshot,
871 editable_range: Range<usize>,
872 cursor_offset: usize,
873 path: Arc<Path>,
874 input_outline: String,
875 input_events: String,
876 input_excerpt: String,
877 buffer_snapshotted_at: Instant,
878 cx: &AsyncApp,
879 ) -> Task<Result<Option<EditPrediction>>> {
880 let snapshot = snapshot.clone();
881 let request_id = prediction_response.request_id;
882 let output_excerpt = prediction_response.output_excerpt;
883 cx.spawn(async move |cx| {
884 let output_excerpt: Arc<str> = output_excerpt.into();
885
886 let edits: Arc<[(Range<Anchor>, String)]> = cx
887 .background_spawn({
888 let output_excerpt = output_excerpt.clone();
889 let editable_range = editable_range.clone();
890 let snapshot = snapshot.clone();
891 async move { Self::parse_edits(output_excerpt, editable_range, &snapshot) }
892 })
893 .await?
894 .into();
895
896 let Some((edits, snapshot, edit_preview)) = buffer.read_with(cx, {
897 let edits = edits.clone();
898 |buffer, cx| {
899 let new_snapshot = buffer.snapshot();
900 let edits: Arc<[(Range<Anchor>, String)]> =
901 interpolate(&snapshot, &new_snapshot, edits)?.into();
902 Some((edits.clone(), new_snapshot, buffer.preview_edits(edits, cx)))
903 }
904 })?
905 else {
906 return anyhow::Ok(None);
907 };
908
909 let edit_preview = edit_preview.await;
910
911 Ok(Some(EditPrediction {
912 id: EditPredictionId(request_id),
913 path,
914 excerpt_range: editable_range,
915 cursor_offset,
916 edits,
917 edit_preview,
918 snapshot,
919 input_outline: input_outline.into(),
920 input_events: input_events.into(),
921 input_excerpt: input_excerpt.into(),
922 output_excerpt,
923 buffer_snapshotted_at,
924 response_received_at: Instant::now(),
925 }))
926 })
927 }
928
929 fn parse_edits(
930 output_excerpt: Arc<str>,
931 editable_range: Range<usize>,
932 snapshot: &BufferSnapshot,
933 ) -> Result<Vec<(Range<Anchor>, String)>> {
934 let content = output_excerpt.replace(CURSOR_MARKER, "");
935
936 let start_markers = content
937 .match_indices(EDITABLE_REGION_START_MARKER)
938 .collect::<Vec<_>>();
939 anyhow::ensure!(
940 start_markers.len() == 1,
941 "expected exactly one start marker, found {}",
942 start_markers.len()
943 );
944
945 let end_markers = content
946 .match_indices(EDITABLE_REGION_END_MARKER)
947 .collect::<Vec<_>>();
948 anyhow::ensure!(
949 end_markers.len() == 1,
950 "expected exactly one end marker, found {}",
951 end_markers.len()
952 );
953
954 let sof_markers = content
955 .match_indices(START_OF_FILE_MARKER)
956 .collect::<Vec<_>>();
957 anyhow::ensure!(
958 sof_markers.len() <= 1,
959 "expected at most one start-of-file marker, found {}",
960 sof_markers.len()
961 );
962
963 let codefence_start = start_markers[0].0;
964 let content = &content[codefence_start..];
965
966 let newline_ix = content.find('\n').context("could not find newline")?;
967 let content = &content[newline_ix + 1..];
968
969 let codefence_end = content
970 .rfind(&format!("\n{EDITABLE_REGION_END_MARKER}"))
971 .context("could not find end marker")?;
972 let new_text = &content[..codefence_end];
973
974 let old_text = snapshot
975 .text_for_range(editable_range.clone())
976 .collect::<String>();
977
978 Ok(Self::compute_edits(
979 old_text,
980 new_text,
981 editable_range.start,
982 snapshot,
983 ))
984 }
985
986 pub fn compute_edits(
987 old_text: String,
988 new_text: &str,
989 offset: usize,
990 snapshot: &BufferSnapshot,
991 ) -> Vec<(Range<Anchor>, String)> {
992 text_diff(&old_text, new_text)
993 .into_iter()
994 .map(|(mut old_range, new_text)| {
995 old_range.start += offset;
996 old_range.end += offset;
997
998 let prefix_len = common_prefix(
999 snapshot.chars_for_range(old_range.clone()),
1000 new_text.chars(),
1001 );
1002 old_range.start += prefix_len;
1003
1004 let suffix_len = common_prefix(
1005 snapshot.reversed_chars_for_range(old_range.clone()),
1006 new_text[prefix_len..].chars().rev(),
1007 );
1008 old_range.end = old_range.end.saturating_sub(suffix_len);
1009
1010 let new_text = new_text[prefix_len..new_text.len() - suffix_len].to_string();
1011 let range = if old_range.is_empty() {
1012 let anchor = snapshot.anchor_after(old_range.start);
1013 anchor..anchor
1014 } else {
1015 snapshot.anchor_after(old_range.start)..snapshot.anchor_before(old_range.end)
1016 };
1017 (range, new_text)
1018 })
1019 .collect()
1020 }
1021
1022 pub fn is_completion_rated(&self, completion_id: EditPredictionId) -> bool {
1023 self.rated_completions.contains(&completion_id)
1024 }
1025
1026 pub fn completion_shown(&mut self, completion: &EditPrediction, cx: &mut Context<Self>) {
1027 self.shown_completions.push_front(completion.clone());
1028 if self.shown_completions.len() > 50 {
1029 let completion = self.shown_completions.pop_back().unwrap();
1030 self.rated_completions.remove(&completion.id);
1031 }
1032 cx.notify();
1033 }
1034
1035 pub fn rate_completion(
1036 &mut self,
1037 completion: &EditPrediction,
1038 rating: EditPredictionRating,
1039 feedback: String,
1040 cx: &mut Context<Self>,
1041 ) {
1042 self.rated_completions.insert(completion.id);
1043 telemetry::event!(
1044 "Edit Prediction Rated",
1045 rating,
1046 input_events = completion.input_events,
1047 input_excerpt = completion.input_excerpt,
1048 input_outline = completion.input_outline,
1049 output_excerpt = completion.output_excerpt,
1050 feedback
1051 );
1052 self.client.telemetry().flush_events().detach();
1053 cx.notify();
1054 }
1055
1056 pub fn shown_completions(&self) -> impl DoubleEndedIterator<Item = &EditPrediction> {
1057 self.shown_completions.iter()
1058 }
1059
1060 pub fn shown_completions_len(&self) -> usize {
1061 self.shown_completions.len()
1062 }
1063
1064 fn report_changes_for_buffer(
1065 &mut self,
1066 buffer: &Entity<Buffer>,
1067 cx: &mut Context<Self>,
1068 ) -> BufferSnapshot {
1069 self.register_buffer(buffer, cx);
1070
1071 let registered_buffer = self
1072 .registered_buffers
1073 .get_mut(&buffer.entity_id())
1074 .unwrap();
1075 let new_snapshot = buffer.read(cx).snapshot();
1076
1077 if new_snapshot.version != registered_buffer.snapshot.version {
1078 let old_snapshot = mem::replace(&mut registered_buffer.snapshot, new_snapshot.clone());
1079 self.push_event(Event::BufferChange {
1080 old_snapshot,
1081 new_snapshot: new_snapshot.clone(),
1082 timestamp: Instant::now(),
1083 });
1084 }
1085
1086 new_snapshot
1087 }
1088
1089 fn load_data_collection_choices() -> DataCollectionChoice {
1090 let choice = KEY_VALUE_STORE
1091 .read_kvp(ZED_PREDICT_DATA_COLLECTION_CHOICE)
1092 .log_err()
1093 .flatten();
1094
1095 match choice.as_deref() {
1096 Some("true") => DataCollectionChoice::Enabled,
1097 Some("false") => DataCollectionChoice::Disabled,
1098 Some(_) => {
1099 log::error!("unknown value in '{ZED_PREDICT_DATA_COLLECTION_CHOICE}'");
1100 DataCollectionChoice::NotAnswered
1101 }
1102 None => DataCollectionChoice::NotAnswered,
1103 }
1104 }
1105}
1106
1107pub struct PerformPredictEditsParams {
1108 pub client: Arc<Client>,
1109 pub llm_token: LlmApiToken,
1110 pub app_version: SemanticVersion,
1111 pub body: PredictEditsBody,
1112}
1113
1114#[derive(Error, Debug)]
1115#[error(
1116 "You must update to Zed version {minimum_version} or higher to continue using edit predictions."
1117)]
1118pub struct ZedUpdateRequiredError {
1119 minimum_version: SemanticVersion,
1120}
1121
1122fn common_prefix<T1: Iterator<Item = char>, T2: Iterator<Item = char>>(a: T1, b: T2) -> usize {
1123 a.zip(b)
1124 .take_while(|(a, b)| a == b)
1125 .map(|(a, _)| a.len_utf8())
1126 .sum()
1127}
1128
1129fn git_info_for_file(
1130 project: &Entity<Project>,
1131 project_path: &ProjectPath,
1132 cx: &App,
1133) -> Option<PredictEditsGitInfo> {
1134 let git_store = project.read(cx).git_store().read(cx);
1135 if let Some((repository, _repo_path)) =
1136 git_store.repository_and_path_for_project_path(project_path, cx)
1137 {
1138 let repository = repository.read(cx);
1139 let head_sha = repository
1140 .head_commit
1141 .as_ref()
1142 .map(|head_commit| head_commit.sha.to_string());
1143 let remote_origin_url = repository.remote_origin_url.clone();
1144 let remote_upstream_url = repository.remote_upstream_url.clone();
1145 if head_sha.is_none() && remote_origin_url.is_none() && remote_upstream_url.is_none() {
1146 return None;
1147 }
1148 Some(PredictEditsGitInfo {
1149 head_sha,
1150 remote_origin_url,
1151 remote_upstream_url,
1152 })
1153 } else {
1154 None
1155 }
1156}
1157
1158pub struct GatherContextOutput {
1159 pub body: PredictEditsBody,
1160 pub editable_range: Range<usize>,
1161}
1162
1163pub fn gather_context(
1164 project: Option<&Entity<Project>>,
1165 full_path_str: String,
1166 snapshot: &BufferSnapshot,
1167 cursor_point: language::Point,
1168 make_events_prompt: impl FnOnce() -> String + Send + 'static,
1169 can_collect_data: bool,
1170 git_info: Option<PredictEditsGitInfo>,
1171 cx: &App,
1172) -> Task<Result<GatherContextOutput>> {
1173 let local_lsp_store =
1174 project.and_then(|project| project.read(cx).lsp_store().read(cx).as_local());
1175 let diagnostic_groups: Vec<(String, serde_json::Value)> =
1176 if can_collect_data && let Some(local_lsp_store) = local_lsp_store {
1177 snapshot
1178 .diagnostic_groups(None)
1179 .into_iter()
1180 .filter_map(|(language_server_id, diagnostic_group)| {
1181 let language_server =
1182 local_lsp_store.running_language_server_for_id(language_server_id)?;
1183 let diagnostic_group = diagnostic_group.resolve::<usize>(snapshot);
1184 let language_server_name = language_server.name().to_string();
1185 let serialized = serde_json::to_value(diagnostic_group).unwrap();
1186 Some((language_server_name, serialized))
1187 })
1188 .collect::<Vec<_>>()
1189 } else {
1190 Vec::new()
1191 };
1192
1193 cx.background_spawn({
1194 let snapshot = snapshot.clone();
1195 async move {
1196 let diagnostic_groups = if diagnostic_groups.is_empty()
1197 || diagnostic_groups.len() >= MAX_DIAGNOSTIC_GROUPS
1198 {
1199 None
1200 } else {
1201 Some(diagnostic_groups)
1202 };
1203
1204 let input_excerpt = excerpt_for_cursor_position(
1205 cursor_point,
1206 &full_path_str,
1207 &snapshot,
1208 MAX_REWRITE_TOKENS,
1209 MAX_CONTEXT_TOKENS,
1210 );
1211 let input_events = make_events_prompt();
1212 let editable_range = input_excerpt.editable_range.to_offset(&snapshot);
1213
1214 let body = PredictEditsBody {
1215 input_events,
1216 input_excerpt: input_excerpt.prompt,
1217 can_collect_data,
1218 diagnostic_groups,
1219 git_info,
1220 outline: None,
1221 speculated_output: None,
1222 };
1223
1224 Ok(GatherContextOutput {
1225 body,
1226 editable_range,
1227 })
1228 }
1229 })
1230}
1231
1232fn prompt_for_events(events: &VecDeque<Event>, mut remaining_tokens: usize) -> String {
1233 let mut result = String::new();
1234 for event in events.iter().rev() {
1235 let event_string = event.to_prompt();
1236 let event_tokens = tokens_for_bytes(event_string.len());
1237 if event_tokens > remaining_tokens {
1238 break;
1239 }
1240
1241 if !result.is_empty() {
1242 result.insert_str(0, "\n\n");
1243 }
1244 result.insert_str(0, &event_string);
1245 remaining_tokens -= event_tokens;
1246 }
1247 result
1248}
1249
1250struct RegisteredBuffer {
1251 snapshot: BufferSnapshot,
1252 _subscriptions: [gpui::Subscription; 2],
1253}
1254
1255#[derive(Clone)]
1256pub enum Event {
1257 BufferChange {
1258 old_snapshot: BufferSnapshot,
1259 new_snapshot: BufferSnapshot,
1260 timestamp: Instant,
1261 },
1262}
1263
1264impl Event {
1265 fn to_prompt(&self) -> String {
1266 match self {
1267 Event::BufferChange {
1268 old_snapshot,
1269 new_snapshot,
1270 ..
1271 } => {
1272 let mut prompt = String::new();
1273
1274 let old_path = old_snapshot
1275 .file()
1276 .map(|f| f.path().as_ref())
1277 .unwrap_or(Path::new("untitled"));
1278 let new_path = new_snapshot
1279 .file()
1280 .map(|f| f.path().as_ref())
1281 .unwrap_or(Path::new("untitled"));
1282 if old_path != new_path {
1283 writeln!(prompt, "User renamed {:?} to {:?}\n", old_path, new_path).unwrap();
1284 }
1285
1286 let diff = language::unified_diff(&old_snapshot.text(), &new_snapshot.text());
1287 if !diff.is_empty() {
1288 write!(
1289 prompt,
1290 "User edited {:?}:\n```diff\n{}\n```",
1291 new_path, diff
1292 )
1293 .unwrap();
1294 }
1295
1296 prompt
1297 }
1298 }
1299 }
1300}
1301
1302#[derive(Debug, Clone)]
1303struct CurrentEditPrediction {
1304 buffer_id: EntityId,
1305 completion: EditPrediction,
1306}
1307
1308impl CurrentEditPrediction {
1309 fn should_replace_completion(&self, old_completion: &Self, snapshot: &BufferSnapshot) -> bool {
1310 if self.buffer_id != old_completion.buffer_id {
1311 return true;
1312 }
1313
1314 let Some(old_edits) = old_completion.completion.interpolate(snapshot) else {
1315 return true;
1316 };
1317 let Some(new_edits) = self.completion.interpolate(snapshot) else {
1318 return false;
1319 };
1320
1321 if old_edits.len() == 1 && new_edits.len() == 1 {
1322 let (old_range, old_text) = &old_edits[0];
1323 let (new_range, new_text) = &new_edits[0];
1324 new_range == old_range && new_text.starts_with(old_text)
1325 } else {
1326 true
1327 }
1328 }
1329}
1330
1331struct PendingCompletion {
1332 id: usize,
1333 _task: Task<()>,
1334}
1335
1336#[derive(Debug, Clone, Copy)]
1337pub enum DataCollectionChoice {
1338 NotAnswered,
1339 Enabled,
1340 Disabled,
1341}
1342
1343impl DataCollectionChoice {
1344 pub fn is_enabled(self) -> bool {
1345 match self {
1346 Self::Enabled => true,
1347 Self::NotAnswered | Self::Disabled => false,
1348 }
1349 }
1350
1351 pub fn is_answered(self) -> bool {
1352 match self {
1353 Self::Enabled | Self::Disabled => true,
1354 Self::NotAnswered => false,
1355 }
1356 }
1357
1358 pub fn toggle(&self) -> DataCollectionChoice {
1359 match self {
1360 Self::Enabled => Self::Disabled,
1361 Self::Disabled => Self::Enabled,
1362 Self::NotAnswered => Self::Enabled,
1363 }
1364 }
1365}
1366
1367impl From<bool> for DataCollectionChoice {
1368 fn from(value: bool) -> Self {
1369 match value {
1370 true => DataCollectionChoice::Enabled,
1371 false => DataCollectionChoice::Disabled,
1372 }
1373 }
1374}
1375
1376pub struct ProviderDataCollection {
1377 /// When set to None, data collection is not possible in the provider buffer
1378 choice: Option<Entity<DataCollectionChoice>>,
1379 license_detection_watcher: Option<Rc<LicenseDetectionWatcher>>,
1380}
1381
1382impl ProviderDataCollection {
1383 pub fn new(zeta: Entity<Zeta>, buffer: Option<Entity<Buffer>>, cx: &mut App) -> Self {
1384 let choice_and_watcher = buffer.and_then(|buffer| {
1385 let file = buffer.read(cx).file()?;
1386
1387 if !file.is_local() || file.is_private() {
1388 return None;
1389 }
1390
1391 let zeta = zeta.read(cx);
1392 let choice = zeta.data_collection_choice.clone();
1393
1394 let license_detection_watcher = zeta
1395 .license_detection_watchers
1396 .get(&file.worktree_id(cx))
1397 .cloned()?;
1398
1399 Some((choice, license_detection_watcher))
1400 });
1401
1402 if let Some((choice, watcher)) = choice_and_watcher {
1403 ProviderDataCollection {
1404 choice: Some(choice),
1405 license_detection_watcher: Some(watcher),
1406 }
1407 } else {
1408 ProviderDataCollection {
1409 choice: None,
1410 license_detection_watcher: None,
1411 }
1412 }
1413 }
1414
1415 pub fn can_collect_data(&self, cx: &App) -> bool {
1416 self.is_data_collection_enabled(cx) && self.is_project_open_source()
1417 }
1418
1419 pub fn is_data_collection_enabled(&self, cx: &App) -> bool {
1420 self.choice
1421 .as_ref()
1422 .is_some_and(|choice| choice.read(cx).is_enabled())
1423 }
1424
1425 fn is_project_open_source(&self) -> bool {
1426 self.license_detection_watcher
1427 .as_ref()
1428 .is_some_and(|watcher| watcher.is_project_open_source())
1429 }
1430
1431 pub fn toggle(&mut self, cx: &mut App) {
1432 if let Some(choice) = self.choice.as_mut() {
1433 let new_choice = choice.update(cx, |choice, _cx| {
1434 let new_choice = choice.toggle();
1435 *choice = new_choice;
1436 new_choice
1437 });
1438
1439 db::write_and_log(cx, move || {
1440 KEY_VALUE_STORE.write_kvp(
1441 ZED_PREDICT_DATA_COLLECTION_CHOICE.into(),
1442 new_choice.is_enabled().to_string(),
1443 )
1444 });
1445 }
1446 }
1447}
1448
1449async fn llm_token_retry(
1450 llm_token: &LlmApiToken,
1451 client: &Arc<Client>,
1452 build_request: impl Fn(String) -> Result<Request<AsyncBody>>,
1453) -> Result<Response<AsyncBody>> {
1454 let mut did_retry = false;
1455 let http_client = client.http_client();
1456 let mut token = llm_token.acquire(client).await?;
1457 loop {
1458 let request = build_request(token.clone())?;
1459 let response = http_client.send(request).await?;
1460
1461 if !did_retry
1462 && !response.status().is_success()
1463 && response
1464 .headers()
1465 .get(EXPIRED_LLM_TOKEN_HEADER_NAME)
1466 .is_some()
1467 {
1468 did_retry = true;
1469 token = llm_token.refresh(client).await?;
1470 continue;
1471 }
1472
1473 return Ok(response);
1474 }
1475}
1476
1477pub struct ZetaEditPredictionProvider {
1478 zeta: Entity<Zeta>,
1479 pending_completions: ArrayVec<PendingCompletion, 2>,
1480 next_pending_completion_id: usize,
1481 current_completion: Option<CurrentEditPrediction>,
1482 /// None if this is entirely disabled for this provider
1483 provider_data_collection: ProviderDataCollection,
1484 last_request_timestamp: Instant,
1485}
1486
1487impl ZetaEditPredictionProvider {
1488 pub const THROTTLE_TIMEOUT: Duration = Duration::from_millis(300);
1489
1490 pub fn new(zeta: Entity<Zeta>, provider_data_collection: ProviderDataCollection) -> Self {
1491 Self {
1492 zeta,
1493 pending_completions: ArrayVec::new(),
1494 next_pending_completion_id: 0,
1495 current_completion: None,
1496 provider_data_collection,
1497 last_request_timestamp: Instant::now(),
1498 }
1499 }
1500}
1501
1502impl edit_prediction::EditPredictionProvider for ZetaEditPredictionProvider {
1503 fn name() -> &'static str {
1504 "zed-predict"
1505 }
1506
1507 fn display_name() -> &'static str {
1508 "Zed's Edit Predictions"
1509 }
1510
1511 fn show_completions_in_menu() -> bool {
1512 true
1513 }
1514
1515 fn show_tab_accept_marker() -> bool {
1516 true
1517 }
1518
1519 fn data_collection_state(&self, cx: &App) -> DataCollectionState {
1520 let is_project_open_source = self.provider_data_collection.is_project_open_source();
1521
1522 if self.provider_data_collection.is_data_collection_enabled(cx) {
1523 DataCollectionState::Enabled {
1524 is_project_open_source,
1525 }
1526 } else {
1527 DataCollectionState::Disabled {
1528 is_project_open_source,
1529 }
1530 }
1531 }
1532
1533 fn toggle_data_collection(&mut self, cx: &mut App) {
1534 self.provider_data_collection.toggle(cx);
1535 }
1536
1537 fn usage(&self, cx: &App) -> Option<EditPredictionUsage> {
1538 self.zeta.read(cx).usage(cx)
1539 }
1540
1541 fn is_enabled(
1542 &self,
1543 _buffer: &Entity<Buffer>,
1544 _cursor_position: language::Anchor,
1545 _cx: &App,
1546 ) -> bool {
1547 true
1548 }
1549
1550 fn needs_terms_acceptance(&self, cx: &App) -> bool {
1551 !self
1552 .zeta
1553 .read(cx)
1554 .user_store
1555 .read(cx)
1556 .has_accepted_terms_of_service()
1557 }
1558
1559 fn is_refreshing(&self) -> bool {
1560 !self.pending_completions.is_empty()
1561 }
1562
1563 fn refresh(
1564 &mut self,
1565 project: Option<Entity<Project>>,
1566 buffer: Entity<Buffer>,
1567 position: language::Anchor,
1568 _debounce: bool,
1569 cx: &mut Context<Self>,
1570 ) {
1571 if self.needs_terms_acceptance(cx) {
1572 return;
1573 }
1574
1575 if self.zeta.read(cx).update_required {
1576 return;
1577 }
1578
1579 if self
1580 .zeta
1581 .read(cx)
1582 .user_store
1583 .read_with(cx, |user_store, _cx| {
1584 user_store.account_too_young() || user_store.has_overdue_invoices()
1585 })
1586 {
1587 return;
1588 }
1589
1590 if let Some(current_completion) = self.current_completion.as_ref() {
1591 let snapshot = buffer.read(cx).snapshot();
1592 if current_completion
1593 .completion
1594 .interpolate(&snapshot)
1595 .is_some()
1596 {
1597 return;
1598 }
1599 }
1600
1601 let pending_completion_id = self.next_pending_completion_id;
1602 self.next_pending_completion_id += 1;
1603 let can_collect_data = self.provider_data_collection.can_collect_data(cx);
1604 let last_request_timestamp = self.last_request_timestamp;
1605
1606 let task = cx.spawn(async move |this, cx| {
1607 if let Some(timeout) = (last_request_timestamp + Self::THROTTLE_TIMEOUT)
1608 .checked_duration_since(Instant::now())
1609 {
1610 cx.background_executor().timer(timeout).await;
1611 }
1612
1613 let completion_request = this.update(cx, |this, cx| {
1614 this.last_request_timestamp = Instant::now();
1615 this.zeta.update(cx, |zeta, cx| {
1616 zeta.request_completion(
1617 project.as_ref(),
1618 &buffer,
1619 position,
1620 can_collect_data,
1621 cx,
1622 )
1623 })
1624 });
1625
1626 let completion = match completion_request {
1627 Ok(completion_request) => {
1628 let completion_request = completion_request.await;
1629 completion_request.map(|c| {
1630 c.map(|completion| CurrentEditPrediction {
1631 buffer_id: buffer.entity_id(),
1632 completion,
1633 })
1634 })
1635 }
1636 Err(error) => Err(error),
1637 };
1638 let Some(new_completion) = completion
1639 .context("edit prediction failed")
1640 .log_err()
1641 .flatten()
1642 else {
1643 this.update(cx, |this, cx| {
1644 if this.pending_completions[0].id == pending_completion_id {
1645 this.pending_completions.remove(0);
1646 } else {
1647 this.pending_completions.clear();
1648 }
1649
1650 cx.notify();
1651 })
1652 .ok();
1653 return;
1654 };
1655
1656 this.update(cx, |this, cx| {
1657 if this.pending_completions[0].id == pending_completion_id {
1658 this.pending_completions.remove(0);
1659 } else {
1660 this.pending_completions.clear();
1661 }
1662
1663 if let Some(old_completion) = this.current_completion.as_ref() {
1664 let snapshot = buffer.read(cx).snapshot();
1665 if new_completion.should_replace_completion(old_completion, &snapshot) {
1666 this.zeta.update(cx, |zeta, cx| {
1667 zeta.completion_shown(&new_completion.completion, cx);
1668 });
1669 this.current_completion = Some(new_completion);
1670 }
1671 } else {
1672 this.zeta.update(cx, |zeta, cx| {
1673 zeta.completion_shown(&new_completion.completion, cx);
1674 });
1675 this.current_completion = Some(new_completion);
1676 }
1677
1678 cx.notify();
1679 })
1680 .ok();
1681 });
1682
1683 // We always maintain at most two pending completions. When we already
1684 // have two, we replace the newest one.
1685 if self.pending_completions.len() <= 1 {
1686 self.pending_completions.push(PendingCompletion {
1687 id: pending_completion_id,
1688 _task: task,
1689 });
1690 } else if self.pending_completions.len() == 2 {
1691 self.pending_completions.pop();
1692 self.pending_completions.push(PendingCompletion {
1693 id: pending_completion_id,
1694 _task: task,
1695 });
1696 }
1697 }
1698
1699 fn cycle(
1700 &mut self,
1701 _buffer: Entity<Buffer>,
1702 _cursor_position: language::Anchor,
1703 _direction: edit_prediction::Direction,
1704 _cx: &mut Context<Self>,
1705 ) {
1706 // Right now we don't support cycling.
1707 }
1708
1709 fn accept(&mut self, cx: &mut Context<Self>) {
1710 let completion_id = self
1711 .current_completion
1712 .as_ref()
1713 .map(|completion| completion.completion.id);
1714 if let Some(completion_id) = completion_id {
1715 self.zeta
1716 .update(cx, |zeta, cx| {
1717 zeta.accept_edit_prediction(completion_id, cx)
1718 })
1719 .detach();
1720 }
1721 self.pending_completions.clear();
1722 }
1723
1724 fn discard(&mut self, _cx: &mut Context<Self>) {
1725 self.pending_completions.clear();
1726 self.current_completion.take();
1727 }
1728
1729 fn suggest(
1730 &mut self,
1731 buffer: &Entity<Buffer>,
1732 cursor_position: language::Anchor,
1733 cx: &mut Context<Self>,
1734 ) -> Option<edit_prediction::EditPrediction> {
1735 let CurrentEditPrediction {
1736 buffer_id,
1737 completion,
1738 ..
1739 } = self.current_completion.as_mut()?;
1740
1741 // Invalidate previous completion if it was generated for a different buffer.
1742 if *buffer_id != buffer.entity_id() {
1743 self.current_completion.take();
1744 return None;
1745 }
1746
1747 let buffer = buffer.read(cx);
1748 let Some(edits) = completion.interpolate(&buffer.snapshot()) else {
1749 self.current_completion.take();
1750 return None;
1751 };
1752
1753 let cursor_row = cursor_position.to_point(buffer).row;
1754 let (closest_edit_ix, (closest_edit_range, _)) =
1755 edits.iter().enumerate().min_by_key(|(_, (range, _))| {
1756 let distance_from_start = cursor_row.abs_diff(range.start.to_point(buffer).row);
1757 let distance_from_end = cursor_row.abs_diff(range.end.to_point(buffer).row);
1758 cmp::min(distance_from_start, distance_from_end)
1759 })?;
1760
1761 let mut edit_start_ix = closest_edit_ix;
1762 for (range, _) in edits[..edit_start_ix].iter().rev() {
1763 let distance_from_closest_edit =
1764 closest_edit_range.start.to_point(buffer).row - range.end.to_point(buffer).row;
1765 if distance_from_closest_edit <= 1 {
1766 edit_start_ix -= 1;
1767 } else {
1768 break;
1769 }
1770 }
1771
1772 let mut edit_end_ix = closest_edit_ix + 1;
1773 for (range, _) in &edits[edit_end_ix..] {
1774 let distance_from_closest_edit =
1775 range.start.to_point(buffer).row - closest_edit_range.end.to_point(buffer).row;
1776 if distance_from_closest_edit <= 1 {
1777 edit_end_ix += 1;
1778 } else {
1779 break;
1780 }
1781 }
1782
1783 Some(edit_prediction::EditPrediction {
1784 id: Some(completion.id.to_string().into()),
1785 edits: edits[edit_start_ix..edit_end_ix].to_vec(),
1786 edit_preview: Some(completion.edit_preview.clone()),
1787 })
1788 }
1789}
1790
1791fn tokens_for_bytes(bytes: usize) -> usize {
1792 /// Typical number of string bytes per token for the purposes of limiting model input. This is
1793 /// intentionally low to err on the side of underestimating limits.
1794 const BYTES_PER_TOKEN_GUESS: usize = 3;
1795 bytes / BYTES_PER_TOKEN_GUESS
1796}
1797
1798#[cfg(test)]
1799mod tests {
1800 use client::UserStore;
1801 use client::test::FakeServer;
1802 use clock::FakeSystemClock;
1803 use cloud_api_types::{CreateLlmTokenResponse, LlmToken};
1804 use gpui::TestAppContext;
1805 use http_client::FakeHttpClient;
1806 use indoc::indoc;
1807 use language::Point;
1808 use settings::SettingsStore;
1809
1810 use super::*;
1811
1812 #[gpui::test]
1813 async fn test_edit_prediction_basic_interpolation(cx: &mut TestAppContext) {
1814 let buffer = cx.new(|cx| Buffer::local("Lorem ipsum dolor", cx));
1815 let edits: Arc<[(Range<Anchor>, String)]> = cx.update(|cx| {
1816 to_completion_edits(
1817 [(2..5, "REM".to_string()), (9..11, "".to_string())],
1818 &buffer,
1819 cx,
1820 )
1821 .into()
1822 });
1823
1824 let edit_preview = cx
1825 .read(|cx| buffer.read(cx).preview_edits(edits.clone(), cx))
1826 .await;
1827
1828 let completion = EditPrediction {
1829 edits,
1830 edit_preview,
1831 path: Path::new("").into(),
1832 snapshot: cx.read(|cx| buffer.read(cx).snapshot()),
1833 id: EditPredictionId(Uuid::new_v4()),
1834 excerpt_range: 0..0,
1835 cursor_offset: 0,
1836 input_outline: "".into(),
1837 input_events: "".into(),
1838 input_excerpt: "".into(),
1839 output_excerpt: "".into(),
1840 buffer_snapshotted_at: Instant::now(),
1841 response_received_at: Instant::now(),
1842 };
1843
1844 cx.update(|cx| {
1845 assert_eq!(
1846 from_completion_edits(
1847 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1848 &buffer,
1849 cx
1850 ),
1851 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1852 );
1853
1854 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "")], None, cx));
1855 assert_eq!(
1856 from_completion_edits(
1857 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1858 &buffer,
1859 cx
1860 ),
1861 vec![(2..2, "REM".to_string()), (6..8, "".to_string())]
1862 );
1863
1864 buffer.update(cx, |buffer, cx| buffer.undo(cx));
1865 assert_eq!(
1866 from_completion_edits(
1867 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1868 &buffer,
1869 cx
1870 ),
1871 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1872 );
1873
1874 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "R")], None, cx));
1875 assert_eq!(
1876 from_completion_edits(
1877 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1878 &buffer,
1879 cx
1880 ),
1881 vec![(3..3, "EM".to_string()), (7..9, "".to_string())]
1882 );
1883
1884 buffer.update(cx, |buffer, cx| buffer.edit([(3..3, "E")], None, cx));
1885 assert_eq!(
1886 from_completion_edits(
1887 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1888 &buffer,
1889 cx
1890 ),
1891 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1892 );
1893
1894 buffer.update(cx, |buffer, cx| buffer.edit([(4..4, "M")], None, cx));
1895 assert_eq!(
1896 from_completion_edits(
1897 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1898 &buffer,
1899 cx
1900 ),
1901 vec![(9..11, "".to_string())]
1902 );
1903
1904 buffer.update(cx, |buffer, cx| buffer.edit([(4..5, "")], None, cx));
1905 assert_eq!(
1906 from_completion_edits(
1907 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1908 &buffer,
1909 cx
1910 ),
1911 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1912 );
1913
1914 buffer.update(cx, |buffer, cx| buffer.edit([(8..10, "")], None, cx));
1915 assert_eq!(
1916 from_completion_edits(
1917 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1918 &buffer,
1919 cx
1920 ),
1921 vec![(4..4, "M".to_string())]
1922 );
1923
1924 buffer.update(cx, |buffer, cx| buffer.edit([(4..6, "")], None, cx));
1925 assert_eq!(completion.interpolate(&buffer.read(cx).snapshot()), None);
1926 })
1927 }
1928
1929 #[gpui::test]
1930 async fn test_clean_up_diff(cx: &mut TestAppContext) {
1931 cx.update(|cx| {
1932 let settings_store = SettingsStore::test(cx);
1933 cx.set_global(settings_store);
1934 client::init_settings(cx);
1935 });
1936
1937 let edits = edits_for_prediction(
1938 indoc! {"
1939 fn main() {
1940 let word_1 = \"lorem\";
1941 let range = word.len()..word.len();
1942 }
1943 "},
1944 indoc! {"
1945 <|editable_region_start|>
1946 fn main() {
1947 let word_1 = \"lorem\";
1948 let range = word_1.len()..word_1.len();
1949 }
1950
1951 <|editable_region_end|>
1952 "},
1953 cx,
1954 )
1955 .await;
1956 assert_eq!(
1957 edits,
1958 [
1959 (Point::new(2, 20)..Point::new(2, 20), "_1".to_string()),
1960 (Point::new(2, 32)..Point::new(2, 32), "_1".to_string()),
1961 ]
1962 );
1963
1964 let edits = edits_for_prediction(
1965 indoc! {"
1966 fn main() {
1967 let story = \"the quick\"
1968 }
1969 "},
1970 indoc! {"
1971 <|editable_region_start|>
1972 fn main() {
1973 let story = \"the quick brown fox jumps over the lazy dog\";
1974 }
1975
1976 <|editable_region_end|>
1977 "},
1978 cx,
1979 )
1980 .await;
1981 assert_eq!(
1982 edits,
1983 [
1984 (
1985 Point::new(1, 26)..Point::new(1, 26),
1986 " brown fox jumps over the lazy dog".to_string()
1987 ),
1988 (Point::new(1, 27)..Point::new(1, 27), ";".to_string()),
1989 ]
1990 );
1991 }
1992
1993 #[gpui::test]
1994 async fn test_edit_prediction_end_of_buffer(cx: &mut TestAppContext) {
1995 cx.update(|cx| {
1996 let settings_store = SettingsStore::test(cx);
1997 cx.set_global(settings_store);
1998 client::init_settings(cx);
1999 });
2000
2001 let buffer_content = "lorem\n";
2002 let completion_response = indoc! {"
2003 ```animals.js
2004 <|start_of_file|>
2005 <|editable_region_start|>
2006 lorem
2007 ipsum
2008 <|editable_region_end|>
2009 ```"};
2010
2011 let http_client = FakeHttpClient::create(move |req| async move {
2012 match (req.method(), req.uri().path()) {
2013 (&Method::POST, "/client/llm_tokens") => Ok(http_client::Response::builder()
2014 .status(200)
2015 .body(
2016 serde_json::to_string(&CreateLlmTokenResponse {
2017 token: LlmToken("the-llm-token".to_string()),
2018 })
2019 .unwrap()
2020 .into(),
2021 )
2022 .unwrap()),
2023 (&Method::POST, "/predict_edits/v2") => Ok(http_client::Response::builder()
2024 .status(200)
2025 .body(
2026 serde_json::to_string(&PredictEditsResponse {
2027 request_id: Uuid::parse_str("7e86480f-3536-4d2c-9334-8213e3445d45")
2028 .unwrap(),
2029 output_excerpt: completion_response.to_string(),
2030 })
2031 .unwrap()
2032 .into(),
2033 )
2034 .unwrap()),
2035 _ => Ok(http_client::Response::builder()
2036 .status(404)
2037 .body("Not Found".into())
2038 .unwrap()),
2039 }
2040 });
2041
2042 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
2043 cx.update(|cx| {
2044 RefreshLlmTokenListener::register(client.clone(), cx);
2045 });
2046 // Construct the fake server to authenticate.
2047 let _server = FakeServer::for_client(42, &client, cx).await;
2048 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
2049 let zeta = cx.new(|cx| Zeta::new(None, client, user_store.clone(), cx));
2050
2051 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
2052 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
2053 let completion_task = zeta.update(cx, |zeta, cx| {
2054 zeta.request_completion(None, &buffer, cursor, false, cx)
2055 });
2056
2057 let completion = completion_task.await.unwrap().unwrap();
2058 buffer.update(cx, |buffer, cx| {
2059 buffer.edit(completion.edits.iter().cloned(), None, cx)
2060 });
2061 assert_eq!(
2062 buffer.read_with(cx, |buffer, _| buffer.text()),
2063 "lorem\nipsum"
2064 );
2065 }
2066
2067 async fn edits_for_prediction(
2068 buffer_content: &str,
2069 completion_response: &str,
2070 cx: &mut TestAppContext,
2071 ) -> Vec<(Range<Point>, String)> {
2072 let completion_response = completion_response.to_string();
2073 let http_client = FakeHttpClient::create(move |req| {
2074 let completion = completion_response.clone();
2075 async move {
2076 match (req.method(), req.uri().path()) {
2077 (&Method::POST, "/client/llm_tokens") => Ok(http_client::Response::builder()
2078 .status(200)
2079 .body(
2080 serde_json::to_string(&CreateLlmTokenResponse {
2081 token: LlmToken("the-llm-token".to_string()),
2082 })
2083 .unwrap()
2084 .into(),
2085 )
2086 .unwrap()),
2087 (&Method::POST, "/predict_edits/v2") => Ok(http_client::Response::builder()
2088 .status(200)
2089 .body(
2090 serde_json::to_string(&PredictEditsResponse {
2091 request_id: Uuid::new_v4(),
2092 output_excerpt: completion,
2093 })
2094 .unwrap()
2095 .into(),
2096 )
2097 .unwrap()),
2098 _ => Ok(http_client::Response::builder()
2099 .status(404)
2100 .body("Not Found".into())
2101 .unwrap()),
2102 }
2103 }
2104 });
2105
2106 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
2107 cx.update(|cx| {
2108 RefreshLlmTokenListener::register(client.clone(), cx);
2109 });
2110 // Construct the fake server to authenticate.
2111 let _server = FakeServer::for_client(42, &client, cx).await;
2112 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
2113 let zeta = cx.new(|cx| Zeta::new(None, client, user_store.clone(), cx));
2114
2115 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
2116 let snapshot = buffer.read_with(cx, |buffer, _| buffer.snapshot());
2117 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
2118 let completion_task = zeta.update(cx, |zeta, cx| {
2119 zeta.request_completion(None, &buffer, cursor, false, cx)
2120 });
2121
2122 let completion = completion_task.await.unwrap().unwrap();
2123 completion
2124 .edits
2125 .into_iter()
2126 .map(|(old_range, new_text)| (old_range.to_point(&snapshot), new_text.clone()))
2127 .collect::<Vec<_>>()
2128 }
2129
2130 fn to_completion_edits(
2131 iterator: impl IntoIterator<Item = (Range<usize>, String)>,
2132 buffer: &Entity<Buffer>,
2133 cx: &App,
2134 ) -> Vec<(Range<Anchor>, String)> {
2135 let buffer = buffer.read(cx);
2136 iterator
2137 .into_iter()
2138 .map(|(range, text)| {
2139 (
2140 buffer.anchor_after(range.start)..buffer.anchor_before(range.end),
2141 text,
2142 )
2143 })
2144 .collect()
2145 }
2146
2147 fn from_completion_edits(
2148 editor_edits: &[(Range<Anchor>, String)],
2149 buffer: &Entity<Buffer>,
2150 cx: &App,
2151 ) -> Vec<(Range<usize>, String)> {
2152 let buffer = buffer.read(cx);
2153 editor_edits
2154 .iter()
2155 .map(|(range, text)| {
2156 (
2157 range.start.to_offset(buffer)..range.end.to_offset(buffer),
2158 text.clone(),
2159 )
2160 })
2161 .collect()
2162 }
2163
2164 #[ctor::ctor]
2165 fn init_logger() {
2166 zlog::init_test();
2167 }
2168}