mod copilot_edit_prediction_delegate; pub mod request; use crate::request::{ DidFocus, DidFocusParams, FormattingOptions, InlineCompletionContext, InlineCompletionTriggerKind, InlineCompletions, NextEditSuggestions, }; use ::fs::Fs; use anyhow::{Context as _, Result, anyhow}; use collections::{HashMap, HashSet}; use command_palette_hooks::CommandPaletteFilter; use futures::future; use futures::{Future, FutureExt, TryFutureExt, channel::oneshot, future::Shared, select_biased}; use gpui::{ App, AppContext as _, AsyncApp, Context, Entity, EntityId, EventEmitter, Global, Subscription, Task, WeakEntity, actions, }; use language::language_settings::{AllLanguageSettings, CopilotSettings}; use language::{ Anchor, Bias, Buffer, BufferSnapshot, Language, PointUtf16, ToPointUtf16, language_settings::{EditPredictionProvider, all_language_settings}, point_from_lsp, point_to_lsp, }; use lsp::{LanguageServer, LanguageServerBinary, LanguageServerId, LanguageServerName}; use node_runtime::{NodeRuntime, VersionStrategy}; use parking_lot::Mutex; use project::project_settings::ProjectSettings; use project::{DisableAiSettings, Project}; use request::DidChangeStatus; use serde_json::json; use settings::{Settings, SettingsStore}; use std::{ any::TypeId, collections::hash_map::Entry, env, ffi::OsString, mem, ops::Range, path::{Path, PathBuf}, sync::Arc, }; use sum_tree::Dimensions; use util::{ResultExt, fs::remove_matching}; use workspace::AppState; pub use crate::copilot_edit_prediction_delegate::CopilotEditPredictionDelegate; actions!( copilot, [ /// Requests a code completion suggestion from Copilot. Suggest, /// Cycles to the next Copilot suggestion. NextSuggestion, /// Cycles to the previous Copilot suggestion. PreviousSuggestion, /// Reinstalls the Copilot language server. Reinstall, /// Signs in to GitHub Copilot. SignIn, /// Signs out of GitHub Copilot. SignOut ] ); enum CopilotServer { Disabled, Starting { task: Shared> }, Error(Arc), Running(RunningCopilotServer), } impl CopilotServer { fn as_authenticated(&mut self) -> Result<&mut RunningCopilotServer> { let server = self.as_running()?; anyhow::ensure!( matches!(server.sign_in_status, SignInStatus::Authorized), "must sign in before using copilot" ); Ok(server) } fn as_running(&mut self) -> Result<&mut RunningCopilotServer> { match self { CopilotServer::Starting { .. } => anyhow::bail!("copilot is still starting"), CopilotServer::Disabled => anyhow::bail!("copilot is disabled"), CopilotServer::Error(error) => { anyhow::bail!("copilot was not started because of an error: {error}") } CopilotServer::Running(server) => Ok(server), } } } struct RunningCopilotServer { lsp: Arc, sign_in_status: SignInStatus, registered_buffers: HashMap, } #[derive(Clone, Debug)] enum SignInStatus { Authorized, Unauthorized, SigningIn { prompt: Option, task: Shared>>>, }, SignedOut { awaiting_signing_in: bool, }, } #[derive(Debug, Clone)] pub enum Status { Starting { task: Shared>, }, Error(Arc), Disabled, SignedOut { awaiting_signing_in: bool, }, SigningIn { prompt: Option, }, Unauthorized, Authorized, } impl Status { pub fn is_authorized(&self) -> bool { matches!(self, Status::Authorized) } pub fn is_configured(&self) -> bool { matches!( self, Status::Starting { .. } | Status::Error(_) | Status::SigningIn { .. } | Status::Authorized ) } } struct RegisteredBuffer { uri: lsp::Uri, language_id: String, snapshot: BufferSnapshot, snapshot_version: i32, _subscriptions: [gpui::Subscription; 2], pending_buffer_change: Task>, } impl RegisteredBuffer { fn report_changes( &mut self, buffer: &Entity, cx: &mut Context, ) -> oneshot::Receiver<(i32, BufferSnapshot)> { let (done_tx, done_rx) = oneshot::channel(); if buffer.read(cx).version() == self.snapshot.version { let _ = done_tx.send((self.snapshot_version, self.snapshot.clone())); } else { let buffer = buffer.downgrade(); let id = buffer.entity_id(); let prev_pending_change = mem::replace(&mut self.pending_buffer_change, Task::ready(None)); self.pending_buffer_change = cx.spawn(async move |copilot, cx| { prev_pending_change.await; let old_version = copilot .update(cx, |copilot, _| { let server = copilot.server.as_authenticated().log_err()?; let buffer = server.registered_buffers.get_mut(&id)?; Some(buffer.snapshot.version.clone()) }) .ok()??; let new_snapshot = buffer.read_with(cx, |buffer, _| buffer.snapshot()).ok()?; let content_changes = cx .background_spawn({ let new_snapshot = new_snapshot.clone(); async move { new_snapshot .edits_since::>(&old_version) .map(|edit| { let edit_start = edit.new.start.0; let edit_end = edit_start + (edit.old.end.0 - edit.old.start.0); let new_text = new_snapshot .text_for_range(edit.new.start.1..edit.new.end.1) .collect(); lsp::TextDocumentContentChangeEvent { range: Some(lsp::Range::new( point_to_lsp(edit_start), point_to_lsp(edit_end), )), range_length: None, text: new_text, } }) .collect::>() } }) .await; copilot .update(cx, |copilot, _| { let server = copilot.server.as_authenticated().log_err()?; let buffer = server.registered_buffers.get_mut(&id)?; if !content_changes.is_empty() { buffer.snapshot_version += 1; buffer.snapshot = new_snapshot; server .lsp .notify::( lsp::DidChangeTextDocumentParams { text_document: lsp::VersionedTextDocumentIdentifier::new( buffer.uri.clone(), buffer.snapshot_version, ), content_changes, }, ) .ok(); } let _ = done_tx.send((buffer.snapshot_version, buffer.snapshot.clone())); Some(()) }) .ok()?; Some(()) }); } done_rx } } #[derive(Debug)] pub struct Completion { pub uuid: String, pub range: Range, pub text: String, } pub struct Copilot { fs: Arc, node_runtime: NodeRuntime, server: CopilotServer, buffers: HashSet>, server_id: LanguageServerId, _subscriptions: Vec, } pub enum Event { CopilotAuthSignedIn, CopilotAuthSignedOut, } impl EventEmitter for Copilot {} #[derive(Clone)] pub struct GlobalCopilotAuth(pub Entity); impl GlobalCopilotAuth { pub fn set_global( server_id: LanguageServerId, fs: Arc, node_runtime: NodeRuntime, cx: &mut App, ) -> GlobalCopilotAuth { let auth = GlobalCopilotAuth(cx.new(|cx| Copilot::new(None, server_id, fs, node_runtime, cx))); cx.set_global(auth.clone()); auth } pub fn try_global(cx: &mut App) -> Option<&GlobalCopilotAuth> { cx.try_global() } pub fn try_get_or_init(app_state: Arc, cx: &mut App) -> Option { let ai_enabled = !DisableAiSettings::get(None, cx).disable_ai; if let Some(copilot) = cx.try_global::().cloned() { if ai_enabled { Some(copilot) } else { cx.remove_global::(); None } } else if ai_enabled { Some(Self::set_global( app_state.languages.next_language_server_id(), app_state.fs.clone(), app_state.node_runtime.clone(), cx, )) } else { None } } } impl Global for GlobalCopilotAuth {} #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub(crate) enum CompletionSource { NextEditSuggestion, InlineCompletion, } /// Copilot's NextEditSuggestion response, with coordinates converted to Anchors. #[derive(Clone)] pub(crate) struct CopilotEditPrediction { pub(crate) buffer: Entity, pub(crate) range: Range, pub(crate) text: String, pub(crate) command: Option, pub(crate) snapshot: BufferSnapshot, pub(crate) source: CompletionSource, } impl Copilot { pub fn new( project: Option>, new_server_id: LanguageServerId, fs: Arc, node_runtime: NodeRuntime, cx: &mut Context, ) -> Self { let send_focus_notification = project.map(|project| { cx.subscribe(&project, |this, project, e: &project::Event, cx| { if let project::Event::ActiveEntryChanged(new_entry) = e && let Ok(running) = this.server.as_authenticated() { let uri = new_entry .and_then(|id| project.read(cx).path_for_entry(id, cx)) .and_then(|entry| project.read(cx).absolute_path(&entry, cx)) .and_then(|abs_path| lsp::Uri::from_file_path(abs_path).ok()); _ = running.lsp.notify::(DidFocusParams { uri }); } }) }); let global_authentication_events = cx.try_global::().cloned().map(|auth| { cx.subscribe(&auth.0, |_, _, _: &Event, cx| { let request_timeout = ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout(); cx.spawn(async move |this, cx| { let Some(server) = this .update(cx, |this, _| this.language_server().cloned()) .ok() .flatten() else { return; }; let status = server .request::( request::CheckStatusParams { local_checks_only: false, }, request_timeout, ) .await .into_response() .ok(); if let Some(status) = status { this.update(cx, |copilot, cx| { copilot.update_sign_in_status(status, cx); }) .ok(); } }) .detach() }) }); let _subscriptions = std::iter::once(cx.on_app_quit(Self::shutdown_language_server)) .chain(send_focus_notification) .chain(global_authentication_events) .collect(); let mut this = Self { server_id: new_server_id, fs, node_runtime, server: CopilotServer::Disabled, buffers: Default::default(), _subscriptions, }; this.start_copilot(true, false, cx); cx.observe_global::(move |this, cx| { let ai_disabled = DisableAiSettings::get_global(cx).disable_ai; if ai_disabled { // Stop the server if AI is disabled if !matches!(this.server, CopilotServer::Disabled) { let shutdown = match mem::replace(&mut this.server, CopilotServer::Disabled) { CopilotServer::Running(server) => { let shutdown_future = server.lsp.shutdown(); Some(cx.background_spawn(async move { if let Some(fut) = shutdown_future { fut.await; } })) } _ => None, }; if let Some(task) = shutdown { task.detach(); } cx.notify(); } } else { // Only start if AI is enabled this.start_copilot(true, false, cx); if let Ok(server) = this.server.as_running() { notify_did_change_config_to_server(&server.lsp, cx) .context("copilot setting change: did change configuration") .log_err(); } } this.update_action_visibilities(cx); }) .detach(); cx.observe_self(|copilot, cx| { copilot.update_action_visibilities(cx); }) .detach(); this } fn shutdown_language_server( &mut self, _cx: &mut Context, ) -> impl Future + use<> { let shutdown = match mem::replace(&mut self.server, CopilotServer::Disabled) { CopilotServer::Running(server) => Some(Box::pin(async move { server.lsp.shutdown() })), _ => None, }; async move { if let Some(shutdown) = shutdown { shutdown.await; } } } pub fn start_copilot( &mut self, check_edit_prediction_provider: bool, awaiting_sign_in_after_start: bool, cx: &mut Context, ) { if DisableAiSettings::get_global(cx).disable_ai { return; } if !matches!(self.server, CopilotServer::Disabled) { return; } let language_settings = all_language_settings(None, cx); if check_edit_prediction_provider && language_settings.edit_predictions.provider != EditPredictionProvider::Copilot { return; } let server_id = self.server_id; let fs = self.fs.clone(); let node_runtime = self.node_runtime.clone(); let env = self.build_env(&language_settings.edit_predictions.copilot); let start_task = cx .spawn(async move |this, cx| { Self::start_language_server( server_id, fs, node_runtime, env, this, awaiting_sign_in_after_start, cx, ) .await }) .shared(); self.server = CopilotServer::Starting { task: start_task }; cx.notify(); } fn build_env(&self, copilot_settings: &CopilotSettings) -> Option> { let proxy_url = copilot_settings.proxy.clone()?; let no_verify = copilot_settings.proxy_no_verify; let http_or_https_proxy = if proxy_url.starts_with("http:") { Some("HTTP_PROXY") } else if proxy_url.starts_with("https:") { Some("HTTPS_PROXY") } else { log::error!( "Unsupported protocol scheme for language server proxy (must be http or https)" ); None }; let mut env = HashMap::default(); if let Some(proxy_type) = http_or_https_proxy { env.insert(proxy_type.to_string(), proxy_url); if let Some(true) = no_verify { env.insert("NODE_TLS_REJECT_UNAUTHORIZED".to_string(), "0".to_string()); }; } if let Ok(oauth_token) = env::var(copilot_chat::COPILOT_OAUTH_ENV_VAR) { env.insert(copilot_chat::COPILOT_OAUTH_ENV_VAR.to_string(), oauth_token); } if env.is_empty() { None } else { Some(env) } } #[cfg(any(test, feature = "test-support"))] pub fn fake(cx: &mut gpui::TestAppContext) -> (Entity, lsp::FakeLanguageServer) { use fs::FakeFs; use gpui::Subscription; use lsp::FakeLanguageServer; use node_runtime::NodeRuntime; let (server, fake_server) = FakeLanguageServer::new( LanguageServerId(0), LanguageServerBinary { path: "path/to/copilot".into(), arguments: vec![], env: None, }, "copilot".into(), Default::default(), &mut cx.to_async(), ); let node_runtime = NodeRuntime::unavailable(); let send_focus_notification = Subscription::new(|| {}); let this = cx.new(|cx| Self { server_id: LanguageServerId(0), fs: FakeFs::new(cx.background_executor().clone()), node_runtime, server: CopilotServer::Running(RunningCopilotServer { lsp: Arc::new(server), sign_in_status: SignInStatus::Authorized, registered_buffers: Default::default(), }), _subscriptions: vec![ send_focus_notification, cx.on_app_quit(Self::shutdown_language_server), ], buffers: Default::default(), }); (this, fake_server) } async fn start_language_server( new_server_id: LanguageServerId, fs: Arc, node_runtime: NodeRuntime, env: Option>, this: WeakEntity, awaiting_sign_in_after_start: bool, cx: &mut AsyncApp, ) { let start_language_server = async { let server_path = get_copilot_lsp(fs, node_runtime).await?; let arguments: Vec = vec!["--stdio".into()]; let binary = LanguageServerBinary { path: server_path, arguments, env, }; let root_path = if cfg!(target_os = "windows") { Path::new("C:/") } else { Path::new("/") }; let server_name = LanguageServerName("copilot".into()); let server = LanguageServer::new( Arc::new(Mutex::new(None)), new_server_id, server_name, binary, root_path, None, Default::default(), cx, )?; server .on_notification::({ let this = this.clone(); move |params, cx| { if params.kind == request::StatusKind::Normal { let this = this.clone(); cx.spawn(async move |cx| { let lsp = this .read_with(cx, |copilot, _| { if let CopilotServer::Running(server) = &copilot.server { Some(server.lsp.clone()) } else { None } }) .ok() .flatten(); let Some(lsp) = lsp else { return }; let request_timeout = cx.update(|cx| { ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout() }); let status = lsp .request::( request::CheckStatusParams { local_checks_only: false, }, request_timeout, ) .await .into_response() .ok(); if let Some(status) = status { this.update(cx, |copilot, cx| { copilot.update_sign_in_status(status, cx); }) .ok(); } }) .detach(); } } }) .detach(); server .on_request::(move |params, cx| { if params.external.unwrap_or(false) { let url = params.uri.to_string(); cx.update(|cx| cx.open_url(&url)); } async move { Ok(lsp::ShowDocumentResult { success: true }) } }) .detach(); let configuration = lsp::DidChangeConfigurationParams { settings: Default::default(), }; let editor_info = request::SetEditorInfoParams { editor_info: request::EditorInfo { name: "zed".into(), version: env!("CARGO_PKG_VERSION").into(), }, editor_plugin_info: request::EditorPluginInfo { name: "zed-copilot".into(), version: "0.0.1".into(), }, }; let editor_info_json = serde_json::to_value(&editor_info)?; let request_timeout = cx.update(|app| { ProjectSettings::get_global(app) .global_lsp_settings .get_request_timeout() }); let server = cx .update(|cx| { let mut params = server.default_initialize_params(false, false, cx); params.initialization_options = Some(editor_info_json); params .capabilities .window .get_or_insert_with(Default::default) .show_document = Some(lsp::ShowDocumentClientCapabilities { support: true }); server.initialize(params, configuration.into(), request_timeout, cx) }) .await?; this.update(cx, |_, cx| notify_did_change_config_to_server(&server, cx))? .context("copilot: did change configuration")?; let status = server .request::( request::CheckStatusParams { local_checks_only: false, }, request_timeout, ) .await .into_response() .context("copilot: check status")?; anyhow::Ok((server, status)) }; let server = start_language_server.await; this.update(cx, |this, cx| { cx.notify(); if env::var("ZED_FORCE_COPILOT_ERROR").is_ok() { this.server = CopilotServer::Error( "Forced error for testing (ZED_FORCE_COPILOT_ERROR)".into(), ); return; } match server { Ok((server, status)) => { this.server = CopilotServer::Running(RunningCopilotServer { lsp: server, sign_in_status: SignInStatus::SignedOut { awaiting_signing_in: awaiting_sign_in_after_start, }, registered_buffers: Default::default(), }); this.update_sign_in_status(status, cx); } Err(error) => { this.server = CopilotServer::Error(error.to_string().into()); cx.notify() } } }) .ok(); } pub fn is_authenticated(&self) -> bool { return matches!( self.server, CopilotServer::Running(RunningCopilotServer { sign_in_status: SignInStatus::Authorized, .. }) ); } pub fn sign_in(&mut self, cx: &mut Context) -> Task> { if let CopilotServer::Running(server) = &mut self.server { let task = match &server.sign_in_status { SignInStatus::Authorized => Task::ready(Ok(())).shared(), SignInStatus::SigningIn { task, .. } => { cx.notify(); task.clone() } SignInStatus::SignedOut { .. } | SignInStatus::Unauthorized => { let lsp = server.lsp.clone(); let request_timeout = ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout(); let task = cx .spawn(async move |this, cx| { let sign_in = async { let flow = lsp .request::( request::SignInParams {}, request_timeout, ) .await .into_response() .context("copilot sign-in")?; this.update(cx, |this, cx| { if let CopilotServer::Running(RunningCopilotServer { sign_in_status: status, .. }) = &mut this.server && let SignInStatus::SigningIn { prompt: prompt_flow, .. } = status { *prompt_flow = Some(flow.clone()); cx.notify(); } })?; anyhow::Ok(()) }; let sign_in = sign_in.await; this.update(cx, |this, cx| match sign_in { Ok(()) => Ok(()), Err(error) => { this.update_sign_in_status( request::SignInStatus::NotSignedIn, cx, ); Err(Arc::new(error)) } })? }) .shared(); server.sign_in_status = SignInStatus::SigningIn { prompt: None, task: task.clone(), }; cx.notify(); task } }; cx.background_spawn(task.map_err(|err| anyhow!("{err:?}"))) } else { // If we're downloading, wait until download is finished // If we're in a stuck state, display to the user Task::ready(Err(anyhow!("copilot hasn't started yet"))) } } pub fn sign_out(&mut self, cx: &mut Context) -> Task> { self.update_sign_in_status(request::SignInStatus::NotSignedIn, cx); match &self.server { CopilotServer::Running(RunningCopilotServer { lsp: server, .. }) => { let request_timeout = ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout(); let server = server.clone(); cx.background_spawn(async move { server .request::(request::SignOutParams {}, request_timeout) .await .into_response() .context("copilot: sign in confirm")?; anyhow::Ok(()) }) } CopilotServer::Disabled => cx.background_spawn(async { clear_copilot_config_dir().await; anyhow::Ok(()) }), _ => Task::ready(Err(anyhow!("copilot hasn't started yet"))), } } pub fn reinstall(&mut self, cx: &mut Context) -> Shared> { let language_settings = all_language_settings(None, cx); let env = self.build_env(&language_settings.edit_predictions.copilot); let start_task = cx .spawn({ let fs = self.fs.clone(); let node_runtime = self.node_runtime.clone(); let server_id = self.server_id; async move |this, cx| { clear_copilot_dir().await; Self::start_language_server(server_id, fs, node_runtime, env, this, false, cx) .await } }) .shared(); self.server = CopilotServer::Starting { task: start_task.clone(), }; cx.notify(); start_task } pub fn language_server(&self) -> Option<&Arc> { if let CopilotServer::Running(server) = &self.server { Some(&server.lsp) } else { None } } pub fn register_buffer(&mut self, buffer: &Entity, cx: &mut Context) { let weak_buffer = buffer.downgrade(); self.buffers.insert(weak_buffer.clone()); if let CopilotServer::Running(RunningCopilotServer { lsp: server, sign_in_status: status, registered_buffers, .. }) = &mut self.server { if !matches!(status, SignInStatus::Authorized) { return; } let entry = registered_buffers.entry(buffer.entity_id()); if let Entry::Vacant(e) = entry { let Ok(uri) = uri_for_buffer(buffer, cx) else { return; }; let language_id = id_for_language(buffer.read(cx).language()); let snapshot = buffer.read(cx).snapshot(); server .notify::( lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem { uri: uri.clone(), language_id: language_id.clone(), version: 0, text: snapshot.text(), }, }, ) .ok(); e.insert(RegisteredBuffer { uri, language_id, snapshot, snapshot_version: 0, pending_buffer_change: Task::ready(Some(())), _subscriptions: [ cx.subscribe(buffer, |this, buffer, event, cx| { this.handle_buffer_event(buffer, event, cx).log_err(); }), cx.observe_release(buffer, move |this, _buffer, _cx| { this.buffers.remove(&weak_buffer); this.unregister_buffer(&weak_buffer); }), ], }); } } } fn handle_buffer_event( &mut self, buffer: Entity, event: &language::BufferEvent, cx: &mut Context, ) -> Result<()> { if let Ok(server) = self.server.as_running() && let Some(registered_buffer) = server.registered_buffers.get_mut(&buffer.entity_id()) { match event { language::BufferEvent::Edited { .. } => { drop(registered_buffer.report_changes(&buffer, cx)); } language::BufferEvent::Saved => { server .lsp .notify::( lsp::DidSaveTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new( registered_buffer.uri.clone(), ), text: None, }, ) .ok(); } language::BufferEvent::FileHandleChanged | language::BufferEvent::LanguageChanged(_) => { let new_language_id = id_for_language(buffer.read(cx).language()); let Ok(new_uri) = uri_for_buffer(&buffer, cx) else { return Ok(()); }; if new_uri != registered_buffer.uri || new_language_id != registered_buffer.language_id { let old_uri = mem::replace(&mut registered_buffer.uri, new_uri); registered_buffer.language_id = new_language_id; server .lsp .notify::( lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(old_uri), }, ) .ok(); server .lsp .notify::( lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( registered_buffer.uri.clone(), registered_buffer.language_id.clone(), registered_buffer.snapshot_version, registered_buffer.snapshot.text(), ), }, ) .ok(); } } _ => {} } } Ok(()) } fn unregister_buffer(&mut self, buffer: &WeakEntity) { if let Ok(server) = self.server.as_running() && let Some(buffer) = server.registered_buffers.remove(&buffer.entity_id()) { server .lsp .notify::( lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(buffer.uri), }, ) .ok(); } } pub(crate) fn completions( &mut self, buffer: &Entity, position: Anchor, cx: &mut Context, ) -> Task>> { self.register_buffer(buffer, cx); let server = match self.server.as_authenticated() { Ok(server) => server, Err(error) => return Task::ready(Err(error)), }; let buffer_entity = buffer.clone(); let lsp = server.lsp.clone(); let Some(registered_buffer) = server.registered_buffers.get_mut(&buffer.entity_id()) else { return Task::ready(Err(anyhow::anyhow!("buffer not registered"))); }; let pending_snapshot = registered_buffer.report_changes(buffer, cx); let buffer = buffer.read(cx); let uri = registered_buffer.uri.clone(); let position = position.to_point_utf16(buffer); let snapshot = buffer.snapshot(); let settings = snapshot.settings_at(0, cx); let tab_size = settings.tab_size.get(); let hard_tabs = settings.hard_tabs; drop(settings); let request_timeout = ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout(); let nes_enabled = AllLanguageSettings::get_global(cx) .edit_predictions .copilot .enable_next_edit_suggestions .unwrap_or(true); cx.background_spawn(async move { let (version, snapshot) = pending_snapshot.await?; let lsp_position = point_to_lsp(position); let nes_fut = if nes_enabled { lsp.request::( request::NextEditSuggestionsParams { text_document: lsp::VersionedTextDocumentIdentifier { uri: uri.clone(), version, }, position: lsp_position, }, request_timeout, ) .map(|resp| { resp.into_response() .ok() .map(|result| { result .edits .into_iter() .map(|completion| { let start = snapshot.clip_point_utf16( point_from_lsp(completion.range.start), Bias::Left, ); let end = snapshot.clip_point_utf16( point_from_lsp(completion.range.end), Bias::Left, ); CopilotEditPrediction { buffer: buffer_entity.clone(), range: snapshot.anchor_before(start) ..snapshot.anchor_after(end), text: completion.text, command: completion.command, snapshot: snapshot.clone(), source: CompletionSource::NextEditSuggestion, } }) .collect::>() }) .unwrap_or_default() }) .left_future() .fuse() } else { future::ready(Vec::::new()) .right_future() .fuse() }; let inline_fut = lsp .request::( request::InlineCompletionsParams { text_document: lsp::VersionedTextDocumentIdentifier { uri: uri.clone(), version, }, position: lsp_position, context: InlineCompletionContext { trigger_kind: InlineCompletionTriggerKind::Automatic, }, formatting_options: Some(FormattingOptions { tab_size, insert_spaces: !hard_tabs, }), }, request_timeout, ) .map(|resp| { resp.into_response() .ok() .map(|result| { result .items .into_iter() .map(|item| { let start = snapshot.clip_point_utf16( point_from_lsp(item.range.start), Bias::Left, ); let end = snapshot.clip_point_utf16( point_from_lsp(item.range.end), Bias::Left, ); CopilotEditPrediction { buffer: buffer_entity.clone(), range: snapshot.anchor_before(start) ..snapshot.anchor_after(end), text: item.insert_text, command: item.command, snapshot: snapshot.clone(), source: CompletionSource::InlineCompletion, } }) .collect::>() }) .unwrap_or_default() }) .fuse(); futures::pin_mut!(nes_fut, inline_fut); let mut nes_result: Option> = None; let mut inline_result: Option> = None; loop { select_biased! { nes = nes_fut => { if !nes.is_empty() { return Ok(nes); } nes_result = Some(nes); } inline = inline_fut => { if !inline.is_empty() { return Ok(inline); } inline_result = Some(inline); } complete => break, } if let (Some(nes), Some(inline)) = (&nes_result, &inline_result) { return if !nes.is_empty() { Ok(nes.clone()) } else { Ok(inline.clone()) }; } } Ok(nes_result.or(inline_result).unwrap_or_default()) }) } pub(crate) fn accept_completion( &mut self, completion: &CopilotEditPrediction, cx: &mut Context, ) -> Task> { let server = match self.server.as_authenticated() { Ok(server) => server, Err(error) => return Task::ready(Err(error)), }; if let Some(command) = &completion.command { let request_timeout = ProjectSettings::get_global(cx) .global_lsp_settings .get_request_timeout(); let request = server.lsp.request::( lsp::ExecuteCommandParams { command: command.command.clone(), arguments: command.arguments.clone().unwrap_or_default(), ..Default::default() }, request_timeout, ); cx.background_spawn(async move { request .await .into_response() .context("copilot: notify accepted")?; Ok(()) }) } else { Task::ready(Ok(())) } } pub fn status(&self) -> Status { match &self.server { CopilotServer::Starting { task } => Status::Starting { task: task.clone() }, CopilotServer::Disabled => Status::Disabled, CopilotServer::Error(error) => Status::Error(error.clone()), CopilotServer::Running(RunningCopilotServer { sign_in_status, .. }) => { match sign_in_status { SignInStatus::Authorized => Status::Authorized, SignInStatus::Unauthorized => Status::Unauthorized, SignInStatus::SigningIn { prompt, .. } => Status::SigningIn { prompt: prompt.clone(), }, SignInStatus::SignedOut { awaiting_signing_in, } => Status::SignedOut { awaiting_signing_in: *awaiting_signing_in, }, } } } } pub fn update_sign_in_status( &mut self, lsp_status: request::SignInStatus, cx: &mut Context, ) { self.buffers.retain(|buffer| buffer.is_upgradable()); if let Ok(server) = self.server.as_running() { match lsp_status { request::SignInStatus::Ok { user: Some(_) } | request::SignInStatus::MaybeOk { .. } | request::SignInStatus::AlreadySignedIn { .. } => { server.sign_in_status = SignInStatus::Authorized; cx.emit(Event::CopilotAuthSignedIn); for buffer in self.buffers.iter().cloned().collect::>() { if let Some(buffer) = buffer.upgrade() { self.register_buffer(&buffer, cx); } } } request::SignInStatus::NotAuthorized { .. } => { server.sign_in_status = SignInStatus::Unauthorized; for buffer in self.buffers.iter().cloned().collect::>() { self.unregister_buffer(&buffer); } } request::SignInStatus::Ok { user: None } | request::SignInStatus::NotSignedIn => { if !matches!(server.sign_in_status, SignInStatus::SignedOut { .. }) { server.sign_in_status = SignInStatus::SignedOut { awaiting_signing_in: false, }; } cx.emit(Event::CopilotAuthSignedOut); for buffer in self.buffers.iter().cloned().collect::>() { self.unregister_buffer(&buffer); } } } cx.notify(); } } fn update_action_visibilities(&self, cx: &mut App) { let signed_in_actions = [ TypeId::of::(), TypeId::of::(), TypeId::of::(), TypeId::of::(), ]; let auth_actions = [TypeId::of::()]; let no_auth_actions = [TypeId::of::()]; let status = self.status(); let is_ai_disabled = DisableAiSettings::get_global(cx).disable_ai; let filter = CommandPaletteFilter::global_mut(cx); if is_ai_disabled { filter.hide_action_types(&signed_in_actions); filter.hide_action_types(&auth_actions); filter.hide_action_types(&no_auth_actions); } else { match status { Status::Disabled => { filter.hide_action_types(&signed_in_actions); filter.hide_action_types(&auth_actions); filter.hide_action_types(&no_auth_actions); } Status::Authorized => { filter.hide_action_types(&no_auth_actions); filter.show_action_types(signed_in_actions.iter().chain(&auth_actions)); } _ => { filter.hide_action_types(&signed_in_actions); filter.hide_action_types(&auth_actions); filter.show_action_types(&no_auth_actions); } } } } } fn id_for_language(language: Option<&Arc>) -> String { language .map(|language| language.lsp_id()) .unwrap_or_else(|| "plaintext".to_string()) } fn uri_for_buffer(buffer: &Entity, cx: &App) -> Result { if let Some(file) = buffer.read(cx).file().and_then(|file| file.as_local()) { lsp::Uri::from_file_path(file.abs_path(cx)) } else { format!("buffer://{}", buffer.entity_id()) .parse() .map_err(|_| ()) } } fn notify_did_change_config_to_server( server: &Arc, cx: &mut Context, ) -> std::result::Result<(), anyhow::Error> { let copilot_settings = all_language_settings(None, cx) .edit_predictions .copilot .clone(); if let Some(copilot_chat) = copilot_chat::CopilotChat::global(cx) { copilot_chat.update(cx, |chat, cx| { chat.set_configuration( copilot_chat::CopilotChatConfiguration { enterprise_uri: copilot_settings.enterprise_uri.clone(), }, cx, ); }); } let settings = json!({ "http": { "proxy": copilot_settings.proxy, "proxyStrictSSL": !copilot_settings.proxy_no_verify.unwrap_or(false) }, "github-enterprise": { "uri": copilot_settings.enterprise_uri } }); server .notify::(lsp::DidChangeConfigurationParams { settings, }) .ok(); Ok(()) } async fn clear_copilot_dir() { remove_matching(paths::copilot_dir(), |_| true).await } async fn clear_copilot_config_dir() { remove_matching(copilot_chat::copilot_chat_config_dir(), |_| true).await } async fn get_copilot_lsp(fs: Arc, node_runtime: NodeRuntime) -> anyhow::Result { const PACKAGE_NAME: &str = "@github/copilot-language-server"; const SERVER_PATH: &str = "node_modules/@github/copilot-language-server/dist/language-server.js"; let latest_version = node_runtime .npm_package_latest_version(PACKAGE_NAME) .await?; let server_path = paths::copilot_dir().join(SERVER_PATH); let binary_path = copilot_lsp_native_binary_path()?; fs.create_dir(paths::copilot_dir()).await?; let should_install = !fs.is_file(&binary_path).await || node_runtime .should_install_npm_package( PACKAGE_NAME, &server_path, paths::copilot_dir(), VersionStrategy::Latest(&latest_version), ) .await; if should_install { node_runtime .npm_install_packages( paths::copilot_dir(), &[(PACKAGE_NAME, &latest_version.to_string())], ) .await?; } if fs.is_file(&binary_path).await { return Ok(binary_path); } anyhow::bail!("GitHub Copilot native language server binary was not installed") } fn copilot_lsp_native_binary_path() -> anyhow::Result { let platform = match env::consts::OS { "linux" => "linux", "macos" => "darwin", "windows" => "win32", platform => anyhow::bail!("unsupported Copilot language server platform: {platform}"), }; let architecture = match env::consts::ARCH { "aarch64" => "arm64", "x86_64" => "x64", architecture => { anyhow::bail!("unsupported Copilot language server architecture: {architecture}") } }; let package_name = format!("copilot-language-server-{platform}-{architecture}"); let executable_name = if cfg!(target_os = "windows") { "copilot-language-server.exe" } else { "copilot-language-server" }; Ok(paths::copilot_dir() .join("node_modules") .join("@github") .join(package_name) .join(executable_name)) } #[cfg(test)] mod tests { use super::*; use fs::FakeFs; use gpui::TestAppContext; use language::language_settings::AllLanguageSettings; use node_runtime::NodeRuntime; use settings::{Settings, SettingsStore}; use util::{ path, paths::PathStyle, rel_path::{RelPath, rel_path}, }; #[gpui::test] async fn test_copilot_does_not_start_when_ai_disabled(cx: &mut TestAppContext) { cx.update(|cx| { let store = SettingsStore::test(cx); cx.set_global(store); DisableAiSettings::register(cx); AllLanguageSettings::register(cx); // Set disable_ai to true before creating Copilot DisableAiSettings::override_global(DisableAiSettings { disable_ai: true }, cx); }); let copilot = cx.new(|cx| Copilot { server_id: LanguageServerId(0), fs: FakeFs::new(cx.background_executor().clone()), node_runtime: NodeRuntime::unavailable(), server: CopilotServer::Disabled, buffers: Default::default(), _subscriptions: vec![], }); // Try to start copilot - it should remain disabled copilot.update(cx, |copilot, cx| { copilot.start_copilot(false, false, cx); }); // Verify the server is still disabled copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Disabled), "Copilot should not start when disable_ai is true" ); }); } #[gpui::test] async fn test_copilot_stops_when_ai_becomes_disabled(cx: &mut TestAppContext) { cx.update(|cx| { let store = SettingsStore::test(cx); cx.set_global(store); DisableAiSettings::register(cx); AllLanguageSettings::register(cx); // AI is initially enabled DisableAiSettings::override_global(DisableAiSettings { disable_ai: false }, cx); }); // Create a fake Copilot that's already running, with the settings observer let (copilot, _lsp) = Copilot::fake(cx); // Add the settings observer that handles disable_ai changes copilot.update(cx, |_, cx| { cx.observe_global::(move |this, cx| { let ai_disabled = DisableAiSettings::get_global(cx).disable_ai; if ai_disabled { if !matches!(this.server, CopilotServer::Disabled) { let shutdown = match mem::replace(&mut this.server, CopilotServer::Disabled) { CopilotServer::Running(server) => { let shutdown_future = server.lsp.shutdown(); Some(cx.background_spawn(async move { if let Some(fut) = shutdown_future { fut.await; } })) } _ => None, }; if let Some(task) = shutdown { task.detach(); } cx.notify(); } } }) .detach(); }); // Verify copilot is running copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Running(_)), "Copilot should be running initially" ); }); // Now disable AI cx.update(|cx| { DisableAiSettings::override_global(DisableAiSettings { disable_ai: true }, cx); }); // The settings observer should have stopped the server cx.run_until_parked(); copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Disabled), "Copilot should be disabled after disable_ai is set to true" ); }); } #[gpui::test(iterations = 10)] async fn test_buffer_management(cx: &mut TestAppContext) { init_test(cx); let (copilot, mut lsp) = Copilot::fake(cx); let buffer_1 = cx.new(|cx| Buffer::local("Hello", cx)); let buffer_1_uri: lsp::Uri = format!("buffer://{}", buffer_1.entity_id().as_u64()) .parse() .unwrap(); copilot.update(cx, |copilot, cx| copilot.register_buffer(&buffer_1, cx)); assert_eq!( lsp.receive_notification::() .await, lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( buffer_1_uri.clone(), "plaintext".into(), 0, "Hello".into() ), } ); let buffer_2 = cx.new(|cx| Buffer::local("Goodbye", cx)); let buffer_2_uri: lsp::Uri = format!("buffer://{}", buffer_2.entity_id().as_u64()) .parse() .unwrap(); copilot.update(cx, |copilot, cx| copilot.register_buffer(&buffer_2, cx)); assert_eq!( lsp.receive_notification::() .await, lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( buffer_2_uri.clone(), "plaintext".into(), 0, "Goodbye".into() ), } ); buffer_1.update(cx, |buffer, cx| buffer.edit([(5..5, " world")], None, cx)); assert_eq!( lsp.receive_notification::() .await, lsp::DidChangeTextDocumentParams { text_document: lsp::VersionedTextDocumentIdentifier::new(buffer_1_uri.clone(), 1), content_changes: vec![lsp::TextDocumentContentChangeEvent { range: Some(lsp::Range::new( lsp::Position::new(0, 5), lsp::Position::new(0, 5) )), range_length: None, text: " world".into(), }], } ); // Ensure updates to the file are reflected in the LSP. buffer_1.update(cx, |buffer, cx| { buffer.file_updated( Arc::new(File { abs_path: path!("/root/child/buffer-1").into(), path: rel_path("child/buffer-1").into(), }), cx, ) }); assert_eq!( lsp.receive_notification::() .await, lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(buffer_1_uri), } ); let buffer_1_uri = lsp::Uri::from_file_path(path!("/root/child/buffer-1")).unwrap(); assert_eq!( lsp.receive_notification::() .await, lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( buffer_1_uri.clone(), "plaintext".into(), 1, "Hello world".into() ), } ); // Ensure all previously-registered buffers are closed when signing out. lsp.set_request_handler::(|_, _| async { Ok(request::SignOutResult {}) }); copilot .update(cx, |copilot, cx| copilot.sign_out(cx)) .await .unwrap(); let mut received_close_notifications = vec![ lsp.receive_notification::() .await, lsp.receive_notification::() .await, ]; received_close_notifications .sort_by_key(|notification| notification.text_document.uri.clone()); assert_eq!( received_close_notifications, vec![ lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(buffer_2_uri.clone()), }, lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(buffer_1_uri.clone()), }, ], ); // Ensure all previously-registered buffers are re-opened when signing in. lsp.set_request_handler::(|_, _| async { Ok(request::PromptUserDeviceFlow { user_code: "test-code".into(), command: lsp::Command { title: "Sign in".into(), command: "github.copilot.finishDeviceFlow".into(), arguments: None, }, }) }); copilot .update(cx, |copilot, cx| copilot.sign_in(cx)) .await .unwrap(); // Simulate auth completion by directly updating sign-in status copilot.update(cx, |copilot, cx| { copilot.update_sign_in_status( request::SignInStatus::Ok { user: Some("user-1".into()), }, cx, ); }); let mut received_open_notifications = vec![ lsp.receive_notification::() .await, lsp.receive_notification::() .await, ]; received_open_notifications .sort_by_key(|notification| notification.text_document.uri.clone()); assert_eq!( received_open_notifications, vec![ lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( buffer_2_uri.clone(), "plaintext".into(), 0, "Goodbye".into() ), }, lsp::DidOpenTextDocumentParams { text_document: lsp::TextDocumentItem::new( buffer_1_uri.clone(), "plaintext".into(), 0, "Hello world".into() ), } ] ); // Dropping a buffer causes it to be closed on the LSP side as well. cx.update(|_| drop(buffer_2)); assert_eq!( lsp.receive_notification::() .await, lsp::DidCloseTextDocumentParams { text_document: lsp::TextDocumentIdentifier::new(buffer_2_uri), } ); } struct File { abs_path: PathBuf, path: Arc, } impl language::File for File { fn as_local(&self) -> Option<&dyn language::LocalFile> { Some(self) } fn disk_state(&self) -> language::DiskState { language::DiskState::Present { mtime: ::fs::MTime::from_seconds_and_nanos(100, 42), size: 0, } } fn path(&self) -> &Arc { &self.path } fn path_style(&self, _: &App) -> PathStyle { PathStyle::local() } fn full_path(&self, _: &App) -> PathBuf { unimplemented!() } fn file_name<'a>(&'a self, _: &'a App) -> &'a str { unimplemented!() } fn to_proto(&self, _: &App) -> rpc::proto::File { unimplemented!() } fn worktree_id(&self, _: &App) -> settings::WorktreeId { settings::WorktreeId::from_usize(0) } fn is_private(&self) -> bool { false } } impl language::LocalFile for File { fn abs_path(&self, _: &App) -> PathBuf { self.abs_path.clone() } fn load(&self, _: &App) -> Task> { unimplemented!() } fn load_bytes(&self, _cx: &App) -> Task>> { unimplemented!() } } #[gpui::test] async fn test_copilot_starts_when_ai_becomes_enabled(cx: &mut TestAppContext) { cx.update(|cx| { let store = SettingsStore::test(cx); cx.set_global(store); DisableAiSettings::register(cx); AllLanguageSettings::register(cx); // AI is initially disabled DisableAiSettings::override_global(DisableAiSettings { disable_ai: true }, cx); }); let copilot = cx.new(|cx| Copilot { server_id: LanguageServerId(0), fs: FakeFs::new(cx.background_executor().clone()), node_runtime: NodeRuntime::unavailable(), server: CopilotServer::Disabled, buffers: Default::default(), _subscriptions: vec![], }); // Verify copilot is disabled initially copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Disabled), "Copilot should be disabled initially" ); }); // Try to start - should fail because AI is disabled // Use check_edit_prediction_provider=false to skip provider check copilot.update(cx, |copilot, cx| { copilot.start_copilot(false, false, cx); }); copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Disabled), "Copilot should remain disabled when disable_ai is true" ); }); // Now enable AI cx.update(|cx| { DisableAiSettings::override_global(DisableAiSettings { disable_ai: false }, cx); }); // Try to start again - should work now copilot.update(cx, |copilot, cx| { copilot.start_copilot(false, false, cx); }); copilot.read_with(cx, |copilot, _| { assert!( matches!(copilot.server, CopilotServer::Starting { .. }), "Copilot should be starting after disable_ai is set to false" ); }); } fn init_test(cx: &mut TestAppContext) { zlog::init_test(); cx.update(|cx| { let settings_store = SettingsStore::test(cx); cx.set_global(settings_store); }); } }