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, ZED_VERSION_HEADER_NAME,
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 = http_client::Request::builder()
744 .method(Method::POST)
745 .uri(
746 http_client
747 .build_zed_llm_url("/predict_edits/v2", &[])?
748 .as_ref(),
749 )
750 .header("Content-Type", "application/json")
751 .header("Authorization", format!("Bearer {}", token))
752 .header(ZED_VERSION_HEADER_NAME, app_version.to_string())
753 .body(serde_json::to_string(&body)?.into())?;
754
755 let mut response = http_client.send(request).await?;
756
757 if let Some(minimum_required_version) = response
758 .headers()
759 .get(MINIMUM_REQUIRED_VERSION_HEADER_NAME)
760 .and_then(|version| SemanticVersion::from_str(version.to_str().ok()?).ok())
761 {
762 if app_version < minimum_required_version {
763 return Err(anyhow!(ZedUpdateRequiredError {
764 minimum_version: minimum_required_version
765 }));
766 }
767 }
768
769 if response.status().is_success() {
770 let usage = EditPredictionUsage::from_headers(response.headers()).ok();
771
772 let mut body = String::new();
773 response.body_mut().read_to_string(&mut body).await?;
774 return Ok((serde_json::from_str(&body)?, usage));
775 } else if !did_retry
776 && response
777 .headers()
778 .get(EXPIRED_LLM_TOKEN_HEADER_NAME)
779 .is_some()
780 {
781 did_retry = true;
782 token = llm_token.refresh(&client).await?;
783 } else {
784 let mut body = String::new();
785 response.body_mut().read_to_string(&mut body).await?;
786 return Err(anyhow!(
787 "error predicting edits.\nStatus: {:?}\nBody: {}",
788 response.status(),
789 body
790 ));
791 }
792 }
793 }
794 }
795
796 fn process_completion_response(
797 prediction_response: PredictEditsResponse,
798 buffer: Entity<Buffer>,
799 snapshot: &BufferSnapshot,
800 editable_range: Range<usize>,
801 cursor_offset: usize,
802 path: Arc<Path>,
803 input_outline: String,
804 input_events: String,
805 input_excerpt: String,
806 request_sent_at: Instant,
807 cx: &AsyncApp,
808 ) -> Task<Result<Option<InlineCompletion>>> {
809 let snapshot = snapshot.clone();
810 let request_id = prediction_response.request_id;
811 let output_excerpt = prediction_response.output_excerpt;
812 cx.spawn(async move |cx| {
813 let output_excerpt: Arc<str> = output_excerpt.into();
814
815 let edits: Arc<[(Range<Anchor>, String)]> = cx
816 .background_spawn({
817 let output_excerpt = output_excerpt.clone();
818 let editable_range = editable_range.clone();
819 let snapshot = snapshot.clone();
820 async move { Self::parse_edits(output_excerpt, editable_range, &snapshot) }
821 })
822 .await?
823 .into();
824
825 let Some((edits, snapshot, edit_preview)) = buffer.read_with(cx, {
826 let edits = edits.clone();
827 |buffer, cx| {
828 let new_snapshot = buffer.snapshot();
829 let edits: Arc<[(Range<Anchor>, String)]> =
830 interpolate(&snapshot, &new_snapshot, edits)?.into();
831 Some((edits.clone(), new_snapshot, buffer.preview_edits(edits, cx)))
832 }
833 })?
834 else {
835 return anyhow::Ok(None);
836 };
837
838 let edit_preview = edit_preview.await;
839
840 Ok(Some(InlineCompletion {
841 id: InlineCompletionId(request_id),
842 path,
843 excerpt_range: editable_range,
844 cursor_offset,
845 edits,
846 edit_preview,
847 snapshot,
848 input_outline: input_outline.into(),
849 input_events: input_events.into(),
850 input_excerpt: input_excerpt.into(),
851 output_excerpt,
852 request_sent_at,
853 response_received_at: Instant::now(),
854 }))
855 })
856 }
857
858 fn parse_edits(
859 output_excerpt: Arc<str>,
860 editable_range: Range<usize>,
861 snapshot: &BufferSnapshot,
862 ) -> Result<Vec<(Range<Anchor>, String)>> {
863 let content = output_excerpt.replace(CURSOR_MARKER, "");
864
865 let start_markers = content
866 .match_indices(EDITABLE_REGION_START_MARKER)
867 .collect::<Vec<_>>();
868 anyhow::ensure!(
869 start_markers.len() == 1,
870 "expected exactly one start marker, found {}",
871 start_markers.len()
872 );
873
874 let end_markers = content
875 .match_indices(EDITABLE_REGION_END_MARKER)
876 .collect::<Vec<_>>();
877 anyhow::ensure!(
878 end_markers.len() == 1,
879 "expected exactly one end marker, found {}",
880 end_markers.len()
881 );
882
883 let sof_markers = content
884 .match_indices(START_OF_FILE_MARKER)
885 .collect::<Vec<_>>();
886 anyhow::ensure!(
887 sof_markers.len() <= 1,
888 "expected at most one start-of-file marker, found {}",
889 sof_markers.len()
890 );
891
892 let codefence_start = start_markers[0].0;
893 let content = &content[codefence_start..];
894
895 let newline_ix = content.find('\n').context("could not find newline")?;
896 let content = &content[newline_ix + 1..];
897
898 let codefence_end = content
899 .rfind(&format!("\n{EDITABLE_REGION_END_MARKER}"))
900 .context("could not find end marker")?;
901 let new_text = &content[..codefence_end];
902
903 let old_text = snapshot
904 .text_for_range(editable_range.clone())
905 .collect::<String>();
906
907 Ok(Self::compute_edits(
908 old_text,
909 new_text,
910 editable_range.start,
911 &snapshot,
912 ))
913 }
914
915 pub fn compute_edits(
916 old_text: String,
917 new_text: &str,
918 offset: usize,
919 snapshot: &BufferSnapshot,
920 ) -> Vec<(Range<Anchor>, String)> {
921 text_diff(&old_text, &new_text)
922 .into_iter()
923 .map(|(mut old_range, new_text)| {
924 old_range.start += offset;
925 old_range.end += offset;
926
927 let prefix_len = common_prefix(
928 snapshot.chars_for_range(old_range.clone()),
929 new_text.chars(),
930 );
931 old_range.start += prefix_len;
932
933 let suffix_len = common_prefix(
934 snapshot.reversed_chars_for_range(old_range.clone()),
935 new_text[prefix_len..].chars().rev(),
936 );
937 old_range.end = old_range.end.saturating_sub(suffix_len);
938
939 let new_text = new_text[prefix_len..new_text.len() - suffix_len].to_string();
940 let range = if old_range.is_empty() {
941 let anchor = snapshot.anchor_after(old_range.start);
942 anchor..anchor
943 } else {
944 snapshot.anchor_after(old_range.start)..snapshot.anchor_before(old_range.end)
945 };
946 (range, new_text)
947 })
948 .collect()
949 }
950
951 pub fn is_completion_rated(&self, completion_id: InlineCompletionId) -> bool {
952 self.rated_completions.contains(&completion_id)
953 }
954
955 pub fn completion_shown(&mut self, completion: &InlineCompletion, cx: &mut Context<Self>) {
956 self.shown_completions.push_front(completion.clone());
957 if self.shown_completions.len() > 50 {
958 let completion = self.shown_completions.pop_back().unwrap();
959 self.rated_completions.remove(&completion.id);
960 }
961 cx.notify();
962 }
963
964 pub fn rate_completion(
965 &mut self,
966 completion: &InlineCompletion,
967 rating: InlineCompletionRating,
968 feedback: String,
969 cx: &mut Context<Self>,
970 ) {
971 self.rated_completions.insert(completion.id);
972 telemetry::event!(
973 "Edit Prediction Rated",
974 rating,
975 input_events = completion.input_events,
976 input_excerpt = completion.input_excerpt,
977 input_outline = completion.input_outline,
978 output_excerpt = completion.output_excerpt,
979 feedback
980 );
981 self.client.telemetry().flush_events().detach();
982 cx.notify();
983 }
984
985 pub fn shown_completions(&self) -> impl DoubleEndedIterator<Item = &InlineCompletion> {
986 self.shown_completions.iter()
987 }
988
989 pub fn shown_completions_len(&self) -> usize {
990 self.shown_completions.len()
991 }
992
993 fn report_changes_for_buffer(
994 &mut self,
995 buffer: &Entity<Buffer>,
996 cx: &mut Context<Self>,
997 ) -> BufferSnapshot {
998 self.register_buffer(buffer, cx);
999
1000 let registered_buffer = self
1001 .registered_buffers
1002 .get_mut(&buffer.entity_id())
1003 .unwrap();
1004 let new_snapshot = buffer.read(cx).snapshot();
1005
1006 if new_snapshot.version != registered_buffer.snapshot.version {
1007 let old_snapshot = mem::replace(&mut registered_buffer.snapshot, new_snapshot.clone());
1008 self.push_event(Event::BufferChange {
1009 old_snapshot,
1010 new_snapshot: new_snapshot.clone(),
1011 timestamp: Instant::now(),
1012 });
1013 }
1014
1015 new_snapshot
1016 }
1017
1018 fn load_data_collection_choices() -> DataCollectionChoice {
1019 let choice = KEY_VALUE_STORE
1020 .read_kvp(ZED_PREDICT_DATA_COLLECTION_CHOICE)
1021 .log_err()
1022 .flatten();
1023
1024 match choice.as_deref() {
1025 Some("true") => DataCollectionChoice::Enabled,
1026 Some("false") => DataCollectionChoice::Disabled,
1027 Some(_) => {
1028 log::error!("unknown value in '{ZED_PREDICT_DATA_COLLECTION_CHOICE}'");
1029 DataCollectionChoice::NotAnswered
1030 }
1031 None => DataCollectionChoice::NotAnswered,
1032 }
1033 }
1034}
1035
1036struct PerformPredictEditsParams {
1037 pub client: Arc<Client>,
1038 pub llm_token: LlmApiToken,
1039 pub app_version: SemanticVersion,
1040 pub body: PredictEditsBody,
1041}
1042
1043#[derive(Error, Debug)]
1044#[error(
1045 "You must update to Zed version {minimum_version} or higher to continue using edit predictions."
1046)]
1047pub struct ZedUpdateRequiredError {
1048 minimum_version: SemanticVersion,
1049}
1050
1051struct LicenseDetectionWatcher {
1052 is_open_source_rx: watch::Receiver<bool>,
1053 _is_open_source_task: Task<()>,
1054}
1055
1056impl LicenseDetectionWatcher {
1057 pub fn new(worktree: &Worktree, cx: &mut Context<Worktree>) -> Self {
1058 let (mut is_open_source_tx, is_open_source_rx) = watch::channel_with::<bool>(false);
1059
1060 // Check if worktree is a single file, if so we do not need to check for a LICENSE file
1061 let task = if worktree.abs_path().is_file() {
1062 Task::ready(())
1063 } else {
1064 let loaded_files = LICENSE_FILES_TO_CHECK
1065 .iter()
1066 .map(Path::new)
1067 .map(|file| worktree.load_file(file, cx))
1068 .collect::<ArrayVec<_, { LICENSE_FILES_TO_CHECK.len() }>>();
1069
1070 cx.background_spawn(async move {
1071 for loaded_file in loaded_files.into_iter() {
1072 let Ok(loaded_file) = loaded_file.await else {
1073 continue;
1074 };
1075
1076 let path = &loaded_file.file.path;
1077 if is_license_eligible_for_data_collection(&loaded_file.text) {
1078 log::info!("detected '{path:?}' as open source license");
1079 *is_open_source_tx.borrow_mut() = true;
1080 } else {
1081 log::info!("didn't detect '{path:?}' as open source license");
1082 }
1083
1084 // stop on the first license that successfully read
1085 return;
1086 }
1087
1088 log::debug!("didn't find a license file to check, assuming closed source");
1089 })
1090 };
1091
1092 Self {
1093 is_open_source_rx,
1094 _is_open_source_task: task,
1095 }
1096 }
1097
1098 /// Answers false until we find out it's open source
1099 pub fn is_project_open_source(&self) -> bool {
1100 *self.is_open_source_rx.borrow()
1101 }
1102}
1103
1104fn common_prefix<T1: Iterator<Item = char>, T2: Iterator<Item = char>>(a: T1, b: T2) -> usize {
1105 a.zip(b)
1106 .take_while(|(a, b)| a == b)
1107 .map(|(a, _)| a.len_utf8())
1108 .sum()
1109}
1110
1111fn prompt_for_outline(snapshot: &BufferSnapshot) -> String {
1112 let mut input_outline = String::new();
1113
1114 writeln!(
1115 input_outline,
1116 "```{}",
1117 snapshot
1118 .file()
1119 .map_or(Cow::Borrowed("untitled"), |file| file
1120 .path()
1121 .to_string_lossy())
1122 )
1123 .unwrap();
1124
1125 if let Some(outline) = snapshot.outline(None) {
1126 for item in &outline.items {
1127 let spacing = " ".repeat(item.depth);
1128 writeln!(input_outline, "{}{}", spacing, item.text).unwrap();
1129 }
1130 }
1131
1132 writeln!(input_outline, "```").unwrap();
1133
1134 input_outline
1135}
1136
1137fn prompt_for_events(events: &VecDeque<Event>, mut remaining_tokens: usize) -> String {
1138 let mut result = String::new();
1139 for event in events.iter().rev() {
1140 let event_string = event.to_prompt();
1141 let event_tokens = tokens_for_bytes(event_string.len());
1142 if event_tokens > remaining_tokens {
1143 break;
1144 }
1145
1146 if !result.is_empty() {
1147 result.insert_str(0, "\n\n");
1148 }
1149 result.insert_str(0, &event_string);
1150 remaining_tokens -= event_tokens;
1151 }
1152 result
1153}
1154
1155struct RegisteredBuffer {
1156 snapshot: BufferSnapshot,
1157 _subscriptions: [gpui::Subscription; 2],
1158}
1159
1160#[derive(Clone)]
1161enum Event {
1162 BufferChange {
1163 old_snapshot: BufferSnapshot,
1164 new_snapshot: BufferSnapshot,
1165 timestamp: Instant,
1166 },
1167}
1168
1169impl Event {
1170 fn to_prompt(&self) -> String {
1171 match self {
1172 Event::BufferChange {
1173 old_snapshot,
1174 new_snapshot,
1175 ..
1176 } => {
1177 let mut prompt = String::new();
1178
1179 let old_path = old_snapshot
1180 .file()
1181 .map(|f| f.path().as_ref())
1182 .unwrap_or(Path::new("untitled"));
1183 let new_path = new_snapshot
1184 .file()
1185 .map(|f| f.path().as_ref())
1186 .unwrap_or(Path::new("untitled"));
1187 if old_path != new_path {
1188 writeln!(prompt, "User renamed {:?} to {:?}\n", old_path, new_path).unwrap();
1189 }
1190
1191 let diff = language::unified_diff(&old_snapshot.text(), &new_snapshot.text());
1192 if !diff.is_empty() {
1193 write!(
1194 prompt,
1195 "User edited {:?}:\n```diff\n{}\n```",
1196 new_path, diff
1197 )
1198 .unwrap();
1199 }
1200
1201 prompt
1202 }
1203 }
1204 }
1205}
1206
1207#[derive(Debug, Clone)]
1208struct CurrentInlineCompletion {
1209 buffer_id: EntityId,
1210 completion: InlineCompletion,
1211}
1212
1213impl CurrentInlineCompletion {
1214 fn should_replace_completion(&self, old_completion: &Self, snapshot: &BufferSnapshot) -> bool {
1215 if self.buffer_id != old_completion.buffer_id {
1216 return true;
1217 }
1218
1219 let Some(old_edits) = old_completion.completion.interpolate(&snapshot) else {
1220 return true;
1221 };
1222 let Some(new_edits) = self.completion.interpolate(&snapshot) else {
1223 return false;
1224 };
1225
1226 if old_edits.len() == 1 && new_edits.len() == 1 {
1227 let (old_range, old_text) = &old_edits[0];
1228 let (new_range, new_text) = &new_edits[0];
1229 new_range == old_range && new_text.starts_with(old_text)
1230 } else {
1231 true
1232 }
1233 }
1234}
1235
1236struct PendingCompletion {
1237 id: usize,
1238 _task: Task<()>,
1239}
1240
1241#[derive(Debug, Clone, Copy)]
1242pub enum DataCollectionChoice {
1243 NotAnswered,
1244 Enabled,
1245 Disabled,
1246}
1247
1248impl DataCollectionChoice {
1249 pub fn is_enabled(self) -> bool {
1250 match self {
1251 Self::Enabled => true,
1252 Self::NotAnswered | Self::Disabled => false,
1253 }
1254 }
1255
1256 pub fn is_answered(self) -> bool {
1257 match self {
1258 Self::Enabled | Self::Disabled => true,
1259 Self::NotAnswered => false,
1260 }
1261 }
1262
1263 pub fn toggle(&self) -> DataCollectionChoice {
1264 match self {
1265 Self::Enabled => Self::Disabled,
1266 Self::Disabled => Self::Enabled,
1267 Self::NotAnswered => Self::Enabled,
1268 }
1269 }
1270}
1271
1272impl From<bool> for DataCollectionChoice {
1273 fn from(value: bool) -> Self {
1274 match value {
1275 true => DataCollectionChoice::Enabled,
1276 false => DataCollectionChoice::Disabled,
1277 }
1278 }
1279}
1280
1281pub struct ProviderDataCollection {
1282 /// When set to None, data collection is not possible in the provider buffer
1283 choice: Option<Entity<DataCollectionChoice>>,
1284 license_detection_watcher: Option<Rc<LicenseDetectionWatcher>>,
1285}
1286
1287impl ProviderDataCollection {
1288 pub fn new(zeta: Entity<Zeta>, buffer: Option<Entity<Buffer>>, cx: &mut App) -> Self {
1289 let choice_and_watcher = buffer.and_then(|buffer| {
1290 let file = buffer.read(cx).file()?;
1291
1292 if !file.is_local() || file.is_private() {
1293 return None;
1294 }
1295
1296 let zeta = zeta.read(cx);
1297 let choice = zeta.data_collection_choice.clone();
1298
1299 let license_detection_watcher = zeta
1300 .license_detection_watchers
1301 .get(&file.worktree_id(cx))
1302 .cloned()?;
1303
1304 Some((choice, license_detection_watcher))
1305 });
1306
1307 if let Some((choice, watcher)) = choice_and_watcher {
1308 ProviderDataCollection {
1309 choice: Some(choice),
1310 license_detection_watcher: Some(watcher),
1311 }
1312 } else {
1313 ProviderDataCollection {
1314 choice: None,
1315 license_detection_watcher: None,
1316 }
1317 }
1318 }
1319
1320 pub fn can_collect_data(&self, cx: &App) -> bool {
1321 self.is_data_collection_enabled(cx) && self.is_project_open_source()
1322 }
1323
1324 pub fn is_data_collection_enabled(&self, cx: &App) -> bool {
1325 self.choice
1326 .as_ref()
1327 .is_some_and(|choice| choice.read(cx).is_enabled())
1328 }
1329
1330 fn is_project_open_source(&self) -> bool {
1331 self.license_detection_watcher
1332 .as_ref()
1333 .is_some_and(|watcher| watcher.is_project_open_source())
1334 }
1335
1336 pub fn toggle(&mut self, cx: &mut App) {
1337 if let Some(choice) = self.choice.as_mut() {
1338 let new_choice = choice.update(cx, |choice, _cx| {
1339 let new_choice = choice.toggle();
1340 *choice = new_choice;
1341 new_choice
1342 });
1343
1344 db::write_and_log(cx, move || {
1345 KEY_VALUE_STORE.write_kvp(
1346 ZED_PREDICT_DATA_COLLECTION_CHOICE.into(),
1347 new_choice.is_enabled().to_string(),
1348 )
1349 });
1350 }
1351 }
1352}
1353
1354pub struct ZetaInlineCompletionProvider {
1355 zeta: Entity<Zeta>,
1356 pending_completions: ArrayVec<PendingCompletion, 2>,
1357 next_pending_completion_id: usize,
1358 current_completion: Option<CurrentInlineCompletion>,
1359 /// None if this is entirely disabled for this provider
1360 provider_data_collection: ProviderDataCollection,
1361 last_request_timestamp: Instant,
1362}
1363
1364impl ZetaInlineCompletionProvider {
1365 pub const THROTTLE_TIMEOUT: Duration = Duration::from_millis(300);
1366
1367 pub fn new(zeta: Entity<Zeta>, provider_data_collection: ProviderDataCollection) -> Self {
1368 Self {
1369 zeta,
1370 pending_completions: ArrayVec::new(),
1371 next_pending_completion_id: 0,
1372 current_completion: None,
1373 provider_data_collection,
1374 last_request_timestamp: Instant::now(),
1375 }
1376 }
1377}
1378
1379impl inline_completion::EditPredictionProvider for ZetaInlineCompletionProvider {
1380 fn name() -> &'static str {
1381 "zed-predict"
1382 }
1383
1384 fn display_name() -> &'static str {
1385 "Zed's Edit Predictions"
1386 }
1387
1388 fn show_completions_in_menu() -> bool {
1389 true
1390 }
1391
1392 fn show_tab_accept_marker() -> bool {
1393 true
1394 }
1395
1396 fn data_collection_state(&self, cx: &App) -> DataCollectionState {
1397 let is_project_open_source = self.provider_data_collection.is_project_open_source();
1398
1399 if self.provider_data_collection.is_data_collection_enabled(cx) {
1400 DataCollectionState::Enabled {
1401 is_project_open_source,
1402 }
1403 } else {
1404 DataCollectionState::Disabled {
1405 is_project_open_source,
1406 }
1407 }
1408 }
1409
1410 fn toggle_data_collection(&mut self, cx: &mut App) {
1411 self.provider_data_collection.toggle(cx);
1412 }
1413
1414 fn usage(&self, cx: &App) -> Option<EditPredictionUsage> {
1415 self.zeta.read(cx).last_usage
1416 }
1417
1418 fn is_enabled(
1419 &self,
1420 _buffer: &Entity<Buffer>,
1421 _cursor_position: language::Anchor,
1422 _cx: &App,
1423 ) -> bool {
1424 true
1425 }
1426
1427 fn needs_terms_acceptance(&self, cx: &App) -> bool {
1428 !self.zeta.read(cx).tos_accepted
1429 }
1430
1431 fn is_refreshing(&self) -> bool {
1432 !self.pending_completions.is_empty()
1433 }
1434
1435 fn refresh(
1436 &mut self,
1437 project: Option<Entity<Project>>,
1438 buffer: Entity<Buffer>,
1439 position: language::Anchor,
1440 _debounce: bool,
1441 cx: &mut Context<Self>,
1442 ) {
1443 if !self.zeta.read(cx).tos_accepted {
1444 return;
1445 }
1446
1447 if self.zeta.read(cx).update_required {
1448 return;
1449 }
1450
1451 if let Some(current_completion) = self.current_completion.as_ref() {
1452 let snapshot = buffer.read(cx).snapshot();
1453 if current_completion
1454 .completion
1455 .interpolate(&snapshot)
1456 .is_some()
1457 {
1458 return;
1459 }
1460 }
1461
1462 let pending_completion_id = self.next_pending_completion_id;
1463 self.next_pending_completion_id += 1;
1464 let can_collect_data = self.provider_data_collection.can_collect_data(cx);
1465 let last_request_timestamp = self.last_request_timestamp;
1466
1467 let task = cx.spawn(async move |this, cx| {
1468 if let Some(timeout) = (last_request_timestamp + Self::THROTTLE_TIMEOUT)
1469 .checked_duration_since(Instant::now())
1470 {
1471 cx.background_executor().timer(timeout).await;
1472 }
1473
1474 let completion_request = this.update(cx, |this, cx| {
1475 this.last_request_timestamp = Instant::now();
1476 this.zeta.update(cx, |zeta, cx| {
1477 zeta.request_completion(
1478 project.as_ref(),
1479 &buffer,
1480 position,
1481 can_collect_data,
1482 cx,
1483 )
1484 })
1485 });
1486
1487 let completion = match completion_request {
1488 Ok(completion_request) => {
1489 let completion_request = completion_request.await;
1490 completion_request.map(|c| {
1491 c.map(|completion| CurrentInlineCompletion {
1492 buffer_id: buffer.entity_id(),
1493 completion,
1494 })
1495 })
1496 }
1497 Err(error) => Err(error),
1498 };
1499 let Some(new_completion) = completion
1500 .context("edit prediction failed")
1501 .log_err()
1502 .flatten()
1503 else {
1504 this.update(cx, |this, cx| {
1505 if this.pending_completions[0].id == pending_completion_id {
1506 this.pending_completions.remove(0);
1507 } else {
1508 this.pending_completions.clear();
1509 }
1510
1511 cx.notify();
1512 })
1513 .ok();
1514 return;
1515 };
1516
1517 this.update(cx, |this, cx| {
1518 if this.pending_completions[0].id == pending_completion_id {
1519 this.pending_completions.remove(0);
1520 } else {
1521 this.pending_completions.clear();
1522 }
1523
1524 if let Some(old_completion) = this.current_completion.as_ref() {
1525 let snapshot = buffer.read(cx).snapshot();
1526 if new_completion.should_replace_completion(&old_completion, &snapshot) {
1527 this.zeta.update(cx, |zeta, cx| {
1528 zeta.completion_shown(&new_completion.completion, cx);
1529 });
1530 this.current_completion = Some(new_completion);
1531 }
1532 } else {
1533 this.zeta.update(cx, |zeta, cx| {
1534 zeta.completion_shown(&new_completion.completion, cx);
1535 });
1536 this.current_completion = Some(new_completion);
1537 }
1538
1539 cx.notify();
1540 })
1541 .ok();
1542 });
1543
1544 // We always maintain at most two pending completions. When we already
1545 // have two, we replace the newest one.
1546 if self.pending_completions.len() <= 1 {
1547 self.pending_completions.push(PendingCompletion {
1548 id: pending_completion_id,
1549 _task: task,
1550 });
1551 } else if self.pending_completions.len() == 2 {
1552 self.pending_completions.pop();
1553 self.pending_completions.push(PendingCompletion {
1554 id: pending_completion_id,
1555 _task: task,
1556 });
1557 }
1558 }
1559
1560 fn cycle(
1561 &mut self,
1562 _buffer: Entity<Buffer>,
1563 _cursor_position: language::Anchor,
1564 _direction: inline_completion::Direction,
1565 _cx: &mut Context<Self>,
1566 ) {
1567 // Right now we don't support cycling.
1568 }
1569
1570 fn accept(&mut self, _cx: &mut Context<Self>) {
1571 self.pending_completions.clear();
1572 }
1573
1574 fn discard(&mut self, _cx: &mut Context<Self>) {
1575 self.pending_completions.clear();
1576 self.current_completion.take();
1577 }
1578
1579 fn suggest(
1580 &mut self,
1581 buffer: &Entity<Buffer>,
1582 cursor_position: language::Anchor,
1583 cx: &mut Context<Self>,
1584 ) -> Option<inline_completion::InlineCompletion> {
1585 let CurrentInlineCompletion {
1586 buffer_id,
1587 completion,
1588 ..
1589 } = self.current_completion.as_mut()?;
1590
1591 // Invalidate previous completion if it was generated for a different buffer.
1592 if *buffer_id != buffer.entity_id() {
1593 self.current_completion.take();
1594 return None;
1595 }
1596
1597 let buffer = buffer.read(cx);
1598 let Some(edits) = completion.interpolate(&buffer.snapshot()) else {
1599 self.current_completion.take();
1600 return None;
1601 };
1602
1603 let cursor_row = cursor_position.to_point(buffer).row;
1604 let (closest_edit_ix, (closest_edit_range, _)) =
1605 edits.iter().enumerate().min_by_key(|(_, (range, _))| {
1606 let distance_from_start = cursor_row.abs_diff(range.start.to_point(buffer).row);
1607 let distance_from_end = cursor_row.abs_diff(range.end.to_point(buffer).row);
1608 cmp::min(distance_from_start, distance_from_end)
1609 })?;
1610
1611 let mut edit_start_ix = closest_edit_ix;
1612 for (range, _) in edits[..edit_start_ix].iter().rev() {
1613 let distance_from_closest_edit =
1614 closest_edit_range.start.to_point(buffer).row - range.end.to_point(buffer).row;
1615 if distance_from_closest_edit <= 1 {
1616 edit_start_ix -= 1;
1617 } else {
1618 break;
1619 }
1620 }
1621
1622 let mut edit_end_ix = closest_edit_ix + 1;
1623 for (range, _) in &edits[edit_end_ix..] {
1624 let distance_from_closest_edit =
1625 range.start.to_point(buffer).row - closest_edit_range.end.to_point(buffer).row;
1626 if distance_from_closest_edit <= 1 {
1627 edit_end_ix += 1;
1628 } else {
1629 break;
1630 }
1631 }
1632
1633 Some(inline_completion::InlineCompletion {
1634 id: Some(completion.id.to_string().into()),
1635 edits: edits[edit_start_ix..edit_end_ix].to_vec(),
1636 edit_preview: Some(completion.edit_preview.clone()),
1637 })
1638 }
1639}
1640
1641fn tokens_for_bytes(bytes: usize) -> usize {
1642 /// Typical number of string bytes per token for the purposes of limiting model input. This is
1643 /// intentionally low to err on the side of underestimating limits.
1644 const BYTES_PER_TOKEN_GUESS: usize = 3;
1645 bytes / BYTES_PER_TOKEN_GUESS
1646}
1647
1648#[cfg(test)]
1649mod tests {
1650 use client::test::FakeServer;
1651 use clock::FakeSystemClock;
1652 use gpui::TestAppContext;
1653 use http_client::FakeHttpClient;
1654 use indoc::indoc;
1655 use language::Point;
1656 use rpc::proto;
1657 use settings::SettingsStore;
1658
1659 use super::*;
1660
1661 #[gpui::test]
1662 async fn test_inline_completion_basic_interpolation(cx: &mut TestAppContext) {
1663 let buffer = cx.new(|cx| Buffer::local("Lorem ipsum dolor", cx));
1664 let edits: Arc<[(Range<Anchor>, String)]> = cx.update(|cx| {
1665 to_completion_edits(
1666 [(2..5, "REM".to_string()), (9..11, "".to_string())],
1667 &buffer,
1668 cx,
1669 )
1670 .into()
1671 });
1672
1673 let edit_preview = cx
1674 .read(|cx| buffer.read(cx).preview_edits(edits.clone(), cx))
1675 .await;
1676
1677 let completion = InlineCompletion {
1678 edits,
1679 edit_preview,
1680 path: Path::new("").into(),
1681 snapshot: cx.read(|cx| buffer.read(cx).snapshot()),
1682 id: InlineCompletionId(Uuid::new_v4()),
1683 excerpt_range: 0..0,
1684 cursor_offset: 0,
1685 input_outline: "".into(),
1686 input_events: "".into(),
1687 input_excerpt: "".into(),
1688 output_excerpt: "".into(),
1689 request_sent_at: Instant::now(),
1690 response_received_at: Instant::now(),
1691 };
1692
1693 cx.update(|cx| {
1694 assert_eq!(
1695 from_completion_edits(
1696 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1697 &buffer,
1698 cx
1699 ),
1700 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1701 );
1702
1703 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "")], None, cx));
1704 assert_eq!(
1705 from_completion_edits(
1706 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1707 &buffer,
1708 cx
1709 ),
1710 vec![(2..2, "REM".to_string()), (6..8, "".to_string())]
1711 );
1712
1713 buffer.update(cx, |buffer, cx| buffer.undo(cx));
1714 assert_eq!(
1715 from_completion_edits(
1716 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1717 &buffer,
1718 cx
1719 ),
1720 vec![(2..5, "REM".to_string()), (9..11, "".to_string())]
1721 );
1722
1723 buffer.update(cx, |buffer, cx| buffer.edit([(2..5, "R")], None, cx));
1724 assert_eq!(
1725 from_completion_edits(
1726 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1727 &buffer,
1728 cx
1729 ),
1730 vec![(3..3, "EM".to_string()), (7..9, "".to_string())]
1731 );
1732
1733 buffer.update(cx, |buffer, cx| buffer.edit([(3..3, "E")], None, cx));
1734 assert_eq!(
1735 from_completion_edits(
1736 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1737 &buffer,
1738 cx
1739 ),
1740 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1741 );
1742
1743 buffer.update(cx, |buffer, cx| buffer.edit([(4..4, "M")], None, cx));
1744 assert_eq!(
1745 from_completion_edits(
1746 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1747 &buffer,
1748 cx
1749 ),
1750 vec![(9..11, "".to_string())]
1751 );
1752
1753 buffer.update(cx, |buffer, cx| buffer.edit([(4..5, "")], None, cx));
1754 assert_eq!(
1755 from_completion_edits(
1756 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1757 &buffer,
1758 cx
1759 ),
1760 vec![(4..4, "M".to_string()), (8..10, "".to_string())]
1761 );
1762
1763 buffer.update(cx, |buffer, cx| buffer.edit([(8..10, "")], None, cx));
1764 assert_eq!(
1765 from_completion_edits(
1766 &completion.interpolate(&buffer.read(cx).snapshot()).unwrap(),
1767 &buffer,
1768 cx
1769 ),
1770 vec![(4..4, "M".to_string())]
1771 );
1772
1773 buffer.update(cx, |buffer, cx| buffer.edit([(4..6, "")], None, cx));
1774 assert_eq!(completion.interpolate(&buffer.read(cx).snapshot()), None);
1775 })
1776 }
1777
1778 #[gpui::test]
1779 async fn test_clean_up_diff(cx: &mut TestAppContext) {
1780 cx.update(|cx| {
1781 let settings_store = SettingsStore::test(cx);
1782 cx.set_global(settings_store);
1783 client::init_settings(cx);
1784 });
1785
1786 let edits = edits_for_prediction(
1787 indoc! {"
1788 fn main() {
1789 let word_1 = \"lorem\";
1790 let range = word.len()..word.len();
1791 }
1792 "},
1793 indoc! {"
1794 <|editable_region_start|>
1795 fn main() {
1796 let word_1 = \"lorem\";
1797 let range = word_1.len()..word_1.len();
1798 }
1799
1800 <|editable_region_end|>
1801 "},
1802 cx,
1803 )
1804 .await;
1805 assert_eq!(
1806 edits,
1807 [
1808 (Point::new(2, 20)..Point::new(2, 20), "_1".to_string()),
1809 (Point::new(2, 32)..Point::new(2, 32), "_1".to_string()),
1810 ]
1811 );
1812
1813 let edits = edits_for_prediction(
1814 indoc! {"
1815 fn main() {
1816 let story = \"the quick\"
1817 }
1818 "},
1819 indoc! {"
1820 <|editable_region_start|>
1821 fn main() {
1822 let story = \"the quick brown fox jumps over the lazy dog\";
1823 }
1824
1825 <|editable_region_end|>
1826 "},
1827 cx,
1828 )
1829 .await;
1830 assert_eq!(
1831 edits,
1832 [
1833 (
1834 Point::new(1, 26)..Point::new(1, 26),
1835 " brown fox jumps over the lazy dog".to_string()
1836 ),
1837 (Point::new(1, 27)..Point::new(1, 27), ";".to_string()),
1838 ]
1839 );
1840 }
1841
1842 #[gpui::test]
1843 async fn test_inline_completion_end_of_buffer(cx: &mut TestAppContext) {
1844 cx.update(|cx| {
1845 let settings_store = SettingsStore::test(cx);
1846 cx.set_global(settings_store);
1847 client::init_settings(cx);
1848 });
1849
1850 let buffer_content = "lorem\n";
1851 let completion_response = indoc! {"
1852 ```animals.js
1853 <|start_of_file|>
1854 <|editable_region_start|>
1855 lorem
1856 ipsum
1857 <|editable_region_end|>
1858 ```"};
1859
1860 let http_client = FakeHttpClient::create(move |_| async move {
1861 Ok(http_client::Response::builder()
1862 .status(200)
1863 .body(
1864 serde_json::to_string(&PredictEditsResponse {
1865 request_id: Uuid::parse_str("7e86480f-3536-4d2c-9334-8213e3445d45")
1866 .unwrap(),
1867 output_excerpt: completion_response.to_string(),
1868 })
1869 .unwrap()
1870 .into(),
1871 )
1872 .unwrap())
1873 });
1874
1875 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
1876 cx.update(|cx| {
1877 RefreshLlmTokenListener::register(client.clone(), cx);
1878 });
1879 let server = FakeServer::for_client(42, &client, cx).await;
1880 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
1881 let zeta = cx.new(|cx| Zeta::new(None, client, user_store, cx));
1882
1883 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
1884 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
1885 let completion_task = zeta.update(cx, |zeta, cx| {
1886 zeta.request_completion(None, &buffer, cursor, false, cx)
1887 });
1888
1889 let token_request = server.receive::<proto::GetLlmToken>().await.unwrap();
1890 server.respond(
1891 token_request.receipt(),
1892 proto::GetLlmTokenResponse { token: "".into() },
1893 );
1894
1895 let completion = completion_task.await.unwrap().unwrap();
1896 buffer.update(cx, |buffer, cx| {
1897 buffer.edit(completion.edits.iter().cloned(), None, cx)
1898 });
1899 assert_eq!(
1900 buffer.read_with(cx, |buffer, _| buffer.text()),
1901 "lorem\nipsum"
1902 );
1903 }
1904
1905 async fn edits_for_prediction(
1906 buffer_content: &str,
1907 completion_response: &str,
1908 cx: &mut TestAppContext,
1909 ) -> Vec<(Range<Point>, String)> {
1910 let completion_response = completion_response.to_string();
1911 let http_client = FakeHttpClient::create(move |_| {
1912 let completion = completion_response.clone();
1913 async move {
1914 Ok(http_client::Response::builder()
1915 .status(200)
1916 .body(
1917 serde_json::to_string(&PredictEditsResponse {
1918 request_id: Uuid::new_v4(),
1919 output_excerpt: completion,
1920 })
1921 .unwrap()
1922 .into(),
1923 )
1924 .unwrap())
1925 }
1926 });
1927
1928 let client = cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client, cx));
1929 cx.update(|cx| {
1930 RefreshLlmTokenListener::register(client.clone(), cx);
1931 });
1932 let server = FakeServer::for_client(42, &client, cx).await;
1933 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
1934 let zeta = cx.new(|cx| Zeta::new(None, client, user_store, cx));
1935
1936 let buffer = cx.new(|cx| Buffer::local(buffer_content, cx));
1937 let snapshot = buffer.read_with(cx, |buffer, _| buffer.snapshot());
1938 let cursor = buffer.read_with(cx, |buffer, _| buffer.anchor_before(Point::new(1, 0)));
1939 let completion_task = zeta.update(cx, |zeta, cx| {
1940 zeta.request_completion(None, &buffer, cursor, false, cx)
1941 });
1942
1943 let token_request = server.receive::<proto::GetLlmToken>().await.unwrap();
1944 server.respond(
1945 token_request.receipt(),
1946 proto::GetLlmTokenResponse { token: "".into() },
1947 );
1948
1949 let completion = completion_task.await.unwrap().unwrap();
1950 completion
1951 .edits
1952 .into_iter()
1953 .map(|(old_range, new_text)| (old_range.to_point(&snapshot), new_text.clone()))
1954 .collect::<Vec<_>>()
1955 }
1956
1957 fn to_completion_edits(
1958 iterator: impl IntoIterator<Item = (Range<usize>, String)>,
1959 buffer: &Entity<Buffer>,
1960 cx: &App,
1961 ) -> Vec<(Range<Anchor>, String)> {
1962 let buffer = buffer.read(cx);
1963 iterator
1964 .into_iter()
1965 .map(|(range, text)| {
1966 (
1967 buffer.anchor_after(range.start)..buffer.anchor_before(range.end),
1968 text,
1969 )
1970 })
1971 .collect()
1972 }
1973
1974 fn from_completion_edits(
1975 editor_edits: &[(Range<Anchor>, String)],
1976 buffer: &Entity<Buffer>,
1977 cx: &App,
1978 ) -> Vec<(Range<usize>, String)> {
1979 let buffer = buffer.read(cx);
1980 editor_edits
1981 .iter()
1982 .map(|(range, text)| {
1983 (
1984 range.start.to_offset(buffer)..range.end.to_offset(buffer),
1985 text.clone(),
1986 )
1987 })
1988 .collect()
1989 }
1990
1991 #[ctor::ctor]
1992 fn init_logger() {
1993 if std::env::var("RUST_LOG").is_ok() {
1994 env_logger::init();
1995 }
1996 }
1997}