Introduces the FromQuery and IntoQuery traits.

These two traits are introduced to allow for customizing the query encoding and decoding behaviour by implementing these traits for custom types. The previous behaviour of using serde_urlencoded for anything that implements Serialize and Deserialize is preserved. Customt wrapper types are added which modify the encoding and decoding behaviour. An optional feature named `query-qs` is introduced which allows for optionally encoding and decoding query strings using serde_qs.
rustwasm · Aug 8, 2023 · cc2faf0 · cc2faf0
1 parent f5f963a
commit cc2faf0
Show file tree

Hide file tree

Showing 11 changed files with 283 additions and 114 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,8 @@
 ### Next Version
 
 - Migrate to Edition 2021 and Apply MSRV in Cargo.toml (#360)
+- Introduces the `FromQuery` and `IntoQuery` traits to allow for customizing
+  how query strings are encoded and decoded in `gloo_history`.
 
 ### Version "0.2.3"
 

diff --git a/crates/history/src/any.rs b/crates/history/src/any.rs
@@ -1,16 +1,12 @@
 use std::borrow::Cow;
 
 #[cfg(feature = "query")]
-use serde::Serialize;
+use crate::{error::HistoryResult, query::IntoQuery};
 
-use crate::browser::BrowserHistory;
-#[cfg(feature = "query")]
-use crate::error::HistoryResult;
-use crate::hash::HashHistory;
-use crate::history::History;
-use crate::listener::HistoryListener;
-use crate::location::Location;
-use crate::memory::MemoryHistory;
+use crate::{
+    browser::BrowserHistory, hash::HashHistory, history::History, listener::HistoryListener,
+    location::Location, memory::MemoryHistory,
+};
 
 /// A [`History`] that provides a universal API to the underlying history type.
 #[derive(Clone, PartialEq, Debug)]
@@ -79,9 +75,13 @@ impl History for AnyHistory {
     }
 
     #[cfg(feature = "query")]
-    fn push_with_query<'a, Q>(&self, route: impl Into<Cow<'a, str>>, query: Q) -> HistoryResult<()>
+    fn push_with_query<'a, Q>(
+        &self,
+        route: impl Into<Cow<'a, str>>,
+        query: Q,
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
         match self {
             Self::Browser(m) => m.push_with_query(route, query),
@@ -94,9 +94,9 @@ impl History for AnyHistory {
         &self,
         route: impl Into<Cow<'a, str>>,
         query: Q,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
         match self {
             Self::Browser(m) => m.replace_with_query(route, query),
@@ -111,9 +111,9 @@ impl History for AnyHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         match self {
@@ -129,9 +129,9 @@ impl History for AnyHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         match self {

diff --git a/crates/history/src/browser.rs b/crates/history/src/browser.rs
@@ -1,23 +1,19 @@
-use std::any::Any;
-use std::borrow::Cow;
-use std::cell::RefCell;
-use std::fmt;
-use std::rc::Rc;
+use std::{any::Any, borrow::Cow, cell::RefCell, fmt, rc::Rc};
 
 use gloo_events::EventListener;
 use gloo_utils::window;
-#[cfg(feature = "query")]
-use serde::Serialize;
 use wasm_bindgen::{JsValue, UnwrapThrowExt};
 use web_sys::Url;
 
 #[cfg(feature = "query")]
-use crate::error::HistoryResult;
-use crate::history::History;
-use crate::listener::HistoryListener;
-use crate::location::Location;
-use crate::state::{HistoryState, StateMap};
-use crate::utils::WeakCallback;
+use crate::{error::HistoryResult, query::IntoQuery};
+use crate::{
+    history::History,
+    listener::HistoryListener,
+    location::Location,
+    state::{HistoryState, StateMap},
+    utils::WeakCallback,
+};
 
 /// A [`History`] that is implemented with [`web_sys::History`] that provides native browser
 /// history and state access.
@@ -109,12 +105,16 @@ impl History for BrowserHistory {
     }
 
     #[cfg(feature = "query")]
-    fn push_with_query<'a, Q>(&self, route: impl Into<Cow<'a, str>>, query: Q) -> HistoryResult<()>
+    fn push_with_query<'a, Q>(
+        &self,
+        route: impl Into<Cow<'a, str>>,
+        query: Q,
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
         let route = route.into();
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
 
         let url = Self::combine_url(&route, &query);
 
@@ -131,12 +131,12 @@ impl History for BrowserHistory {
         &self,
         route: impl Into<Cow<'a, str>>,
         query: Q,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
         let route = route.into();
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
 
         let url = Self::combine_url(&route, &query);
 
@@ -154,9 +154,9 @@ impl History for BrowserHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         let (id, history_state) = Self::create_history_state();
@@ -165,7 +165,7 @@ impl History for BrowserHistory {
         states.insert(id, Rc::new(state) as Rc<dyn Any>);
 
         let route = route.into();
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
 
         let url = Self::combine_url(&route, &query);
 
@@ -184,9 +184,9 @@ impl History for BrowserHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         let (id, history_state) = Self::create_history_state();
@@ -195,7 +195,7 @@ impl History for BrowserHistory {
         states.insert(id, Rc::new(state) as Rc<dyn Any>);
 
         let route = route.into();
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
 
         let url = Self::combine_url(&route, &query);
 

diff --git a/crates/history/src/error.rs b/crates/history/src/error.rs
@@ -14,4 +14,4 @@ pub enum HistoryError {
 }
 
 /// The Result type for History.
-pub type HistoryResult<T> = std::result::Result<T, HistoryError>;
+pub type HistoryResult<T, E = HistoryError> = std::result::Result<T, E>;
diff --git a/crates/history/src/hash.rs b/crates/history/src/hash.rs
@@ -1,19 +1,19 @@
-use std::borrow::Cow;
-use std::fmt;
+use std::{borrow::Cow, fmt};
 
 use gloo_utils::window;
-#[cfg(feature = "query")]
-use serde::Serialize;
 use wasm_bindgen::UnwrapThrowExt;
 use web_sys::Url;
 
-use crate::browser::BrowserHistory;
 #[cfg(feature = "query")]
-use crate::error::HistoryResult;
-use crate::history::History;
-use crate::listener::HistoryListener;
-use crate::location::Location;
-use crate::utils::{assert_absolute_path, assert_no_query};
+use crate::{error::HistoryResult, query::IntoQuery};
+
+use crate::{
+    browser::BrowserHistory,
+    history::History,
+    listener::HistoryListener,
+    location::Location,
+    utils::{assert_absolute_path, assert_no_query},
+};
 
 /// A [`History`] that is implemented with [`web_sys::History`] and stores path in `#`(fragment).
 ///
@@ -95,11 +95,15 @@ impl History for HashHistory {
     }
 
     #[cfg(feature = "query")]
-    fn push_with_query<'a, Q>(&self, route: impl Into<Cow<'a, str>>, query: Q) -> HistoryResult<()>
+    fn push_with_query<'a, Q>(
+        &self,
+        route: impl Into<Cow<'a, str>>,
+        query: Q,
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
         let route = route.into();
 
         assert_absolute_path(&route);
@@ -116,11 +120,11 @@ impl History for HashHistory {
         &self,
         route: impl Into<Cow<'a, str>>,
         query: Q,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
     {
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
         let route = route.into();
 
         assert_absolute_path(&route);
@@ -139,9 +143,9 @@ impl History for HashHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         let route = route.into();
@@ -151,7 +155,7 @@ impl History for HashHistory {
 
         let url = Self::get_url();
 
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
         url.set_hash(&format!("{route}?{query}"));
 
         self.inner.push_with_state(url.href(), state);
@@ -165,9 +169,9 @@ impl History for HashHistory {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static,
     {
         let route = route.into();
@@ -177,7 +181,7 @@ impl History for HashHistory {
 
         let url = Self::get_url();
 
-        let query = serde_urlencoded::to_string(query)?;
+        let query = query.encode()?;
         url.set_hash(&format!("{route}?{query}"));
 
         self.inner.replace_with_state(url.href(), state);

diff --git a/crates/history/src/history.rs b/crates/history/src/history.rs
@@ -1,12 +1,8 @@
 use std::borrow::Cow;
 
 #[cfg(feature = "query")]
-use serde::Serialize;
-
-#[cfg(feature = "query")]
-use crate::error::HistoryResult;
-use crate::listener::HistoryListener;
-use crate::location::Location;
+use crate::{error::HistoryResult, query::IntoQuery};
+use crate::{listener::HistoryListener, location::Location};
 
 /// A trait to provide [`History`] access.
 ///
@@ -56,19 +52,23 @@ pub trait History: Clone + PartialEq {
 
     /// Same as `.push()` but affix the queries to the end of the route.
     #[cfg(feature = "query")]
-    fn push_with_query<'a, Q>(&self, route: impl Into<Cow<'a, str>>, query: Q) -> HistoryResult<()>
+    fn push_with_query<'a, Q>(
+        &self,
+        route: impl Into<Cow<'a, str>>,
+        query: Q,
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize;
+        Q: IntoQuery;
 
     /// Same as `.replace()` but affix the queries to the end of the route.
     #[cfg(feature = "query")]
     fn replace_with_query<'a, Q>(
         &self,
         route: impl Into<Cow<'a, str>>,
         query: Q,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize;
+        Q: IntoQuery;
 
     /// Same as `.push_with_state()` but affix the queries to the end of the route.
     #[cfg(feature = "query")]
@@ -77,9 +77,9 @@ pub trait History: Clone + PartialEq {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static;
 
     /// Same as `.replace_with_state()` but affix the queries to the end of the route.
@@ -89,9 +89,9 @@ pub trait History: Clone + PartialEq {
         route: impl Into<Cow<'a, str>>,
         query: Q,
         state: T,
-    ) -> HistoryResult<()>
+    ) -> HistoryResult<(), Q::Error>
     where
-        Q: Serialize,
+        Q: IntoQuery,
         T: 'static;
 
     /// Creates a Listener that will be notified when current state changes.

diff --git a/crates/history/src/lib.rs b/crates/history/src/lib.rs
@@ -12,6 +12,8 @@ mod history;
 mod listener;
 mod location;
 mod memory;
+#[cfg(feature = "query")]
+pub mod query;
 mod state;
 mod utils;