mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 21:16:37 +02:00
634 lines
40 KiB
HTML
634 lines
40 KiB
HTML
<!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_actor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>redis_actor.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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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>
|
||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">actix::Addr</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_redis</span>::{<span class="ident">resp_array</span>, <span class="ident">Command</span>, <span class="ident">RedisActor</span>, <span class="ident">RespValue</span>};
|
||
<span class="kw">use</span> <span class="ident">actix_web::cookie::time::Duration</span>;
|
||
<span class="kw">use</span> <span class="ident">anyhow::Error</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::SessionKey</span>;
|
||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::storage</span>::{
|
||
<span class="ident">interface</span>::{<span class="ident">LoadError</span>, <span class="ident">SaveError</span>, <span class="ident">SessionState</span>, <span class="ident">UpdateError</span>},
|
||
<span class="ident">utils::generate_session_key</span>,
|
||
<span class="ident">SessionStore</span>,
|
||
};
|
||
|
||
<span class="doccomment">/// Use Redis as session storage backend.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// ```no_run</span>
|
||
<span class="doccomment">/// use actix_web::{web, App, HttpServer, HttpResponse, Error};</span>
|
||
<span class="doccomment">/// use actix_session::{SessionMiddleware, storage::RedisActorSessionStore};</span>
|
||
<span class="doccomment">/// use actix_web::cookie::Key;</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// // The secret key would usually be read from a configuration file/environment variables.</span>
|
||
<span class="doccomment">/// fn get_secret_key() -> Key {</span>
|
||
<span class="doccomment">/// # todo!()</span>
|
||
<span class="doccomment">/// // [...]</span>
|
||
<span class="doccomment">/// }</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// #[actix_web::main]</span>
|
||
<span class="doccomment">/// async fn main() -> std::io::Result<()> {</span>
|
||
<span class="doccomment">/// let secret_key = get_secret_key();</span>
|
||
<span class="doccomment">/// let redis_connection_string = "127.0.0.1:6379";</span>
|
||
<span class="doccomment">/// HttpServer::new(move ||</span>
|
||
<span class="doccomment">/// App::new()</span>
|
||
<span class="doccomment">/// .wrap(</span>
|
||
<span class="doccomment">/// SessionMiddleware::new(</span>
|
||
<span class="doccomment">/// RedisActorSessionStore::new(redis_connection_string),</span>
|
||
<span class="doccomment">/// secret_key.clone()</span>
|
||
<span class="doccomment">/// )</span>
|
||
<span class="doccomment">/// )</span>
|
||
<span class="doccomment">/// .default_service(web::to(|| HttpResponse::Ok())))</span>
|
||
<span class="doccomment">/// .bind(("127.0.0.1", 8080))?</span>
|
||
<span class="doccomment">/// .run()</span>
|
||
<span class="doccomment">/// .await</span>
|
||
<span class="doccomment">/// }</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Implementation notes</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `RedisActorSessionStore` leverages `actix-redis`'s `RedisActor` implementation - each thread</span>
|
||
<span class="doccomment">/// worker gets its own connection to Redis.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// ## Limitations</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `RedisActorSessionStore` does not currently support establishing authenticated connections to</span>
|
||
<span class="doccomment">/// Redis. Use [`RedisSessionStore`] if you need TLS support.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// [`RedisSessionStore`]: crate::storage::RedisSessionStore</span>
|
||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">docsrs</span>, <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"redis-actor-session"</span>)))]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="ident">configuration</span>: <span class="ident">CacheConfiguration</span>,
|
||
<span class="ident">addr</span>: <span class="ident">Addr</span><span class="op"><</span><span class="ident">RedisActor</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="doccomment">/// A fluent API to configure [`RedisActorSessionStore`].</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// It takes as input the only required input to create a new instance of</span>
|
||
<span class="doccomment">/// [`RedisActorSessionStore`]—a connection string for Redis.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">builder</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>(<span class="ident">connection_string</span>: <span class="ident">S</span>) -> <span class="ident">RedisActorSessionStoreBuilder</span> {
|
||
<span class="ident">RedisActorSessionStoreBuilder</span> {
|
||
<span class="ident">configuration</span>: <span class="ident">CacheConfiguration::default</span>(),
|
||
<span class="ident">connection_string</span>: <span class="ident">connection_string</span>.<span class="ident">into</span>(),
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Create a new instance of [`RedisActorSessionStore`] using the default configuration.</span>
|
||
<span class="doccomment">/// It takes as input the only required input to create a new instance of [`RedisActorSessionStore`] - a</span>
|
||
<span class="doccomment">/// connection string for Redis.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>(<span class="ident">connection_string</span>: <span class="ident">S</span>) -> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="ident"><span class="self">Self</span>::builder</span>(<span class="ident">connection_string</span>).<span class="ident">build</span>()
|
||
}
|
||
}
|
||
|
||
<span class="kw">struct</span> <span class="ident">CacheConfiguration</span> {
|
||
<span class="ident">cache_keygen</span>: <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Fn</span>(<span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">String</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">CacheConfiguration</span> {
|
||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||
<span class="self">Self</span> {
|
||
<span class="ident">cache_keygen</span>: <span class="ident">Box::new</span>(<span class="ident">str::to_owned</span>),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// A fluent builder to construct a [`RedisActorSessionStore`] instance with custom configuration</span>
|
||
<span class="doccomment">/// parameters.</span>
|
||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">docsrs</span>, <span class="ident">doc</span>(<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"redis-actor-session"</span>)))]</span>
|
||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RedisActorSessionStoreBuilder</span> {
|
||
<span class="ident">connection_string</span>: <span class="ident">String</span>,
|
||
<span class="ident">configuration</span>: <span class="ident">CacheConfiguration</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">RedisActorSessionStoreBuilder</span> {
|
||
<span class="doccomment">/// Set a custom cache key generation strategy, expecting a session key as input.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cache_keygen</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">keygen</span>: <span class="ident">F</span>) -> <span class="self">Self</span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">String</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||
{
|
||
<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span> <span class="op">=</span> <span class="ident">Box::new</span>(<span class="ident">keygen</span>);
|
||
<span class="self">self</span>
|
||
}
|
||
|
||
<span class="doccomment">/// Finalise the builder and return a [`RedisActorSessionStore`] instance.</span>
|
||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) -> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="ident">RedisActorSessionStore</span> {
|
||
<span class="ident">configuration</span>: <span class="self">self</span>.<span class="ident">configuration</span>,
|
||
<span class="ident">addr</span>: <span class="ident">RedisActor::start</span>(<span class="self">self</span>.<span class="ident">connection_string</span>),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">async_trait::async_trait</span>(<span class="question-mark">?</span><span class="ident">Send</span>)]</span>
|
||
<span class="kw">impl</span> <span class="ident">SessionStore</span> <span class="kw">for</span> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">session_key</span>: <span class="kw-2">&</span><span class="ident">SessionKey</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">SessionState</span><span class="op">></span>, <span class="ident">LoadError</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">cache_key</span> <span class="op">=</span> (<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span>)(<span class="ident">session_key</span>.<span class="ident">as_ref</span>());
|
||
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="self">self</span>
|
||
.<span class="ident">addr</span>
|
||
.<span class="ident">send</span>(<span class="ident">Command</span>(<span class="macro">resp_array!</span>[<span class="string">"GET"</span>, <span class="ident">cache_key</span>]))
|
||
.<span class="kw">await</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">LoadError::Other</span>)<span class="question-mark">?</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">LoadError::Other</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">match</span> <span class="ident">val</span> {
|
||
<span class="ident">RespValue::Error</span>(<span class="ident">err</span>) => <span class="prelude-val">Err</span>(<span class="ident">LoadError::Other</span>(<span class="macro">anyhow::anyhow!</span>(<span class="ident">err</span>))),
|
||
|
||
<span class="ident">RespValue::SimpleString</span>(<span class="ident">s</span>) => <span class="prelude-val">Ok</span>(<span class="ident">serde_json::from_str</span>(<span class="kw-2">&</span><span class="ident">s</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">LoadError::Deserialization</span>)<span class="question-mark">?</span>),
|
||
|
||
<span class="ident">RespValue::BulkString</span>(<span class="ident">s</span>) => <span class="prelude-val">Ok</span>(<span class="ident">serde_json::from_slice</span>(<span class="kw-2">&</span><span class="ident">s</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">LoadError::Deserialization</span>)<span class="question-mark">?</span>),
|
||
|
||
<span class="kw">_</span> => <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>),
|
||
}
|
||
}
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">save</span>(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
<span class="ident">session_state</span>: <span class="ident">SessionState</span>,
|
||
<span class="ident">ttl</span>: <span class="kw-2">&</span><span class="ident">Duration</span>,
|
||
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">SessionKey</span>, <span class="ident">SaveError</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">serde_json::to_string</span>(<span class="kw-2">&</span><span class="ident">session_state</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">SaveError::Serialization</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">session_key</span> <span class="op">=</span> <span class="ident">generate_session_key</span>();
|
||
<span class="kw">let</span> <span class="ident">cache_key</span> <span class="op">=</span> (<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span>)(<span class="ident">session_key</span>.<span class="ident">as_ref</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command</span>(<span class="macro">resp_array!</span>[
|
||
<span class="string">"SET"</span>,
|
||
<span class="ident">cache_key</span>,
|
||
<span class="ident">body</span>,
|
||
<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="macro">format!</span>(<span class="string">"{}"</span>, <span class="ident">ttl</span>.<span class="ident">whole_seconds</span>())
|
||
]);
|
||
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="self">self</span>
|
||
.<span class="ident">addr</span>
|
||
.<span class="ident">send</span>(<span class="ident">cmd</span>)
|
||
.<span class="kw">await</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">SaveError::Other</span>)<span class="question-mark">?</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">SaveError::Other</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">match</span> <span class="ident">result</span> {
|
||
<span class="ident">RespValue::SimpleString</span>(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(<span class="ident">session_key</span>),
|
||
<span class="ident">RespValue::Nil</span> => <span class="prelude-val">Err</span>(<span class="ident">SaveError::Other</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"Failed to save session state. A record with the same key already existed in Redis"</span>
|
||
))),
|
||
<span class="ident">err</span> => <span class="prelude-val">Err</span>(<span class="ident">SaveError::Other</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"Failed to save session state. {:?}"</span>,
|
||
<span class="ident">err</span>
|
||
))),
|
||
}
|
||
}
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update</span>(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
<span class="ident">session_key</span>: <span class="ident">SessionKey</span>,
|
||
<span class="ident">session_state</span>: <span class="ident">SessionState</span>,
|
||
<span class="ident">ttl</span>: <span class="kw-2">&</span><span class="ident">Duration</span>,
|
||
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">SessionKey</span>, <span class="ident">UpdateError</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">serde_json::to_string</span>(<span class="kw-2">&</span><span class="ident">session_state</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">UpdateError::Serialization</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">cache_key</span> <span class="op">=</span> (<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span>)(<span class="ident">session_key</span>.<span class="ident">as_ref</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command</span>(<span class="macro">resp_array!</span>[
|
||
<span class="string">"SET"</span>,
|
||
<span class="ident">cache_key</span>,
|
||
<span class="ident">body</span>,
|
||
<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="macro">format!</span>(<span class="string">"{}"</span>, <span class="ident">ttl</span>.<span class="ident">whole_seconds</span>())
|
||
]);
|
||
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="self">self</span>
|
||
.<span class="ident">addr</span>
|
||
.<span class="ident">send</span>(<span class="ident">cmd</span>)
|
||
.<span class="kw">await</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">UpdateError::Other</span>)<span class="question-mark">?</span>
|
||
.<span class="ident">map_err</span>(<span class="ident">Into::into</span>)
|
||
.<span class="ident">map_err</span>(<span class="ident">UpdateError::Other</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">match</span> <span class="ident">result</span> {
|
||
<span class="ident">RespValue::Nil</span> => {
|
||
<span class="comment">// The SET operation was not performed because the XX condition was not verified.</span>
|
||
<span class="comment">// This can happen if the session state expired between the load operation and the</span>
|
||
<span class="comment">// update operation. Unlucky, to say the least. We fall back to the `save` routine</span>
|
||
<span class="comment">// to ensure that the new key is unique.</span>
|
||
<span class="self">self</span>.<span class="ident">save</span>(<span class="ident">session_state</span>, <span class="ident">ttl</span>)
|
||
.<span class="kw">await</span>
|
||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> <span class="kw">match</span> <span class="ident">err</span> {
|
||
<span class="ident">SaveError::Serialization</span>(<span class="ident">err</span>) => <span class="ident">UpdateError::Serialization</span>(<span class="ident">err</span>),
|
||
<span class="ident">SaveError::Other</span>(<span class="ident">err</span>) => <span class="ident">UpdateError::Other</span>(<span class="ident">err</span>),
|
||
})
|
||
}
|
||
<span class="ident">RespValue::SimpleString</span>(<span class="kw">_</span>) => <span class="prelude-val">Ok</span>(<span class="ident">session_key</span>),
|
||
<span class="ident">val</span> => <span class="prelude-val">Err</span>(<span class="ident">UpdateError::Other</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"Failed to update session state. {:?}"</span>,
|
||
<span class="ident">val</span>
|
||
))),
|
||
}
|
||
}
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_ttl</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">session_key</span>: <span class="kw-2">&</span><span class="ident">SessionKey</span>, <span class="ident">ttl</span>: <span class="kw-2">&</span><span class="ident">Duration</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">cache_key</span> <span class="op">=</span> (<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span>)(<span class="ident">session_key</span>.<span class="ident">as_ref</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command</span>(<span class="macro">resp_array!</span>[
|
||
<span class="string">"EXPIRE"</span>,
|
||
<span class="ident">cache_key</span>,
|
||
<span class="ident">ttl</span>.<span class="ident">whole_seconds</span>().<span class="ident">to_string</span>()
|
||
]);
|
||
|
||
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">addr</span>.<span class="ident">send</span>(<span class="ident">cmd</span>).<span class="kw">await</span><span class="question-mark">?</span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">RespValue::Integer</span>(<span class="kw">_</span>)) => <span class="prelude-val">Ok</span>(()),
|
||
<span class="ident">val</span> => <span class="prelude-val">Err</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"Failed to update the session state TTL: {:?}"</span>,
|
||
<span class="ident">val</span>
|
||
)),
|
||
}
|
||
}
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">session_key</span>: <span class="kw-2">&</span><span class="ident">SessionKey</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">anyhow::Error</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">cache_key</span> <span class="op">=</span> (<span class="self">self</span>.<span class="ident">configuration</span>.<span class="ident">cache_keygen</span>)(<span class="ident">session_key</span>.<span class="ident">as_ref</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="self">self</span>
|
||
.<span class="ident">addr</span>
|
||
.<span class="ident">send</span>(<span class="ident">Command</span>(<span class="macro">resp_array!</span>[<span class="string">"DEL"</span>, <span class="ident">cache_key</span>]))
|
||
.<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="kw">match</span> <span class="ident">res</span> {
|
||
<span class="comment">// Redis returns the number of deleted records</span>
|
||
<span class="prelude-val">Ok</span>(<span class="ident">RespValue::Integer</span>(<span class="kw">_</span>)) => <span class="prelude-val">Ok</span>(()),
|
||
<span class="ident">val</span> => <span class="prelude-val">Err</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"Failed to remove session from cache. {:?}"</span>,
|
||
<span class="ident">val</span>
|
||
)),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||
<span class="kw">use</span> <span class="ident">std::collections::HashMap</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">actix_web::cookie::time::Duration</span>;
|
||
|
||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::test_helpers::acceptance_test_suite</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">redis_actor_store</span>() -> <span class="ident">RedisActorSessionStore</span> {
|
||
<span class="ident">RedisActorSessionStore::new</span>(<span class="string">"127.0.0.1:6379"</span>)
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_session_workflow</span>() {
|
||
<span class="ident">acceptance_test_suite</span>(<span class="ident">redis_actor_store</span>, <span class="bool-val">true</span>).<span class="kw">await</span>;
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">loading_a_missing_session_returns_none</span>() {
|
||
<span class="kw">let</span> <span class="ident">store</span> <span class="op">=</span> <span class="ident">redis_actor_store</span>();
|
||
<span class="kw">let</span> <span class="ident">session_key</span> <span class="op">=</span> <span class="ident">generate_session_key</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">store</span>.<span class="ident">load</span>(<span class="kw-2">&</span><span class="ident">session_key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>().<span class="ident">is_none</span>());
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">updating_of_an_expired_state_is_handled_gracefully</span>() {
|
||
<span class="kw">let</span> <span class="ident">store</span> <span class="op">=</span> <span class="ident">redis_actor_store</span>();
|
||
<span class="kw">let</span> <span class="ident">session_key</span> <span class="op">=</span> <span class="ident">generate_session_key</span>();
|
||
<span class="kw">let</span> <span class="ident">initial_session_key</span> <span class="op">=</span> <span class="ident">session_key</span>.<span class="ident">as_ref</span>().<span class="ident">to_owned</span>();
|
||
<span class="kw">let</span> <span class="ident">updated_session_key</span> <span class="op">=</span> <span class="ident">store</span>
|
||
.<span class="ident">update</span>(<span class="ident">session_key</span>, <span class="ident">HashMap::new</span>(), <span class="kw-2">&</span><span class="ident">Duration::seconds</span>(<span class="number">1</span>))
|
||
.<span class="kw">await</span>
|
||
.<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_ne!</span>(<span class="ident">initial_session_key</span>, <span class="ident">updated_session_key</span>.<span class="ident">as_ref</span>());
|
||
}
|
||
}
|
||
</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 (d394408fb 2022-08-07)" ></div></body></html> |