<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-session/src/storage/redis_rs.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>redis_rs.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../actix_session/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../actix_session/index.html"><div class="logo-container"> <img src="https://actix.rs/img/logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../actix_session/index.html"> <img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span> <span id="2">2</span> <span id="3">3</span> <span id="4">4</span> <span id="5">5</span> <span id="6">6</span> <span id="7">7</span> <span id="8">8</span> <span id="9">9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> <span id="64">64</span> <span id="65">65</span> <span id="66">66</span> <span id="67">67</span> <span id="68">68</span> <span id="69">69</span> <span id="70">70</span> <span id="71">71</span> <span id="72">72</span> <span id="73">73</span> <span id="74">74</span> <span id="75">75</span> <span id="76">76</span> <span id="77">77</span> <span id="78">78</span> <span id="79">79</span> <span id="80">80</span> <span id="81">81</span> <span id="82">82</span> <span id="83">83</span> <span id="84">84</span> <span id="85">85</span> <span id="86">86</span> <span id="87">87</span> <span id="88">88</span> <span id="89">89</span> <span id="90">90</span> <span id="91">91</span> <span id="92">92</span> <span id="93">93</span> <span id="94">94</span> <span id="95">95</span> <span id="96">96</span> <span id="97">97</span> <span id="98">98</span> <span id="99">99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> <span id="103">103</span> <span id="104">104</span> <span id="105">105</span> <span id="106">106</span> <span id="107">107</span> <span id="108">108</span> <span id="109">109</span> <span id="110">110</span> <span id="111">111</span> <span id="112">112</span> <span id="113">113</span> <span id="114">114</span> <span id="115">115</span> <span id="116">116</span> <span id="117">117</span> <span id="118">118</span> <span id="119">119</span> <span id="120">120</span> <span id="121">121</span> <span id="122">122</span> <span id="123">123</span> <span id="124">124</span> <span id="125">125</span> <span id="126">126</span> <span id="127">127</span> <span id="128">128</span> <span id="129">129</span> <span id="130">130</span> <span id="131">131</span> <span id="132">132</span> <span id="133">133</span> <span id="134">134</span> <span id="135">135</span> <span id="136">136</span> <span id="137">137</span> <span id="138">138</span> <span id="139">139</span> <span id="140">140</span> <span id="141">141</span> <span id="142">142</span> <span id="143">143</span> <span id="144">144</span> <span id="145">145</span> <span id="146">146</span> <span id="147">147</span> <span id="148">148</span> <span id="149">149</span> <span id="150">150</span> <span id="151">151</span> <span id="152">152</span> <span id="153">153</span> <span id="154">154</span> <span id="155">155</span> <span id="156">156</span> <span id="157">157</span> <span id="158">158</span> <span id="159">159</span> <span id="160">160</span> <span id="161">161</span> <span id="162">162</span> <span id="163">163</span> <span id="164">164</span> <span id="165">165</span> <span id="166">166</span> <span id="167">167</span> <span id="168">168</span> <span id="169">169</span> <span id="170">170</span> <span id="171">171</span> <span id="172">172</span> <span id="173">173</span> <span id="174">174</span> <span id="175">175</span> <span id="176">176</span> <span id="177">177</span> <span id="178">178</span> <span id="179">179</span> <span id="180">180</span> <span id="181">181</span> <span id="182">182</span> <span id="183">183</span> <span id="184">184</span> <span id="185">185</span> <span id="186">186</span> <span id="187">187</span> <span id="188">188</span> <span id="189">189</span> <span id="190">190</span> <span id="191">191</span> <span id="192">192</span> <span id="193">193</span> <span id="194">194</span> <span id="195">195</span> <span id="196">196</span> <span id="197">197</span> <span id="198">198</span> <span id="199">199</span> <span id="200">200</span> <span id="201">201</span> <span id="202">202</span> <span id="203">203</span> <span id="204">204</span> <span id="205">205</span> <span id="206">206</span> <span id="207">207</span> <span id="208">208</span> <span id="209">209</span> <span id="210">210</span> <span id="211">211</span> <span id="212">212</span> <span id="213">213</span> <span id="214">214</span> <span id="215">215</span> <span id="216">216</span> <span id="217">217</span> <span id="218">218</span> <span id="219">219</span> <span id="220">220</span> <span id="221">221</span> <span id="222">222</span> <span id="223">223</span> <span id="224">224</span> <span id="225">225</span> <span id="226">226</span> <span id="227">227</span> <span id="228">228</span> <span id="229">229</span> <span id="230">230</span> <span id="231">231</span> <span id="232">232</span> <span id="233">233</span> <span id="234">234</span> <span id="235">235</span> <span id="236">236</span> <span id="237">237</span> <span id="238">238</span> <span id="239">239</span> <span id="240">240</span> <span id="241">241</span> <span id="242">242</span> <span id="243">243</span> <span id="244">244</span> <span id="245">245</span> <span id="246">246</span> <span id="247">247</span> <span id="248">248</span> <span id="249">249</span> <span id="250">250</span> <span id="251">251</span> <span id="252">252</span> <span id="253">253</span> <span id="254">254</span> <span id="255">255</span> <span id="256">256</span> <span id="257">257</span> <span id="258">258</span> <span id="259">259</span> <span id="260">260</span> <span id="261">261</span> <span id="262">262</span> <span id="263">263</span> <span id="264">264</span> <span id="265">265</span> <span id="266">266</span> <span id="267">267</span> <span id="268">268</span> <span id="269">269</span> <span id="270">270</span> <span id="271">271</span> <span id="272">272</span> <span id="273">273</span> <span id="274">274</span> <span id="275">275</span> <span id="276">276</span> <span id="277">277</span> <span id="278">278</span> <span id="279">279</span> <span id="280">280</span> <span id="281">281</span> <span id="282">282</span> <span id="283">283</span> <span id="284">284</span> <span id="285">285</span> <span id="286">286</span> <span id="287">287</span> <span id="288">288</span> <span id="289">289</span> <span id="290">290</span> <span id="291">291</span> <span id="292">292</span> <span id="293">293</span> <span id="294">294</span> <span id="295">295</span> <span id="296">296</span> <span id="297">297</span> <span id="298">298</span> <span id="299">299</span> <span id="300">300</span> <span id="301">301</span> <span id="302">302</span> <span id="303">303</span> <span id="304">304</span> <span id="305">305</span> <span id="306">306</span> <span id="307">307</span> <span id="308">308</span> <span id="309">309</span> <span id="310">310</span> <span id="311">311</span> <span id="312">312</span> <span id="313">313</span> <span id="314">314</span> <span id="315">315</span> <span id="316">316</span> <span id="317">317</span> <span id="318">318</span> <span id="319">319</span> <span id="320">320</span> <span id="321">321</span> <span id="322">322</span> <span id="323">323</span> <span id="324">324</span> <span id="325">325</span> <span id="326">326</span> <span id="327">327</span> <span id="328">328</span> <span id="329">329</span> <span id="330">330</span> <span id="331">331</span> <span id="332">332</span> <span id="333">333</span> <span id="334">334</span> <span id="335">335</span> <span id="336">336</span> <span id="337">337</span> <span id="338">338</span> <span id="339">339</span> <span id="340">340</span> <span id="341">341</span> <span id="342">342</span> <span id="343">343</span> <span id="344">344</span> <span id="345">345</span> <span id="346">346</span> <span id="347">347</span> </pre><pre class="rust"><code><span class="kw">use </span>std::{convert::TryInto, sync::Arc}; <span class="kw">use </span>actix_web::cookie::time::Duration; <span class="kw">use </span>anyhow::{Context, Error}; <span class="kw">use </span>redis::{aio::ConnectionManager, AsyncCommands, Cmd, FromRedisValue, RedisResult, Value}; <span class="kw">use </span><span class="kw">super</span>::SessionKey; <span class="kw">use </span><span class="kw">crate</span>::storage::{ interface::{LoadError, SaveError, SessionState, UpdateError}, utils::generate_session_key, SessionStore, }; <span class="doccomment">/// Use Redis as session storage backend. /// /// ```no_run /// use actix_web::{web, App, HttpServer, HttpResponse, Error}; /// use actix_session::{SessionMiddleware, storage::RedisSessionStore}; /// use actix_web::cookie::Key; /// /// // The secret key would usually be read from a configuration file/environment variables. /// fn get_secret_key() -> Key { /// # todo!() /// // [...] /// } /// /// #[actix_web::main] /// async fn main() -> std::io::Result<()> { /// let secret_key = get_secret_key(); /// let redis_connection_string = "redis://127.0.0.1:6379"; /// let store = RedisSessionStore::new(redis_connection_string).await.unwrap(); /// /// HttpServer::new(move || /// App::new() /// .wrap(SessionMiddleware::new( /// store.clone(), /// secret_key.clone() /// )) /// .default_service(web::to(|| HttpResponse::Ok()))) /// .bind(("127.0.0.1", 8080))? /// .run() /// .await /// } /// ``` /// /// # TLS support /// Add the `redis-rs-tls-session` feature flag to enable TLS support. You can then establish a TLS /// connection to Redis using the `rediss://` URL scheme: /// /// ```no_run /// use actix_session::{storage::RedisSessionStore}; /// /// # actix_web::rt::System::new().block_on(async { /// let redis_connection_string = "rediss://127.0.0.1:6379"; /// let store = RedisSessionStore::new(redis_connection_string).await.unwrap(); /// # }) /// ``` /// /// # Implementation notes /// `RedisSessionStore` leverages [`redis-rs`] as Redis client. /// /// [`redis-rs`]: https://github.com/mitsuhiko/redis-rs </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"redis-rs-session"</span>)))] #[derive(Clone)] </span><span class="kw">pub struct </span>RedisSessionStore { configuration: CacheConfiguration, client: ConnectionManager, } <span class="attribute">#[derive(Clone)] </span><span class="kw">struct </span>CacheConfiguration { cache_keygen: Arc<<span class="kw">dyn </span>Fn(<span class="kw-2">&</span>str) -> String + Send + Sync>, } <span class="kw">impl </span>Default <span class="kw">for </span>CacheConfiguration { <span class="kw">fn </span>default() -> <span class="self">Self </span>{ <span class="self">Self </span>{ cache_keygen: Arc::new(str::to_owned), } } } <span class="kw">impl </span>RedisSessionStore { <span class="doccomment">/// A fluent API to configure [`RedisSessionStore`]. /// It takes as input the only required input to create a new instance of [`RedisSessionStore`] - a /// connection string for Redis. </span><span class="kw">pub fn </span>builder<S: Into<String>>(connection_string: S) -> RedisSessionStoreBuilder { RedisSessionStoreBuilder { configuration: CacheConfiguration::default(), connection_string: connection_string.into(), } } <span class="doccomment">/// Create a new instance of [`RedisSessionStore`] using the default configuration. /// It takes as input the only required input to create a new instance of [`RedisSessionStore`] - a /// connection string for Redis. </span><span class="kw">pub async fn </span>new<S: Into<String>>( connection_string: S, ) -> <span class="prelude-ty">Result</span><RedisSessionStore, anyhow::Error> { <span class="self">Self</span>::builder(connection_string).build().<span class="kw">await </span>} } <span class="doccomment">/// A fluent builder to construct a [`RedisSessionStore`] instance with custom configuration /// parameters. /// /// [`RedisSessionStore`]: crate::storage::RedisSessionStore </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"redis-rs-session"</span>)))] #[must_use] </span><span class="kw">pub struct </span>RedisSessionStoreBuilder { connection_string: String, configuration: CacheConfiguration, } <span class="kw">impl </span>RedisSessionStoreBuilder { <span class="doccomment">/// Set a custom cache key generation strategy, expecting a session key as input. </span><span class="kw">pub fn </span>cache_keygen<F>(<span class="kw-2">mut </span><span class="self">self</span>, keygen: F) -> <span class="self">Self </span><span class="kw">where </span>F: Fn(<span class="kw-2">&</span>str) -> String + <span class="lifetime">'static </span>+ Send + Sync, { <span class="self">self</span>.configuration.cache_keygen = Arc::new(keygen); <span class="self">self </span>} <span class="doccomment">/// Finalise the builder and return a [`RedisActorSessionStore`] instance. /// /// [`RedisActorSessionStore`]: crate::storage::RedisActorSessionStore </span><span class="kw">pub async fn </span>build(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><RedisSessionStore, anyhow::Error> { <span class="kw">let </span>client = ConnectionManager::new(redis::Client::open(<span class="self">self</span>.connection_string)<span class="question-mark">?</span>).<span class="kw">await</span><span class="question-mark">?</span>; <span class="prelude-val">Ok</span>(RedisSessionStore { configuration: <span class="self">self</span>.configuration, client, }) } } <span class="attribute">#[async_trait::async_trait(<span class="question-mark">?</span>Send)] </span><span class="kw">impl </span>SessionStore <span class="kw">for </span>RedisSessionStore { <span class="kw">async fn </span>load(<span class="kw-2">&</span><span class="self">self</span>, session_key: <span class="kw-2">&</span>SessionKey) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><SessionState>, LoadError> { <span class="kw">let </span>cache_key = (<span class="self">self</span>.configuration.cache_keygen)(session_key.as_ref()); <span class="kw">let </span>value: <span class="prelude-ty">Option</span><String> = <span class="self">self </span>.execute_command(redis::cmd(<span class="string">"GET"</span>).arg(<span class="kw-2">&</span>[<span class="kw-2">&</span>cache_key])) .<span class="kw">await </span>.map_err(Into::into) .map_err(LoadError::Other)<span class="question-mark">?</span>; <span class="kw">match </span>value { <span class="prelude-val">None </span>=> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>), <span class="prelude-val">Some</span>(value) => <span class="prelude-val">Ok</span>(serde_json::from_str(<span class="kw-2">&</span>value) .map_err(Into::into) .map_err(LoadError::Deserialization)<span class="question-mark">?</span>), } } <span class="kw">async fn </span>save( <span class="kw-2">&</span><span class="self">self</span>, session_state: SessionState, ttl: <span class="kw-2">&</span>Duration, ) -> <span class="prelude-ty">Result</span><SessionKey, SaveError> { <span class="kw">let </span>body = serde_json::to_string(<span class="kw-2">&</span>session_state) .map_err(Into::into) .map_err(SaveError::Serialization)<span class="question-mark">?</span>; <span class="kw">let </span>session_key = generate_session_key(); <span class="kw">let </span>cache_key = (<span class="self">self</span>.configuration.cache_keygen)(session_key.as_ref()); <span class="self">self</span>.execute_command(redis::cmd(<span class="string">"SET"</span>).arg(<span class="kw-2">&</span>[ <span class="kw-2">&</span>cache_key, <span class="kw-2">&</span>body, <span class="string">"NX"</span>, <span class="comment">// NX: only set the key if it does not already exist </span><span class="string">"EX"</span>, <span class="comment">// EX: set expiry </span><span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{}"</span>, ttl.whole_seconds()), ])) .<span class="kw">await </span>.map_err(Into::into) .map_err(SaveError::Other)<span class="question-mark">?</span>; <span class="prelude-val">Ok</span>(session_key) } <span class="kw">async fn </span>update( <span class="kw-2">&</span><span class="self">self</span>, session_key: SessionKey, session_state: SessionState, ttl: <span class="kw-2">&</span>Duration, ) -> <span class="prelude-ty">Result</span><SessionKey, UpdateError> { <span class="kw">let </span>body = serde_json::to_string(<span class="kw-2">&</span>session_state) .map_err(Into::into) .map_err(UpdateError::Serialization)<span class="question-mark">?</span>; <span class="kw">let </span>cache_key = (<span class="self">self</span>.configuration.cache_keygen)(session_key.as_ref()); <span class="kw">let </span>v: redis::Value = <span class="self">self </span>.execute_command(redis::cmd(<span class="string">"SET"</span>).arg(<span class="kw-2">&</span>[ <span class="kw-2">&</span>cache_key, <span class="kw-2">&</span>body, <span class="string">"XX"</span>, <span class="comment">// XX: Only set the key if it already exist. </span><span class="string">"EX"</span>, <span class="comment">// EX: set expiry </span><span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{}"</span>, ttl.whole_seconds()), ])) .<span class="kw">await </span>.map_err(Into::into) .map_err(UpdateError::Other)<span class="question-mark">?</span>; <span class="kw">match </span>v { Value::Nil => { <span class="comment">// The SET operation was not performed because the XX condition was not verified. // This can happen if the session state expired between the load operation and the // update operation. Unlucky, to say the least. We fall back to the `save` routine // to ensure that the new key is unique. </span><span class="self">self</span>.save(session_state, ttl) .<span class="kw">await </span>.map_err(|err| <span class="kw">match </span>err { SaveError::Serialization(err) => UpdateError::Serialization(err), SaveError::Other(err) => UpdateError::Other(err), }) } Value::Int(<span class="kw">_</span>) | Value::Okay | Value::Status(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(session_key), val => <span class="prelude-val">Err</span>(UpdateError::Other(<span class="macro">anyhow::anyhow!</span>( <span class="string">"Failed to update session state. {:?}"</span>, val ))), } } <span class="kw">async fn </span>update_ttl(<span class="kw-2">&</span><span class="self">self</span>, session_key: <span class="kw-2">&</span>SessionKey, ttl: <span class="kw-2">&</span>Duration) -> <span class="prelude-ty">Result</span><(), Error> { <span class="kw">let </span>cache_key = (<span class="self">self</span>.configuration.cache_keygen)(session_key.as_ref()); <span class="self">self</span>.client .clone() .expire( <span class="kw-2">&</span>cache_key, ttl.whole_seconds().try_into().context( <span class="string">"Failed to convert the state TTL into the number of whole seconds remaining"</span>, )<span class="question-mark">?</span>, ) .<span class="kw">await</span><span class="question-mark">?</span>; <span class="prelude-val">Ok</span>(()) } <span class="kw">async fn </span>delete(<span class="kw-2">&</span><span class="self">self</span>, session_key: <span class="kw-2">&</span>SessionKey) -> <span class="prelude-ty">Result</span><(), anyhow::Error> { <span class="kw">let </span>cache_key = (<span class="self">self</span>.configuration.cache_keygen)(session_key.as_ref()); <span class="self">self</span>.execute_command(redis::cmd(<span class="string">"DEL"</span>).arg(<span class="kw-2">&</span>[<span class="kw-2">&</span>cache_key])) .<span class="kw">await </span>.map_err(Into::into) .map_err(UpdateError::Other)<span class="question-mark">?</span>; <span class="prelude-val">Ok</span>(()) } } <span class="kw">impl </span>RedisSessionStore { <span class="doccomment">/// Execute Redis command and retry once in certain cases. /// /// `ConnectionManager` automatically reconnects when it encounters an error talking to Redis. /// The request that bumped into the error, though, fails. /// /// This is generally OK, but there is an unpleasant edge case: Redis client timeouts. The /// server is configured to drop connections who have been active longer than a pre-determined /// threshold. `redis-rs` does not proactively detect that the connection has been dropped - you /// only find out when you try to use it. /// /// This helper method catches this case (`.is_connection_dropped`) to execute a retry. The /// retry will be executed on a fresh connection, therefore it is likely to succeed (or fail for /// a different more meaningful reason). </span><span class="kw">async fn </span>execute_command<T: FromRedisValue>(<span class="kw-2">&</span><span class="self">self</span>, cmd: <span class="kw-2">&mut </span>Cmd) -> RedisResult<T> { <span class="kw">let </span><span class="kw-2">mut </span>can_retry = <span class="bool-val">true</span>; <span class="kw">loop </span>{ <span class="kw">match </span>cmd.query_async(<span class="kw-2">&mut </span><span class="self">self</span>.client.clone()).<span class="kw">await </span>{ <span class="prelude-val">Ok</span>(value) => <span class="kw">return </span><span class="prelude-val">Ok</span>(value), <span class="prelude-val">Err</span>(err) => { <span class="kw">if </span>can_retry && err.is_connection_dropped() { <span class="macro">tracing::debug!</span>( <span class="string">"Connection dropped while trying to talk to Redis. Retrying." </span>); <span class="comment">// Retry at most once </span>can_retry = <span class="bool-val">false</span>; <span class="kw">continue</span>; } <span class="kw">else </span>{ <span class="kw">return </span><span class="prelude-val">Err</span>(err); } } } } } } <span class="attribute">#[cfg(test)] </span><span class="kw">mod </span>tests { <span class="kw">use </span>std::collections::HashMap; <span class="kw">use </span>actix_web::cookie::time; <span class="kw">use </span>redis::AsyncCommands; <span class="kw">use super</span>::<span class="kw-2">*</span>; <span class="kw">use </span><span class="kw">crate</span>::test_helpers::acceptance_test_suite; <span class="kw">async fn </span>redis_store() -> RedisSessionStore { RedisSessionStore::new(<span class="string">"redis://127.0.0.1:6379"</span>) .<span class="kw">await </span>.unwrap() } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>test_session_workflow() { <span class="kw">let </span>redis_store = redis_store().<span class="kw">await</span>; acceptance_test_suite(<span class="kw">move </span>|| redis_store.clone(), <span class="bool-val">true</span>).<span class="kw">await</span>; } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>loading_a_missing_session_returns_none() { <span class="kw">let </span>store = redis_store().<span class="kw">await</span>; <span class="kw">let </span>session_key = generate_session_key(); <span class="macro">assert!</span>(store.load(<span class="kw-2">&</span>session_key).<span class="kw">await</span>.unwrap().is_none()); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>loading_an_invalid_session_state_returns_deserialization_error() { <span class="kw">let </span>store = redis_store().<span class="kw">await</span>; <span class="kw">let </span>session_key = generate_session_key(); store .client .clone() .set::<<span class="kw">_</span>, <span class="kw">_</span>, ()>(session_key.as_ref(), <span class="string">"random-thing-which-is-not-json"</span>) .<span class="kw">await </span>.unwrap(); <span class="macro">assert!</span>(<span class="macro">matches!</span>( store.load(<span class="kw-2">&</span>session_key).<span class="kw">await</span>.unwrap_err(), LoadError::Deserialization(<span class="kw">_</span>), )); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>updating_of_an_expired_state_is_handled_gracefully() { <span class="kw">let </span>store = redis_store().<span class="kw">await</span>; <span class="kw">let </span>session_key = generate_session_key(); <span class="kw">let </span>initial_session_key = session_key.as_ref().to_owned(); <span class="kw">let </span>updated_session_key = store .update(session_key, HashMap::new(), <span class="kw-2">&</span>time::Duration::seconds(<span class="number">1</span>)) .<span class="kw">await </span>.unwrap(); <span class="macro">assert_ne!</span>(initial_session_key, updated_session_key.as_ref()); } } </code></pre></div> </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (1d37ed661 2022-09-09)" ></div></body></html>