feature_flags.rs

  1use futures::channel::oneshot;
  2use futures::{FutureExt, select_biased};
  3use gpui::{App, Context, Global, Subscription, Task, Window};
  4use std::cell::RefCell;
  5use std::rc::Rc;
  6use std::sync::LazyLock;
  7use std::time::Duration;
  8use std::{future::Future, pin::Pin, task::Poll};
  9
 10#[derive(Default)]
 11struct FeatureFlags {
 12    flags: Vec<String>,
 13    staff: bool,
 14}
 15
 16pub static ZED_DISABLE_STAFF: LazyLock<bool> = LazyLock::new(|| {
 17    std::env::var("ZED_DISABLE_STAFF").map_or(false, |value| !value.is_empty() && value != "0")
 18});
 19
 20impl FeatureFlags {
 21    fn has_flag<T: FeatureFlag>(&self) -> bool {
 22        if T::enabled_for_all() {
 23            return true;
 24        }
 25
 26        if self.staff && T::enabled_for_staff() {
 27            return true;
 28        }
 29
 30        self.flags.iter().any(|f| f.as_str() == T::NAME)
 31    }
 32}
 33
 34impl Global for FeatureFlags {}
 35
 36/// To create a feature flag, implement this trait on a trivial type and use it as
 37/// a generic parameter when called [`FeatureFlagAppExt::has_flag`].
 38///
 39/// Feature flags are enabled for members of Zed staff by default. To disable this behavior
 40/// so you can test flags being disabled, set ZED_DISABLE_STAFF=1 in your environment,
 41/// which will force Zed to treat the current user as non-staff.
 42pub trait FeatureFlag {
 43    const NAME: &'static str;
 44
 45    /// Returns whether this feature flag is enabled for Zed staff.
 46    fn enabled_for_staff() -> bool {
 47        true
 48    }
 49
 50    /// Returns whether this feature flag is enabled for everyone.
 51    ///
 52    /// This is generally done on the server, but we provide this as a way to entirely enable a feature flag client-side
 53    /// without needing to remove all of the call sites.
 54    fn enabled_for_all() -> bool {
 55        false
 56    }
 57}
 58
 59pub struct PredictEditsRateCompletionsFeatureFlag;
 60impl FeatureFlag for PredictEditsRateCompletionsFeatureFlag {
 61    const NAME: &'static str = "predict-edits-rate-completions";
 62}
 63
 64pub struct LlmClosedBetaFeatureFlag {}
 65impl FeatureFlag for LlmClosedBetaFeatureFlag {
 66    const NAME: &'static str = "llm-closed-beta";
 67}
 68
 69pub struct ZedProFeatureFlag {}
 70impl FeatureFlag for ZedProFeatureFlag {
 71    const NAME: &'static str = "zed-pro";
 72}
 73
 74pub struct NotebookFeatureFlag;
 75
 76impl FeatureFlag for NotebookFeatureFlag {
 77    const NAME: &'static str = "notebooks";
 78}
 79
 80pub struct ThreadAutoCaptureFeatureFlag {}
 81impl FeatureFlag for ThreadAutoCaptureFeatureFlag {
 82    const NAME: &'static str = "thread-auto-capture";
 83
 84    fn enabled_for_staff() -> bool {
 85        false
 86    }
 87}
 88pub struct PanicFeatureFlag;
 89
 90impl FeatureFlag for PanicFeatureFlag {
 91    const NAME: &'static str = "panic";
 92}
 93
 94pub struct JjUiFeatureFlag {}
 95
 96impl FeatureFlag for JjUiFeatureFlag {
 97    const NAME: &'static str = "jj-ui";
 98}
 99
