Refactor staff mode into a seperate crate and make copilot initialization wait for the staff mode flag to be flipped

Mikayla Maki created

Change summary

Cargo.lock                                  | 12 +++++
Cargo.toml                                  |  1 
crates/client/Cargo.toml                    |  1 
crates/client/src/user.rs                   |  3 
crates/copilot/Cargo.toml                   |  1 
crates/copilot/src/copilot.rs               | 50 +++++++++++++++-------
crates/staff_mode/Cargo.toml                | 12 +++++
crates/staff_mode/src/staff_mode.rs         | 30 +++++++++++++
crates/theme_selector/Cargo.toml            |  1 
crates/theme_selector/src/theme_selector.rs |  2 
crates/util/src/util.rs                     | 11 -----
crates/zed/Cargo.toml                       |  1 
crates/zed/src/languages/json.rs            |  3 
crates/zed/src/main.rs                      |  4 
14 files changed, 100 insertions(+), 32 deletions(-)

Detailed changes

Cargo.lock 🔗

@@ -1124,6 +1124,7 @@ dependencies = [
  "serde_derive",
  "settings",
  "smol",
+ "staff_mode",
  "sum_tree",
  "tempfile",
  "thiserror",
@@ -1352,6 +1353,7 @@ dependencies = [
  "serde_derive",
  "settings",
  "smol",
+ "staff_mode",
  "theme",
  "util",
  "workspace",
@@ -6360,6 +6362,14 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3"
 
+[[package]]
+name = "staff_mode"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "gpui",
+]
+
 [[package]]
 name = "static_assertions"
 version = "1.1.0"
@@ -6678,6 +6688,7 @@ dependencies = [
  "postage",
  "settings",
  "smol",
+ "staff_mode",
  "theme",
  "util",
  "workspace",
@@ -8578,6 +8589,7 @@ dependencies = [
  "simplelog",
  "smallvec",
  "smol",
+ "staff_mode",
  "sum_tree",
  "tempdir",
  "terminal_view",

Cargo.toml 🔗

@@ -54,6 +54,7 @@ members = [
     "crates/snippet",
     "crates/sqlez",
     "crates/sqlez_macros",
+    "crates/staff_mode",
     "crates/sum_tree",
     "crates/terminal",
     "crates/text",

crates/client/Cargo.toml 🔗

@@ -17,6 +17,7 @@ db = { path = "../db" }
 gpui = { path = "../gpui" }
 util = { path = "../util" }
 rpc = { path = "../rpc" }
+staff_mode = { path = "../staff_mode" }
 sum_tree = { path = "../sum_tree" }
 anyhow = "1.0.38"
 async-recursion = "0.3"

crates/client/src/user.rs 🔗

@@ -6,9 +6,10 @@ use gpui::{AsyncAppContext, Entity, ImageData, ModelContext, ModelHandle, Task};
 use postage::{sink::Sink, watch};
 use rpc::proto::{RequestMessage, UsersResponse};
 use settings::Settings;
+use staff_mode::StaffMode;
 use std::sync::{Arc, Weak};
 use util::http::HttpClient;
-use util::{StaffMode, TryFutureExt as _};
+use util::TryFutureExt as _;
 
 #[derive(Default, Debug)]
 pub struct User {

crates/copilot/Cargo.toml 🔗

@@ -15,6 +15,7 @@ gpui = { path = "../gpui" }
 language = { path = "../language" }
 settings = { path = "../settings" }
 theme = { path = "../theme" }
+staff_mode = { path = "../staff_mode" }
 lsp = { path = "../lsp" }
 node_runtime = { path = "../node_runtime"}
 util = { path = "../util" }

crates/copilot/src/copilot.rs 🔗

@@ -18,6 +18,8 @@ use node_runtime::NodeRuntime;
 use request::{LogMessage, StatusNotification};
 use settings::Settings;
 use smol::{fs, io::BufReader, stream::StreamExt};
+use staff_mode::staff_mode;
+
 use std::{
     ffi::OsString,
     ops::Range,
@@ -35,28 +37,46 @@ const COPILOT_NAMESPACE: &'static str = "copilot";
 actions!(copilot, [NextSuggestion, PreviousSuggestion, Reinstall]);
 
 pub fn init(client: Arc<Client>, node_runtime: Arc<NodeRuntime>, cx: &mut MutableAppContext) {
-    let copilot = cx.add_model(|cx| Copilot::start(client.http_client(), node_runtime, cx));
-    cx.set_global(copilot.clone());
+    staff_mode(cx, {
+        move |cx| {
+            let copilot = cx.add_model({
+                let node_runtime = node_runtime.clone();
+                let http = client.http_client().clone();
+                move |cx| Copilot::start(http, node_runtime, cx)
+            });
+            cx.set_global(copilot.clone());
+
+            observe_namespaces(cx, copilot);
+
+            sign_in::init(cx);
+        }
+    });
+
     cx.add_global_action(|_: &SignIn, cx| {
-        let copilot = Copilot::global(cx).unwrap();
-        copilot
-            .update(cx, |copilot, cx| copilot.sign_in(cx))
-            .detach_and_log_err(cx);
+        if let Some(copilot) = Copilot::global(cx) {
+            copilot
+                .update(cx, |copilot, cx| copilot.sign_in(cx))
+                .detach_and_log_err(cx);
+        }
     });
     cx.add_global_action(|_: &SignOut, cx| {
-        let copilot = Copilot::global(cx).unwrap();
-        copilot
-            .update(cx, |copilot, cx| copilot.sign_out(cx))
-            .detach_and_log_err(cx);
+        if let Some(copilot) = Copilot::global(cx) {
+            copilot
+                .update(cx, |copilot, cx| copilot.sign_out(cx))
+                .detach_and_log_err(cx);
+        }
     });
 
     cx.add_global_action(|_: &Reinstall, cx| {
-        let copilot = Copilot::global(cx).unwrap();
-        copilot
-            .update(cx, |copilot, cx| copilot.reinstall(cx))
-            .detach();
+        if let Some(copilot) = Copilot::global(cx) {
+            copilot
+                .update(cx, |copilot, cx| copilot.reinstall(cx))
+                .detach();
+        }
     });
+}
 
+fn observe_namespaces(cx: &mut MutableAppContext, copilot: ModelHandle<Copilot>) {
     cx.observe(&copilot, |handle, cx| {
         let status = handle.read(cx).status();
         cx.update_global::<collections::CommandPaletteFilter, _, _>(
@@ -77,8 +97,6 @@ pub fn init(client: Arc<Client>, node_runtime: Arc<NodeRuntime>, cx: &mut Mutabl
         );
     })
     .detach();
-
-    sign_in::init(cx);
 }
 
 enum CopilotServer {

crates/staff_mode/Cargo.toml 🔗

@@ -0,0 +1,12 @@
+[package]
+name = "staff_mode"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+path = "src/staff_mode.rs"
+
+[dependencies]
+gpui = { path = "../gpui" }
+anyhow = "1.0.38"

crates/staff_mode/src/staff_mode.rs 🔗

@@ -0,0 +1,30 @@
+use gpui::MutableAppContext;
+
+#[derive(Debug, Default)]
+pub struct StaffMode(pub bool);
+
+impl std::ops::Deref for StaffMode {
+    type Target = bool;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+/// Despite what the type system requires me to tell you, the init function will only ever be called once
+pub fn staff_mode<F: FnMut(&mut MutableAppContext) + 'static>(
+    cx: &mut MutableAppContext,
+    mut init: F,
+) {
+    if **cx.default_global::<StaffMode>() {
+        init(cx)
+    } else {
+        let mut once = Some(());
+        cx.observe_global::<StaffMode, _>(move |cx| {
+            if **cx.global::<StaffMode>() && once.take().is_some() {
+                init(cx);
+            }
+        })
+        .detach();
+    }
+}

crates/theme_selector/Cargo.toml 🔗

@@ -15,6 +15,7 @@ gpui = { path = "../gpui" }
 picker = { path = "../picker" }
 theme = { path = "../theme" }
 settings = { path = "../settings" }
+staff_mode = { path = "../staff_mode" }
 workspace = { path = "../workspace" }
 util = { path = "../util" }
 log = { version = "0.4.16", features = ["kv_unstable_serde"] }

crates/theme_selector/src/theme_selector.rs 🔗

@@ -7,7 +7,7 @@ use picker::{Picker, PickerDelegate};
 use settings::{settings_file::SettingsFile, Settings};
 use std::sync::Arc;
 use theme::{Theme, ThemeMeta, ThemeRegistry};
-use util::StaffMode;
+use staff_mode::StaffMode;
 use workspace::{AppState, Workspace};
 
 pub struct ThemeSelector {

crates/util/src/util.rs 🔗

@@ -17,17 +17,6 @@ pub use backtrace::Backtrace;
 use futures::Future;
 use rand::{seq::SliceRandom, Rng};
 
-#[derive(Debug, Default)]
-pub struct StaffMode(pub bool);
-
-impl std::ops::Deref for StaffMode {
-    type Target = bool;
-
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
 #[macro_export]
 macro_rules! debug_panic {
     ( $($fmt_arg:tt)* ) => {

crates/zed/Cargo.toml 🔗

@@ -55,6 +55,7 @@ project_symbols = { path = "../project_symbols" }
 recent_projects = { path = "../recent_projects" }
 rpc = { path = "../rpc" }
 settings = { path = "../settings" }
+staff_mode = { path = "../staff_mode" }
 sum_tree = { path = "../sum_tree" }
 text = { path = "../text" }
 terminal_view = { path = "../terminal_view" }

crates/zed/src/languages/json.rs 🔗

@@ -8,6 +8,7 @@ use node_runtime::NodeRuntime;
 use serde_json::json;
 use settings::{keymap_file_json_schema, settings_file_json_schema};
 use smol::fs;
+use staff_mode::StaffMode;
 use std::{
     any::Any,
     ffi::OsString,
@@ -17,7 +18,7 @@ use std::{
 };
 use theme::ThemeRegistry;
 use util::http::HttpClient;
-use util::{paths, ResultExt, StaffMode};
+use util::{paths, ResultExt};
 
 const SERVER_PATH: &'static str =
     "node_modules/vscode-json-languageserver/bin/vscode-json-languageserver";

crates/zed/src/main.rs 🔗

@@ -38,9 +38,9 @@ use welcome::{show_welcome_experience, FIRST_OPEN};
 
 use fs::RealFs;
 use settings::watched_json::WatchedJsonFile;
-use theme::ThemeRegistry;
 #[cfg(debug_assertions)]
-use util::StaffMode;
+use staff_mode::StaffMode;
+use theme::ThemeRegistry;
 use util::{channel::RELEASE_CHANNEL, paths, ResultExt, TryFutureExt};
 use workspace::{
     self, dock::FocusDock, item::ItemHandle, notifications::NotifyResultExt, AppState, NewFile,