1mod update_notification;
2
3use anyhow::{anyhow, Context, Result};
4use client::{Client, TelemetrySettings, ZED_APP_PATH, ZED_APP_VERSION};
5use db::kvp::KEY_VALUE_STORE;
6use db::RELEASE_CHANNEL;
7use gpui::{
8 actions, AppContext, AsyncAppContext, Context as _, Model, ModelContext, SemanticVersion, Task,
9 ViewContext, VisualContext, WindowContext,
10};
11use isahc::AsyncBody;
12
13use schemars::JsonSchema;
14use serde::Deserialize;
15use serde_derive::Serialize;
16use smol::io::AsyncReadExt;
17
18use settings::{Settings, SettingsStore};
19use smol::{fs::File, process::Command};
20
21use std::{ffi::OsString, sync::Arc, time::Duration};
22use update_notification::UpdateNotification;
23use util::channel::{AppCommitSha, ReleaseChannel};
24use util::http::HttpClient;
25use workspace::Workspace;
26
27const SHOULD_SHOW_UPDATE_NOTIFICATION_KEY: &str = "auto-updater-should-show-updated-notification";
28const POLL_INTERVAL: Duration = Duration::from_secs(60 * 60);
29
30actions!(auto_update, [Check, DismissErrorMessage, ViewReleaseNotes]);
31
32#[derive(Serialize)]
33struct UpdateRequestBody {
34 installation_id: Option<Arc<str>>,
35 release_channel: Option<&'static str>,
36 telemetry: bool,
37}
38
39#[derive(Clone, Copy, PartialEq, Eq)]
40pub enum AutoUpdateStatus {
41 Idle,
42 Checking,
43 Downloading,
44 Installing,
45 Updated,
46 Errored,
47}
48
49pub struct AutoUpdater {
50 status: AutoUpdateStatus,
51 current_version: SemanticVersion,
52 http_client: Arc<dyn HttpClient>,
53 pending_poll: Option<Task<Option<()>>>,
54 server_url: String,
55}
56
57#[derive(Deserialize)]
58struct JsonRelease {
59 version: String,
60 url: String,
61}
62
63struct AutoUpdateSetting(bool);
64
65/// Whether or not to automatically check for updates.
66///
67/// Default: true
68#[derive(Clone, Default, JsonSchema, Deserialize, Serialize)]
69#[serde(transparent)]
70struct AutoUpdateSettingOverride(Option<bool>);
71
72impl Settings for AutoUpdateSetting {
73 const KEY: Option<&'static str> = Some("auto_update");
74
75 type FileContent = AutoUpdateSettingOverride;
76
77 fn load(
78 default_value: &Self::FileContent,
79 user_values: &[&Self::FileContent],
80 _: &mut AppContext,
81 ) -> Result<Self> {
82 Ok(Self(
83 Self::json_merge(default_value, user_values)?
84 .0
85 .ok_or_else(Self::missing_default)?,
86 ))
87 }
88}
89
90pub fn init(http_client: Arc<dyn HttpClient>, server_url: String, cx: &mut AppContext) {
91 AutoUpdateSetting::register(cx);
92
93 cx.observe_new_views(|workspace: &mut Workspace, _cx| {
94 workspace.register_action(|_, action: &Check, cx| check(action, cx));
95
96 workspace.register_action(|_, action, cx| {
97 view_release_notes(action, cx);
98 });
99 })
100 .detach();
101
102 if let Some(version) = ZED_APP_VERSION.or_else(|| cx.app_metadata().app_version) {
103 let auto_updater = cx.new_model(|cx| {
104 let updater = AutoUpdater::new(version, http_client, server_url);
105
106 let mut update_subscription = AutoUpdateSetting::get_global(cx)
107 .0
108 .then(|| updater.start_polling(cx));
109
110 cx.observe_global::<SettingsStore>(move |updater, cx| {
111 if AutoUpdateSetting::get_global(cx).0 {
112 if update_subscription.is_none() {
113 update_subscription = Some(updater.start_polling(cx))
114 }
115 } else {
116 update_subscription.take();
117 }
118 })
119 .detach();
120
121 updater
122 });
123 cx.set_global(Some(auto_updater));
124 }
125}
126
127pub fn check(_: &Check, cx: &mut WindowContext) {
128 if let Some(updater) = AutoUpdater::get(cx) {
129 updater.update(cx, |updater, cx| updater.poll(cx));
130 } else {
131 drop(cx.prompt(
132 gpui::PromptLevel::Info,
133 "Auto-updates disabled for non-bundled app.",
134 &["Ok"],
135 ));
136 }
137}
138
139pub fn view_release_notes(_: &ViewReleaseNotes, cx: &mut AppContext) -> Option<()> {
140 let auto_updater = AutoUpdater::get(cx)?;
141 let release_channel = cx.try_global::<ReleaseChannel>()?;
142
143 if matches!(
144 release_channel,
145 ReleaseChannel::Stable | ReleaseChannel::Preview
146 ) {
147 let auto_updater = auto_updater.read(cx);
148 let server_url = &auto_updater.server_url;
149 let release_channel = release_channel.dev_name();
150 let current_version = auto_updater.current_version;
151 let url = format!("{server_url}/releases/{release_channel}/{current_version}");
152 cx.open_url(&url);
153 }
154
155 None
156}
157
158pub fn notify_of_any_new_update(cx: &mut ViewContext<Workspace>) -> Option<()> {
159 let updater = AutoUpdater::get(cx)?;
160 let version = updater.read(cx).current_version;
161 let should_show_notification = updater.read(cx).should_show_update_notification(cx);
162
163 cx.spawn(|workspace, mut cx| async move {
164 let should_show_notification = should_show_notification.await?;
165 if should_show_notification {
166 workspace.update(&mut cx, |workspace, cx| {
167 workspace.show_notification(0, cx, |cx| {
168 cx.new_view(|_| UpdateNotification::new(version))
169 });
170 updater
171 .read(cx)
172 .set_should_show_update_notification(false, cx)
173 .detach_and_log_err(cx);
174 })?;
175 }
176 anyhow::Ok(())
177 })
178 .detach();
179
180 None
181}
182
183impl AutoUpdater {
184 pub fn get(cx: &mut AppContext) -> Option<Model<Self>> {
185 cx.default_global::<Option<Model<Self>>>().clone()
186 }
187
188 fn new(
189 current_version: SemanticVersion,
190 http_client: Arc<dyn HttpClient>,
191 server_url: String,
192 ) -> Self {
193 Self {
194 status: AutoUpdateStatus::Idle,
195 current_version,
196 http_client,
197 server_url,
198 pending_poll: None,
199 }
200 }
201
202 pub fn start_polling(&self, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
203 cx.spawn(|this, mut cx| async move {
204 loop {
205 this.update(&mut cx, |this, cx| this.poll(cx))?;
206 cx.background_executor().timer(POLL_INTERVAL).await;
207 }
208 })
209 }
210
211 pub fn poll(&mut self, cx: &mut ModelContext<Self>) {
212 if self.pending_poll.is_some() || self.status == AutoUpdateStatus::Updated {
213 return;
214 }
215
216 self.status = AutoUpdateStatus::Checking;
217 cx.notify();
218
219 self.pending_poll = Some(cx.spawn(|this, mut cx| async move {
220 let result = Self::update(this.upgrade()?, cx.clone()).await;
221 this.update(&mut cx, |this, cx| {
222 this.pending_poll = None;
223 if let Err(error) = result {
224 log::error!("auto-update failed: error:{:?}", error);
225 this.status = AutoUpdateStatus::Errored;
226 cx.notify();
227 }
228 })
229 .ok()
230 }));
231 }
232
233 pub fn status(&self) -> AutoUpdateStatus {
234 self.status
235 }
236
237 pub fn dismiss_error(&mut self, cx: &mut ModelContext<Self>) {
238 self.status = AutoUpdateStatus::Idle;
239 cx.notify();
240 }
241
242 async fn update(this: Model<Self>, mut cx: AsyncAppContext) -> Result<()> {
243 let (client, server_url, current_version) = this.read_with(&cx, |this, _| {
244 (
245 this.http_client.clone(),
246 this.server_url.clone(),
247 this.current_version,
248 )
249 })?;
250
251 let mut url_string = format!("{server_url}/api/releases/latest?asset=Zed.dmg");
252 cx.update(|cx| {
253 if let Some(param) = cx
254 .try_global::<ReleaseChannel>()
255 .map(|release_channel| release_channel.release_query_param())
256 .flatten()
257 {
258 url_string += "&";
259 url_string += param;
260 }
261 })?;
262
263 let mut response = client.get(&url_string, Default::default(), true).await?;
264
265 let mut body = Vec::new();
266 response
267 .body_mut()
268 .read_to_end(&mut body)
269 .await
270 .context("error reading release")?;
271 let release: JsonRelease =
272 serde_json::from_slice(body.as_slice()).context("error deserializing release")?;
273
274 let should_download = match *RELEASE_CHANNEL {
275 ReleaseChannel::Nightly => cx
276 .try_read_global::<AppCommitSha, _>(|sha, _| release.version != sha.0)
277 .unwrap_or(true),
278 _ => release.version.parse::<SemanticVersion>()? > current_version,
279 };
280
281 if !should_download {
282 this.update(&mut cx, |this, cx| {
283 this.status = AutoUpdateStatus::Idle;
284 cx.notify();
285 })?;
286 return Ok(());
287 }
288
289 this.update(&mut cx, |this, cx| {
290 this.status = AutoUpdateStatus::Downloading;
291 cx.notify();
292 })?;
293
294 let temp_dir = tempdir::TempDir::new("zed-auto-update")?;
295 let dmg_path = temp_dir.path().join("Zed.dmg");
296 let mount_path = temp_dir.path().join("Zed");
297 let running_app_path = ZED_APP_PATH
298 .clone()
299 .map_or_else(|| cx.update(|cx| cx.app_path())?, Ok)?;
300 let running_app_filename = running_app_path
301 .file_name()
302 .ok_or_else(|| anyhow!("invalid running app path"))?;
303 let mut mounted_app_path: OsString = mount_path.join(running_app_filename).into();
304 mounted_app_path.push("/");
305
306 let mut dmg_file = File::create(&dmg_path).await?;
307
308 let (installation_id, release_channel, telemetry) = cx.update(|cx| {
309 let installation_id = cx.global::<Arc<Client>>().telemetry().installation_id();
310 let release_channel = cx
311 .try_global::<ReleaseChannel>()
312 .map(|release_channel| release_channel.display_name());
313 let telemetry = TelemetrySettings::get_global(cx).metrics;
314
315 (installation_id, release_channel, telemetry)
316 })?;
317
318 let request_body = AsyncBody::from(serde_json::to_string(&UpdateRequestBody {
319 installation_id,
320 release_channel,
321 telemetry,
322 })?);
323
324 let mut response = client.get(&release.url, request_body, true).await?;
325 smol::io::copy(response.body_mut(), &mut dmg_file).await?;
326 log::info!("downloaded update. path:{:?}", dmg_path);
327
328 this.update(&mut cx, |this, cx| {
329 this.status = AutoUpdateStatus::Installing;
330 cx.notify();
331 })?;
332
333 let output = Command::new("hdiutil")
334 .args(&["attach", "-nobrowse"])
335 .arg(&dmg_path)
336 .arg("-mountroot")
337 .arg(&temp_dir.path())
338 .output()
339 .await?;
340 if !output.status.success() {
341 Err(anyhow!(
342 "failed to mount: {:?}",
343 String::from_utf8_lossy(&output.stderr)
344 ))?;
345 }
346
347 let output = Command::new("rsync")
348 .args(&["-av", "--delete"])
349 .arg(&mounted_app_path)
350 .arg(&running_app_path)
351 .output()
352 .await?;
353 if !output.status.success() {
354 Err(anyhow!(
355 "failed to copy app: {:?}",
356 String::from_utf8_lossy(&output.stderr)
357 ))?;
358 }
359
360 let output = Command::new("hdiutil")
361 .args(&["detach"])
362 .arg(&mount_path)
363 .output()
364 .await?;
365 if !output.status.success() {
366 Err(anyhow!(
367 "failed to unmount: {:?}",
368 String::from_utf8_lossy(&output.stderr)
369 ))?;
370 }
371
372 this.update(&mut cx, |this, cx| {
373 this.set_should_show_update_notification(true, cx)
374 .detach_and_log_err(cx);
375 this.status = AutoUpdateStatus::Updated;
376 cx.notify();
377 })?;
378 Ok(())
379 }
380
381 fn set_should_show_update_notification(
382 &self,
383 should_show: bool,
384 cx: &AppContext,
385 ) -> Task<Result<()>> {
386 cx.background_executor().spawn(async move {
387 if should_show {
388 KEY_VALUE_STORE
389 .write_kvp(
390 SHOULD_SHOW_UPDATE_NOTIFICATION_KEY.to_string(),
391 "".to_string(),
392 )
393 .await?;
394 } else {
395 KEY_VALUE_STORE
396 .delete_kvp(SHOULD_SHOW_UPDATE_NOTIFICATION_KEY.to_string())
397 .await?;
398 }
399 Ok(())
400 })
401 }
402
403 fn should_show_update_notification(&self, cx: &AppContext) -> Task<Result<bool>> {
404 cx.background_executor().spawn(async move {
405 Ok(KEY_VALUE_STORE
406 .read_kvp(SHOULD_SHOW_UPDATE_NOTIFICATION_KEY)?
407 .is_some())
408 })
409 }
410}