100pub struct AcpFeatureFlag;
101
102impl FeatureFlag for AcpFeatureFlag {
103    const NAME: &'static str = "acp";
104}
105
106pub trait FeatureFlagViewExt<V: 'static> {
107    fn observe_flag<T: FeatureFlag, F>(&mut self, window: &Window, callback: F) -> Subscription
108    where
109        F: Fn(bool, &mut V, &mut Window, &mut Context<V>) + Send + Sync + 'static;
110
111    fn when_flag_enabled<T: FeatureFlag>(
112        &mut self,
113        window: &mut Window,
114        callback: impl Fn(&mut V, &mut Window, &mut Context<V>) + Send + Sync + 'static,
115    );
116}
117
118impl<V> FeatureFlagViewExt<V> for Context<'_, V>
119where
120    V: 'static,
121{
122    fn observe_flag<T: FeatureFlag, F>(&mut self, window: &Window, callback: F) -> Subscription
123    where
124        F: Fn(bool, &mut V, &mut Window, &mut Context<V>) + 'static,
125    {
126        self.observe_global_in::<FeatureFlags>(window, move |v, window, cx| {
127            let feature_flags = cx.global::<FeatureFlags>();
128            callback(feature_flags.has_flag::<T>(), v, window, cx);
129        })
130    }
131
132    fn when_flag_enabled<T: FeatureFlag>(
133        &mut self,
134        window: &mut Window,
135        callback: impl Fn(&mut V, &mut Window, &mut Context<V>) + Send + Sync + 'static,
136    ) {
137        if self
138            .try_global::<FeatureFlags>()
139            .is_some_and(|f| f.has_flag::<T>())
140        {
141            self.defer_in(window, move |view, window, cx| {
142                callback(view, window, cx);
143            });
144            return;
145        }
146        let subscription = Rc::new(RefCell::new(None));
147        let inner = self.observe_global_in::<FeatureFlags>(window, {
148            let subscription = subscription.clone();
149            move |v, window, cx| {
150                let feature_flags = cx.global::<FeatureFlags>();
151                if feature_flags.has_flag::<T>() {
152                    callback(v, window, cx);
153                    subscription.take();
154                }
155            }
156        });
157        subscription.borrow_mut().replace(inner);
158    }
159}
160
161pub trait FeatureFlagAppExt {
162    fn wait_for_flag<T: FeatureFlag>(&mut self) -> WaitForFlag;
163
164    /// Waits for the specified feature flag to resolve, up to the given timeout.
165    fn wait_for_flag_or_timeout<T: FeatureFlag>(&mut self, timeout: Duration) -> Task<bool>;
166
167    fn update_flags(&mut self, staff: bool, flags: Vec<String>);
168    fn set_staff(&mut self, staff: bool);
169    fn has_flag<T: FeatureFlag>(&self) -> bool;
170    fn is_staff(&self) -> bool;
171
172    fn observe_flag<T: FeatureFlag, F>(&mut self, callback: F) -> Subscription
173    where
174        F: FnMut(bool, &mut App) + 'static;
175}
176
177impl FeatureFlagAppExt for App {
178    fn update_flags(&mut self, staff: bool, flags: Vec<String>) {
179        let feature_flags = self.default_global::<FeatureFlags>();
180        feature_flags.staff = staff;
181        feature_flags.flags = flags;
182    }
183
184    fn set_staff(&mut self, staff: bool) {
185        let feature_flags = self.default_global::<FeatureFlags>();
186        feature_flags.staff = staff;
187    }
188
189    fn has_flag<T: FeatureFlag>(&self) -> bool {
190        self.try_global::<FeatureFlags>()
191            .map(|flags| flags.has_flag::<T>())
192            .unwrap_or(false)
193    }
194
195    fn is_staff(&self) -> bool {
196        self.try_global::<FeatureFlags>()
197            .map(|flags| flags.staff)
198            .unwrap_or(false)
199    }
200
201    fn observe_flag<T: FeatureFlag, F>(&mut self, mut callback: F) -> Subscription
202    where
203        F: FnMut(bool, &mut App) + 'static,
204    {
205        self.observe_global::<FeatureFlags>(move |cx| {
206            let feature_flags = cx.global::<FeatureFlags>();
207            callback(feature_flags.has_flag::<T>(), cx);
208        })
209    }
210
211    fn wait_for_flag<T: FeatureFlag>(&mut self) -> WaitForFlag {
212        let (tx, rx) = oneshot::channel::<bool>();
213        let mut tx = Some(tx);
214        let subscription: Option<Subscription>;
215
216        match self.try_global::<FeatureFlags>() {
217            Some(feature_flags) => {
218                subscription = None;
219                tx.take().unwrap().send(feature_flags.has_flag::<T>()).ok();
220            }
221            None => {
222                subscription = Some(self.observe_global::<FeatureFlags>(move |cx| {
223                    let feature_flags = cx.global::<FeatureFlags>();
224                    if let Some(tx) = tx.take() {
225                        tx.send(feature_flags.has_flag::<T>()).ok();
226                    }
227                }));
228            }
229        }
230
231        WaitForFlag(rx, subscription)
232    }
233
234    fn wait_for_flag_or_timeout<T: FeatureFlag>(&mut self, timeout: Duration) -> Task<bool> {
235        let wait_for_flag = self.wait_for_flag::<T>();
236
237        self.spawn(async move |_cx| {
238            let mut wait_for_flag = wait_for_flag.fuse();
239            let mut timeout = FutureExt::fuse(smol::Timer::after(timeout));
240
241            select_biased! {
242                is_enabled = wait_for_flag => is_enabled,
243                _ = timeout => false,
244            }
245        })
246    }
247}
248
249pub struct WaitForFlag(oneshot::Receiver<bool>, Option<Subscription>);
250
251impl Future for WaitForFlag {
252    type Output = bool;
253
254    fn poll(mut self: Pin<&mut Self>, cx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
255        self.0.poll_unpin(cx).map(|result| {
256            self.1.take();
257            result.unwrap_or(false)
258        })
259    }
260}