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