feat(http): persist cookies on disk (#1978)

* enhance(http): persist cookies on disk

closes tauri-apps/tauri#11518

* clippy

* inline reqwest_cookie_store to fix clippy

* clippy

* Update .changes/persist-cookies.md

* Update plugins/http/src/reqwest_cookie_store.rs

* update example

* fallback to empty store if failed to load

* fix example

* persist cookies immediately

* clone

* lint

* .cookies filename

* prevent race condition

---------

Co-authored-by: Lucas Nogueira <lucas@tauri.app>

Committed via a GitHub action: https://github.com/tauri-apps/plugins-workspace/actions/runs/13897122532

Co-authored-by: lucasfernog <lucasfernog@users.noreply.github.com>

Cargo.toml

@@ -41,6 +41,8 @@ http = "1"
 reqwest = { version = "0.12", default-features = false }
 url = { workspace = true }
 data-url = "0.3"
+cookie_store = { version = "0.21.1", optional = true, features = ["serde"] }
+bytes = { version = "1.9", optional = true }
 tracing = { workspace = true, optional = true }
 
 [features]
@@ -62,7 +64,7 @@ rustls-tls-manual-roots = ["reqwest/rustls-tls-manual-roots"]
 rustls-tls-webpki-roots = ["reqwest/rustls-tls-webpki-roots"]
 rustls-tls-native-roots = ["reqwest/rustls-tls-native-roots"]
 blocking = ["reqwest/blocking"]
-cookies = ["reqwest/cookies"]
+cookies = ["reqwest/cookies", "dep:cookie_store", "dep:bytes"]
 gzip = ["reqwest/gzip"]
 brotli = ["reqwest/brotli"]
 deflate = ["reqwest/deflate"]

src/lib.rs

@@ -14,25 +14,72 @@ pub use error::{Error, Result};
 
 mod commands;
 mod error;
+#[cfg(feature = "cookies")]
+mod reqwest_cookie_store;
 mod scope;
 
+#[cfg(feature = "cookies")]
+const COOKIES_FILENAME: &str = ".cookies";
+
 pub(crate) struct Http {
     #[cfg(feature = "cookies")]
-    cookies_jar: std::sync::Arc<reqwest::cookie::Jar>,
+    cookies_jar: std::sync::Arc<crate::reqwest_cookie_store::CookieStoreMutex>,
 }
 
 pub fn init<R: Runtime>() -> TauriPlugin<R> {
     Builder::<R>::new("http")
         .setup(|app, _| {
+            #[cfg(feature = "cookies")]
+            let cookies_jar = {
+                use crate::reqwest_cookie_store::*;
+                use std::fs::File;
+                use std::io::BufReader;
+
+                let cache_dir = app.path().app_cache_dir()?;
+                std::fs::create_dir_all(&cache_dir)?;
+
+                let path = cache_dir.join(COOKIES_FILENAME);
+                let file = File::options()
+                    .create(true)
+                    .append(true)
+                    .read(true)
+                    .open(&path)?;
+
+                let reader = BufReader::new(file);
+                CookieStoreMutex::load(path.clone(), reader).unwrap_or_else(|_e| {
+                    #[cfg(feature = "tracing")]
+                    tracing::warn!(
+                        "failed to load cookie store: {_e}, falling back to empty store"
+                    );
+                    CookieStoreMutex::new(path, Default::default())
+                })
+            };
+
             let state = Http {
                 #[cfg(feature = "cookies")]
-                cookies_jar: std::sync::Arc::new(reqwest::cookie::Jar::default()),
+                cookies_jar: std::sync::Arc::new(cookies_jar),
             };
 
             app.manage(state);
 
             Ok(())
         })
+        .on_event(|app, event| {
+            #[cfg(feature = "cookies")]
+            if let tauri::RunEvent::Exit = event {
+                let state = app.state::<Http>();
+
+                match state.cookies_jar.request_save() {
+                    Ok(rx) => {
+                        let _ = rx.recv();
+                    }
+                    Err(_e) => {
+                        #[cfg(feature = "tracing")]
+                        tracing::error!("failed to save cookie jar: {_e}");
+                    }
+                }
+            }
+        })
         .invoke_handler(tauri::generate_handler![
             commands::fetch,
             commands::fetch_cancel,

src/reqwest_cookie_store.rs

@@ -0,0 +1,133 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+// taken from https://github.com/pfernie/reqwest_cookie_store/blob/2ec4afabcd55e24d3afe3f0626ee6dc97bed938d/src/lib.rs
+
+use std::{
+    path::PathBuf,
+    sync::{mpsc::Receiver, Mutex},
+};
+
+use cookie_store::{CookieStore, RawCookie, RawCookieParseError};
+use reqwest::header::HeaderValue;
+
+fn set_cookies(
+    cookie_store: &mut CookieStore,
+    cookie_headers: &mut dyn Iterator<Item = &HeaderValue>,
+    url: &url::Url,
+) {
+    let cookies = cookie_headers.filter_map(|val| {
+        std::str::from_utf8(val.as_bytes())
+            .map_err(RawCookieParseError::from)
+            .and_then(RawCookie::parse)
+            .map(|c| c.into_owned())
+            .ok()
+    });
+    cookie_store.store_response_cookies(cookies, url);
+}
+
+fn cookies(cookie_store: &CookieStore, url: &url::Url) -> Option<HeaderValue> {
+    let s = cookie_store
+        .get_request_values(url)
+        .map(|(name, value)| format!("{}={}", name, value))
+        .collect::<Vec<_>>()
+        .join("; ");
+
+    if s.is_empty() {
+        return None;
+    }
+
+    HeaderValue::from_maybe_shared(bytes::Bytes::from(s)).ok()
+}
+
+/// A [`cookie_store::CookieStore`] wrapped internally by a [`std::sync::Mutex`], suitable for use in
+/// async/concurrent contexts.
+#[derive(Debug)]
+pub struct CookieStoreMutex {
+    pub path: PathBuf,
+    store: Mutex<CookieStore>,
+    save_task: Mutex<Option<CancellableTask>>,
+}
+
+impl CookieStoreMutex {
+    /// Create a new [`CookieStoreMutex`] from an existing [`cookie_store::CookieStore`].
+    pub fn new(path: PathBuf, cookie_store: CookieStore) -> CookieStoreMutex {
+        CookieStoreMutex {
+            path,
+            store: Mutex::new(cookie_store),
+            save_task: Default::default(),
+        }
+    }
+
+    pub fn load<R: std::io::BufRead>(
+        path: PathBuf,
+        reader: R,
+    ) -> cookie_store::Result<CookieStoreMutex> {
+        cookie_store::serde::load(reader, |c| serde_json::from_str(c))
+            .map(|store| CookieStoreMutex::new(path, store))
+    }
+
+    fn cookies_to_str(&self) -> Result<String, serde_json::Error> {
+        let mut cookies = Vec::new();
+        for cookie in self
+            .store
+            .lock()
+            .expect("poisoned cookie jar mutex")
+            .iter_unexpired()
+        {
+            if cookie.is_persistent() {
+                cookies.push(cookie.clone());
+            }
+        }
+        serde_json::to_string(&cookies)
+    }
+
+    pub fn request_save(&self) -> cookie_store::Result<Receiver<()>> {
+        let cookie_str = self.cookies_to_str()?;
+        let path = self.path.clone();
+        let (tx, rx) = std::sync::mpsc::channel();
+        let task = tauri::async_runtime::spawn(async move {
+            match tokio::fs::write(&path, &cookie_str).await {
+                Ok(()) => {
+                    let _ = tx.send(());
+                }
+                Err(_e) => {
+                    #[cfg(feature = "tracing")]
+                    tracing::error!("failed to save cookie jar: {_e}");
+                }
+            }
+        });
+        self.save_task
+            .lock()
+            .unwrap()
+            .replace(CancellableTask(task));
+        Ok(rx)
+    }
+}
+
+impl reqwest::cookie::CookieStore for CookieStoreMutex {
+    fn set_cookies(&self, cookie_headers: &mut dyn Iterator<Item = &HeaderValue>, url: &url::Url) {
+        set_cookies(&mut self.store.lock().unwrap(), cookie_headers, url);
+
+        // try to persist cookies immediately asynchronously
+        if let Err(_e) = self.request_save() {
+            #[cfg(feature = "tracing")]
+            tracing::error!("failed to save cookie jar: {_e}");
+        }
+    }
+
+    fn cookies(&self, url: &url::Url) -> Option<HeaderValue> {
+        let store = self.store.lock().unwrap();
+        cookies(&store, url)
+    }
+}
+
+#[derive(Debug)]
+struct CancellableTask(tauri::async_runtime::JoinHandle<()>);
+
+impl Drop for CancellableTask {
+    fn drop(&mut self) {
+        self.0.abort();
+    }
+}