fix(updater): format Update.date to RFC 3339

Author: Legend-Master

.changes/updater-date-format.md

@@ -0,0 +1,6 @@
+---
+"updater": "minor:bug"
+"updater-js": "minor:bug"
+---
+
+Fix JS API `Update.date` not formatted to RFC 3339

plugins/updater/api-iife.js

@@ -38,7 +38,6 @@ interface DownloadOptions {
 
 interface UpdateMetadata {
   rid: number
-  available: boolean
   currentVersion: string
   version: string
   date?: string
@@ -53,6 +52,7 @@ type DownloadEvent =
   | { event: 'Finished' }
 
 class Update extends Resource {
+  // TODO: remove this field in v3
   available: boolean
   currentVersion: string
   version: string
@@ -63,7 +63,7 @@ class Update extends Resource {
 
   constructor(metadata: UpdateMetadata) {
     super(metadata.rid)
-    this.available = metadata.available
+    this.available = true
     this.currentVersion = metadata.currentVersion
     this.version = metadata.version
     this.date = metadata.date
@@ -131,12 +131,10 @@ async function check(options?: CheckOptions): Promise<Update | null> {
     options.headers = Array.from(new Headers(options.headers).entries())
   }
 
-  return await invoke<UpdateMetadata>('plugin:updater|check', {
+  const metadata = await invoke<UpdateMetadata | null>('plugin:updater|check', {
     ...options
-  }).then((meta) =>
-    // TODO: Handle this in the rust side
-    meta.available ? new Update(meta) : null
-  )
+  })
+  return metadata ? new Update(metadata) : null
 }
 
 export type { CheckOptions, DownloadOptions, DownloadEvent }

plugins/updater/guest-js/index.ts

@@ -28,8 +28,7 @@ pub enum DownloadEvent {
 #[derive(Serialize, Default)]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct Metadata {
-    rid: Option<ResourceId>,
-    available: bool,
+    rid: ResourceId,
     current_version: String,
     version: String,
     date: Option<String>,
@@ -40,16 +39,14 @@ pub(crate) struct Metadata {
 struct DownloadedBytes(pub Vec<u8>);
 impl Resource for DownloadedBytes {}
 
-// TODO: Align this with the result of `updater.check` to Result<Option<Metadata>>
-// and remove `available` instead of handling this in the js side
 #[tauri::command]
 pub(crate) async fn check<R: Runtime>(
     webview: Webview<R>,
     headers: Option<Vec<(String, String)>>,
     timeout: Option<u64>,
     proxy: Option<String>,
     target: Option<String>,
-) -> Result<Metadata> {
+) -> Result<Option<Metadata>> {
     let mut builder = webview.updater_builder();
     if let Some(headers) = headers {
         for (k, v) in headers {
@@ -69,18 +66,29 @@ pub(crate) async fn check<R: Runtime>(
 
     let updater = builder.build()?;
     let update = updater.check().await?;
-    let mut metadata = Metadata::default();
+
     if let Some(update) = update {
-        metadata.available = true;
-        metadata.current_version.clone_from(&update.current_version);
-        metadata.version.clone_from(&update.version);
-        metadata.date = update.date.map(|d| d.to_string());
-        metadata.body.clone_from(&update.body);
-        metadata.raw_json.clone_from(&update.raw_json);
-        metadata.rid = Some(webview.resources_table().add(update));
+        let formatted_date = if let Some(date) = update.date {
+            let formatted_date = date
+                .format(&time::format_description::well_known::Rfc3339)
+                .map_err(|_| crate::Error::FormatDate)?
+                .to_string();
+            Some(formatted_date)
+        } else {
+            None
+        };
+        let metadata = Metadata {
+            current_version: update.current_version.clone(),
+            version: update.version.clone(),
+            date: formatted_date,
+            body: update.body.clone(),
+            raw_json: update.raw_json.clone(),
+            rid: webview.resources_table().add(update),
+        };
+        Ok(Some(metadata))
+    } else {
+        Ok(None)
     }
-
-    Ok(metadata)
 }
 
 #[tauri::command]

plugins/updater/src/commands.rs

@@ -77,6 +77,8 @@ pub enum Error {
     InvalidHeaderValue(#[from] http::header::InvalidHeaderValue),
     #[error(transparent)]
     InvalidHeaderName(#[from] http::header::InvalidHeaderName),
+    #[error("Failed to format date")]
+    FormatDate,
     /// The configured updater endpoint must use a secure protocol like `https`
     #[error("The configured updater endpoint must use a secure protocol like `https`.")]
     InsecureTransportProtocol,