Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Filter AI keybindings when AI features are disabled (#56936)

Anthony Gregis24c5b37e6e49
diff --git a/crates/zed/src/zed.rs b/crates/zed/src/zed.rs
index 22ba7cee3d4..69fc69d5469 100644
--- a/crates/zed/src/zed.rs
+++ b/crates/zed/src/zed.rs
@@ -2037,19 +2037,23 @@ pub fn handle_keymap_file_changes(
let mut old_base_keymap = *BaseKeymap::get_global(cx);
let mut old_vim_enabled = VimModeSetting::get_global(cx).0;
let mut old_helix_enabled = vim_mode_setting::HelixModeSetting::get_global(cx).0;
+ let mut old_disable_ai = DisableAiSettings::get_global(cx).disable_ai;
cx.observe_global::<SettingsStore>(move |cx| {
let new_base_keymap = *BaseKeymap::get_global(cx);
let new_vim_enabled = VimModeSetting::get_global(cx).0;
let new_helix_enabled = vim_mode_setting::HelixModeSetting::get_global(cx).0;
+ let new_disable_ai = DisableAiSettings::get_global(cx).disable_ai;
if new_base_keymap != old_base_keymap
|| new_vim_enabled != old_vim_enabled
|| new_helix_enabled != old_helix_enabled
+ || new_disable_ai != old_disable_ai
{
old_base_keymap = new_base_keymap;
old_vim_enabled = new_vim_enabled;
old_helix_enabled = new_helix_enabled;
+ old_disable_ai = new_disable_ai;
base_keymap_tx.unbounded_send(()).unwrap();
}
@@ -2218,7 +2222,7 @@ fn reload_keymaps(cx: &mut App, mut user_key_bindings: Vec<KeyBinding>) {
for key_binding in &mut user_key_bindings {
key_binding.set_meta(KeybindSource::User.meta());
}
- cx.bind_keys(user_key_bindings);
+ cx.bind_keys(filter_disabled_ai_bindings(user_key_bindings, cx));
let menus = app_menus(cx);
cx.set_menus(menus);
@@ -2238,18 +2242,23 @@ pub fn load_default_keymap(cx: &mut App) {
return;
}
- cx.bind_keys(
+ cx.bind_keys(filter_disabled_ai_bindings(
KeymapFile::load_asset(DEFAULT_KEYMAP_PATH, Some(KeybindSource::Default), cx).unwrap(),
- );
+ cx,
+ ));
if let Some(asset_path) = base_keymap.asset_path() {
- cx.bind_keys(KeymapFile::load_asset(asset_path, Some(KeybindSource::Base), cx).unwrap());
+ cx.bind_keys(filter_disabled_ai_bindings(
+ KeymapFile::load_asset(asset_path, Some(KeybindSource::Base), cx).unwrap(),
+ cx,
+ ));
}
if VimModeSetting::get_global(cx).0 || vim_mode_setting::HelixModeSetting::get_global(cx).0 {
- cx.bind_keys(
+ cx.bind_keys(filter_disabled_ai_bindings(
KeymapFile::load_asset(VIM_KEYMAP_PATH, Some(KeybindSource::Vim), cx).unwrap(),
- );
+ cx,
+ ));
}
cx.bind_keys(
@@ -2262,6 +2271,37 @@ pub fn load_default_keymap(cx: &mut App) {
);
}
+/// Namespaces of actions that are part of an AI feature. When the user opts out
+/// of AI via the `disable_ai` setting, bindings to these actions are dropped so
+/// that lower-precedence editor defaults (e.g. `editor::NewlineBelow` for
+/// `ctrl-enter`) can fire instead of being shadowed by an action whose handler
+/// silently no-ops.
+const AI_ACTION_NAMESPACES: &[&str] = &[
+ "acp::",
+ "agent::",
+ "assistant::",
+ "edit_prediction::",
+ "inline_assistant::",
+ "zeta::",
+];
+
+fn is_ai_keybinding(binding: &KeyBinding) -> bool {
+ let name = binding.action().name();
+ AI_ACTION_NAMESPACES
+ .iter()
+ .any(|namespace| name.starts_with(namespace))
+}
+
+fn filter_disabled_ai_bindings(bindings: Vec<KeyBinding>, cx: &App) -> Vec<KeyBinding> {
+ if !DisableAiSettings::get_global(cx).disable_ai {
+ return bindings;
+ }
+ bindings
+ .into_iter()
+ .filter(|binding| !is_ai_keybinding(binding))
+ .collect()
+}
+
pub fn open_new_ssh_project_from_project(
workspace: &mut Workspace,
paths: Vec<PathBuf>,
@@ -5799,6 +5839,67 @@ mod tests {
// If this panics, the test has failed
}
+ #[gpui::test]
+ async fn test_disable_ai_filters_keybindings(cx: &mut gpui::TestAppContext) {
+ let _app_state = init_keymap_test(cx);
+
+ // With AI enabled, the default keymap should include the assistant
+ // bindings that intercept e.g. ctrl-enter in the editor.
+ cx.update(load_default_keymap);
+ cx.update(|cx| {
+ let keymap = cx.key_bindings();
+ let keymap = keymap.borrow();
+ let has_ai_binding = keymap.bindings().any(|binding| is_ai_keybinding(binding));
+ assert!(
+ has_ai_binding,
+ "expected AI-namespaced bindings in the default keymap before disabling AI"
+ );
+ });
+
+ cx.update(|cx| {
+ SettingsStore::update_global(cx, |settings_store, cx| {
+ settings_store.update_user_settings(cx, |settings| {
+ settings.project.disable_ai = Some(SaturatingBool(true));
+ });
+ });
+ });
+
+ // The default keymap should drop every AI-namespaced binding so that
+ // lower-precedence editor defaults can run instead.
+ cx.update(|cx| {
+ cx.clear_key_bindings();
+ load_default_keymap(cx);
+ });
+ cx.update(|cx| {
+ let keymap = cx.key_bindings();
+ let keymap = keymap.borrow();
+ if let Some(binding) = keymap.bindings().find(|b| is_ai_keybinding(b)) {
+ panic!(
+ "expected no AI-namespaced bindings after disabling AI, but found `{}`",
+ binding.action().name()
+ );
+ }
+ });
+
+ // User-defined bindings to AI actions should also be filtered.
+ let user_binding = KeyBinding::new(
+ "ctrl-enter",
+ zed_actions::assistant::InlineAssist { prompt: None },
+ None,
+ );
+ cx.update(|cx| reload_keymaps(cx, vec![user_binding]));
+ cx.update(|cx| {
+ let keymap = cx.key_bindings();
+ let keymap = keymap.borrow();
+ if let Some(binding) = keymap.bindings().find(|b| is_ai_keybinding(b)) {
+ panic!(
+ "expected user binding `{}` to be filtered when AI is disabled",
+ binding.action().name()
+ );
+ }
+ });
+ }
+
#[gpui::test]
async fn test_prefer_focused_window(cx: &mut gpui::TestAppContext) {
let app_state = init_test(cx);