mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 13:06:38 +02:00
693 lines
32 KiB
HTML
693 lines
32 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_rs.rs`."><title>redis_rs.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_session" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0-nightly (5ae769f06 2023-09-26)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../../actix_session/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||
<a href="#2" id="2">2</a>
|
||
<a href="#3" id="3">3</a>
|
||
<a href="#4" id="4">4</a>
|
||
<a href="#5" id="5">5</a>
|
||
<a href="#6" id="6">6</a>
|
||
<a href="#7" id="7">7</a>
|
||
<a href="#8" id="8">8</a>
|
||
<a href="#9" id="9">9</a>
|
||
<a href="#10" id="10">10</a>
|
||
<a href="#11" id="11">11</a>
|
||
<a href="#12" id="12">12</a>
|
||
<a href="#13" id="13">13</a>
|
||
<a href="#14" id="14">14</a>
|
||
<a href="#15" id="15">15</a>
|
||
<a href="#16" id="16">16</a>
|
||
<a href="#17" id="17">17</a>
|
||
<a href="#18" id="18">18</a>
|
||
<a href="#19" id="19">19</a>
|
||
<a href="#20" id="20">20</a>
|
||
<a href="#21" id="21">21</a>
|
||
<a href="#22" id="22">22</a>
|
||
<a href="#23" id="23">23</a>
|
||
<a href="#24" id="24">24</a>
|
||
<a href="#25" id="25">25</a>
|
||
<a href="#26" id="26">26</a>
|
||
<a href="#27" id="27">27</a>
|
||
<a href="#28" id="28">28</a>
|
||
<a href="#29" id="29">29</a>
|
||
<a href="#30" id="30">30</a>
|
||
<a href="#31" id="31">31</a>
|
||
<a href="#32" id="32">32</a>
|
||
<a href="#33" id="33">33</a>
|
||
<a href="#34" id="34">34</a>
|
||
<a href="#35" id="35">35</a>
|
||
<a href="#36" id="36">36</a>
|
||
<a href="#37" id="37">37</a>
|
||
<a href="#38" id="38">38</a>
|
||
<a href="#39" id="39">39</a>
|
||
<a href="#40" id="40">40</a>
|
||
<a href="#41" id="41">41</a>
|
||
<a href="#42" id="42">42</a>
|
||
<a href="#43" id="43">43</a>
|
||
<a href="#44" id="44">44</a>
|
||
<a href="#45" id="45">45</a>
|
||
<a href="#46" id="46">46</a>
|
||
<a href="#47" id="47">47</a>
|
||
<a href="#48" id="48">48</a>
|
||
<a href="#49" id="49">49</a>
|
||
<a href="#50" id="50">50</a>
|
||
<a href="#51" id="51">51</a>
|
||
<a href="#52" id="52">52</a>
|
||
<a href="#53" id="53">53</a>
|
||
<a href="#54" id="54">54</a>
|
||
<a href="#55" id="55">55</a>
|
||
<a href="#56" id="56">56</a>
|
||
<a href="#57" id="57">57</a>
|
||
<a href="#58" id="58">58</a>
|
||
<a href="#59" id="59">59</a>
|
||
<a href="#60" id="60">60</a>
|
||
<a href="#61" id="61">61</a>
|
||
<a href="#62" id="62">62</a>
|
||
<a href="#63" id="63">63</a>
|
||
<a href="#64" id="64">64</a>
|
||
<a href="#65" id="65">65</a>
|
||
<a href="#66" id="66">66</a>
|
||
<a href="#67" id="67">67</a>
|
||
<a href="#68" id="68">68</a>
|
||
<a href="#69" id="69">69</a>
|
||
<a href="#70" id="70">70</a>
|
||
<a href="#71" id="71">71</a>
|
||
<a href="#72" id="72">72</a>
|
||
<a href="#73" id="73">73</a>
|
||
<a href="#74" id="74">74</a>
|
||
<a href="#75" id="75">75</a>
|
||
<a href="#76" id="76">76</a>
|
||
<a href="#77" id="77">77</a>
|
||
<a href="#78" id="78">78</a>
|
||
<a href="#79" id="79">79</a>
|
||
<a href="#80" id="80">80</a>
|
||
<a href="#81" id="81">81</a>
|
||
<a href="#82" id="82">82</a>
|
||
<a href="#83" id="83">83</a>
|
||
<a href="#84" id="84">84</a>
|
||
<a href="#85" id="85">85</a>
|
||
<a href="#86" id="86">86</a>
|
||
<a href="#87" id="87">87</a>
|
||
<a href="#88" id="88">88</a>
|
||
<a href="#89" id="89">89</a>
|
||
<a href="#90" id="90">90</a>
|
||
<a href="#91" id="91">91</a>
|
||
<a href="#92" id="92">92</a>
|
||
<a href="#93" id="93">93</a>
|
||
<a href="#94" id="94">94</a>
|
||
<a href="#95" id="95">95</a>
|
||
<a href="#96" id="96">96</a>
|
||
<a href="#97" id="97">97</a>
|
||
<a href="#98" id="98">98</a>
|
||
<a href="#99" id="99">99</a>
|
||
<a href="#100" id="100">100</a>
|
||
<a href="#101" id="101">101</a>
|
||
<a href="#102" id="102">102</a>
|
||
<a href="#103" id="103">103</a>
|
||
<a href="#104" id="104">104</a>
|
||
<a href="#105" id="105">105</a>
|
||
<a href="#106" id="106">106</a>
|
||
<a href="#107" id="107">107</a>
|
||
<a href="#108" id="108">108</a>
|
||
<a href="#109" id="109">109</a>
|
||
<a href="#110" id="110">110</a>
|
||
<a href="#111" id="111">111</a>
|
||
<a href="#112" id="112">112</a>
|
||
<a href="#113" id="113">113</a>
|
||
<a href="#114" id="114">114</a>
|
||
<a href="#115" id="115">115</a>
|
||
<a href="#116" id="116">116</a>
|
||
<a href="#117" id="117">117</a>
|
||
<a href="#118" id="118">118</a>
|
||
<a href="#119" id="119">119</a>
|
||
<a href="#120" id="120">120</a>
|
||
<a href="#121" id="121">121</a>
|
||
<a href="#122" id="122">122</a>
|
||
<a href="#123" id="123">123</a>
|
||
<a href="#124" id="124">124</a>
|
||
<a href="#125" id="125">125</a>
|
||
<a href="#126" id="126">126</a>
|
||
<a href="#127" id="127">127</a>
|
||
<a href="#128" id="128">128</a>
|
||
<a href="#129" id="129">129</a>
|
||
<a href="#130" id="130">130</a>
|
||
<a href="#131" id="131">131</a>
|
||
<a href="#132" id="132">132</a>
|
||
<a href="#133" id="133">133</a>
|
||
<a href="#134" id="134">134</a>
|
||
<a href="#135" id="135">135</a>
|
||
<a href="#136" id="136">136</a>
|
||
<a href="#137" id="137">137</a>
|
||
<a href="#138" id="138">138</a>
|
||
<a href="#139" id="139">139</a>
|
||
<a href="#140" id="140">140</a>
|
||
<a href="#141" id="141">141</a>
|
||
<a href="#142" id="142">142</a>
|
||
<a href="#143" id="143">143</a>
|
||
<a href="#144" id="144">144</a>
|
||
<a href="#145" id="145">145</a>
|
||
<a href="#146" id="146">146</a>
|
||
<a href="#147" id="147">147</a>
|
||
<a href="#148" id="148">148</a>
|
||
<a href="#149" id="149">149</a>
|
||
<a href="#150" id="150">150</a>
|
||
<a href="#151" id="151">151</a>
|
||
<a href="#152" id="152">152</a>
|
||
<a href="#153" id="153">153</a>
|
||
<a href="#154" id="154">154</a>
|
||
<a href="#155" id="155">155</a>
|
||
<a href="#156" id="156">156</a>
|
||
<a href="#157" id="157">157</a>
|
||
<a href="#158" id="158">158</a>
|
||
<a href="#159" id="159">159</a>
|
||
<a href="#160" id="160">160</a>
|
||
<a href="#161" id="161">161</a>
|
||
<a href="#162" id="162">162</a>
|
||
<a href="#163" id="163">163</a>
|
||
<a href="#164" id="164">164</a>
|
||
<a href="#165" id="165">165</a>
|
||
<a href="#166" id="166">166</a>
|
||
<a href="#167" id="167">167</a>
|
||
<a href="#168" id="168">168</a>
|
||
<a href="#169" id="169">169</a>
|
||
<a href="#170" id="170">170</a>
|
||
<a href="#171" id="171">171</a>
|
||
<a href="#172" id="172">172</a>
|
||
<a href="#173" id="173">173</a>
|
||
<a href="#174" id="174">174</a>
|
||
<a href="#175" id="175">175</a>
|
||
<a href="#176" id="176">176</a>
|
||
<a href="#177" id="177">177</a>
|
||
<a href="#178" id="178">178</a>
|
||
<a href="#179" id="179">179</a>
|
||
<a href="#180" id="180">180</a>
|
||
<a href="#181" id="181">181</a>
|
||
<a href="#182" id="182">182</a>
|
||
<a href="#183" id="183">183</a>
|
||
<a href="#184" id="184">184</a>
|
||
<a href="#185" id="185">185</a>
|
||
<a href="#186" id="186">186</a>
|
||
<a href="#187" id="187">187</a>
|
||
<a href="#188" id="188">188</a>
|
||
<a href="#189" id="189">189</a>
|
||
<a href="#190" id="190">190</a>
|
||
<a href="#191" id="191">191</a>
|
||
<a href="#192" id="192">192</a>
|
||
<a href="#193" id="193">193</a>
|
||
<a href="#194" id="194">194</a>
|
||
<a href="#195" id="195">195</a>
|
||
<a href="#196" id="196">196</a>
|
||
<a href="#197" id="197">197</a>
|
||
<a href="#198" id="198">198</a>
|
||
<a href="#199" id="199">199</a>
|
||
<a href="#200" id="200">200</a>
|
||
<a href="#201" id="201">201</a>
|
||
<a href="#202" id="202">202</a>
|
||
<a href="#203" id="203">203</a>
|
||
<a href="#204" id="204">204</a>
|
||
<a href="#205" id="205">205</a>
|
||
<a href="#206" id="206">206</a>
|
||
<a href="#207" id="207">207</a>
|
||
<a href="#208" id="208">208</a>
|
||
<a href="#209" id="209">209</a>
|
||
<a href="#210" id="210">210</a>
|
||
<a href="#211" id="211">211</a>
|
||
<a href="#212" id="212">212</a>
|
||
<a href="#213" id="213">213</a>
|
||
<a href="#214" id="214">214</a>
|
||
<a href="#215" id="215">215</a>
|
||
<a href="#216" id="216">216</a>
|
||
<a href="#217" id="217">217</a>
|
||
<a href="#218" id="218">218</a>
|
||
<a href="#219" id="219">219</a>
|
||
<a href="#220" id="220">220</a>
|
||
<a href="#221" id="221">221</a>
|
||
<a href="#222" id="222">222</a>
|
||
<a href="#223" id="223">223</a>
|
||
<a href="#224" id="224">224</a>
|
||
<a href="#225" id="225">225</a>
|
||
<a href="#226" id="226">226</a>
|
||
<a href="#227" id="227">227</a>
|
||
<a href="#228" id="228">228</a>
|
||
<a href="#229" id="229">229</a>
|
||
<a href="#230" id="230">230</a>
|
||
<a href="#231" id="231">231</a>
|
||
<a href="#232" id="232">232</a>
|
||
<a href="#233" id="233">233</a>
|
||
<a href="#234" id="234">234</a>
|
||
<a href="#235" id="235">235</a>
|
||
<a href="#236" id="236">236</a>
|
||
<a href="#237" id="237">237</a>
|
||
<a href="#238" id="238">238</a>
|
||
<a href="#239" id="239">239</a>
|
||
<a href="#240" id="240">240</a>
|
||
<a href="#241" id="241">241</a>
|
||
<a href="#242" id="242">242</a>
|
||
<a href="#243" id="243">243</a>
|
||
<a href="#244" id="244">244</a>
|
||
<a href="#245" id="245">245</a>
|
||
<a href="#246" id="246">246</a>
|
||
<a href="#247" id="247">247</a>
|
||
<a href="#248" id="248">248</a>
|
||
<a href="#249" id="249">249</a>
|
||
<a href="#250" id="250">250</a>
|
||
<a href="#251" id="251">251</a>
|
||
<a href="#252" id="252">252</a>
|
||
<a href="#253" id="253">253</a>
|
||
<a href="#254" id="254">254</a>
|
||
<a href="#255" id="255">255</a>
|
||
<a href="#256" id="256">256</a>
|
||
<a href="#257" id="257">257</a>
|
||
<a href="#258" id="258">258</a>
|
||
<a href="#259" id="259">259</a>
|
||
<a href="#260" id="260">260</a>
|
||
<a href="#261" id="261">261</a>
|
||
<a href="#262" id="262">262</a>
|
||
<a href="#263" id="263">263</a>
|
||
<a href="#264" id="264">264</a>
|
||
<a href="#265" id="265">265</a>
|
||
<a href="#266" id="266">266</a>
|
||
<a href="#267" id="267">267</a>
|
||
<a href="#268" id="268">268</a>
|
||
<a href="#269" id="269">269</a>
|
||
<a href="#270" id="270">270</a>
|
||
<a href="#271" id="271">271</a>
|
||
<a href="#272" id="272">272</a>
|
||
<a href="#273" id="273">273</a>
|
||
<a href="#274" id="274">274</a>
|
||
<a href="#275" id="275">275</a>
|
||
<a href="#276" id="276">276</a>
|
||
<a href="#277" id="277">277</a>
|
||
<a href="#278" id="278">278</a>
|
||
<a href="#279" id="279">279</a>
|
||
<a href="#280" id="280">280</a>
|
||
<a href="#281" id="281">281</a>
|
||
<a href="#282" id="282">282</a>
|
||
<a href="#283" id="283">283</a>
|
||
<a href="#284" id="284">284</a>
|
||
<a href="#285" id="285">285</a>
|
||
<a href="#286" id="286">286</a>
|
||
<a href="#287" id="287">287</a>
|
||
<a href="#288" id="288">288</a>
|
||
<a href="#289" id="289">289</a>
|
||
<a href="#290" id="290">290</a>
|
||
<a href="#291" id="291">291</a>
|
||
<a href="#292" id="292">292</a>
|
||
<a href="#293" id="293">293</a>
|
||
<a href="#294" id="294">294</a>
|
||
<a href="#295" id="295">295</a>
|
||
<a href="#296" id="296">296</a>
|
||
<a href="#297" id="297">297</a>
|
||
<a href="#298" id="298">298</a>
|
||
<a href="#299" id="299">299</a>
|
||
<a href="#300" id="300">300</a>
|
||
<a href="#301" id="301">301</a>
|
||
<a href="#302" id="302">302</a>
|
||
<a href="#303" id="303">303</a>
|
||
<a href="#304" id="304">304</a>
|
||
<a href="#305" id="305">305</a>
|
||
<a href="#306" id="306">306</a>
|
||
<a href="#307" id="307">307</a>
|
||
<a href="#308" id="308">308</a>
|
||
<a href="#309" id="309">309</a>
|
||
<a href="#310" id="310">310</a>
|
||
<a href="#311" id="311">311</a>
|
||
<a href="#312" id="312">312</a>
|
||
<a href="#313" id="313">313</a>
|
||
<a href="#314" id="314">314</a>
|
||
<a href="#315" id="315">315</a>
|
||
<a href="#316" id="316">316</a>
|
||
<a href="#317" id="317">317</a>
|
||
<a href="#318" id="318">318</a>
|
||
<a href="#319" id="319">319</a>
|
||
<a href="#320" id="320">320</a>
|
||
<a href="#321" id="321">321</a>
|
||
<a href="#322" id="322">322</a>
|
||
<a href="#323" id="323">323</a>
|
||
<a href="#324" id="324">324</a>
|
||
<a href="#325" id="325">325</a>
|
||
<a href="#326" id="326">326</a>
|
||
<a href="#327" id="327">327</a>
|
||
<a href="#328" id="328">328</a>
|
||
<a href="#329" id="329">329</a>
|
||
<a href="#330" id="330">330</a>
|
||
<a href="#331" id="331">331</a>
|
||
<a href="#332" id="332">332</a>
|
||
<a href="#333" id="333">333</a>
|
||
<a href="#334" id="334">334</a>
|
||
<a href="#335" id="335">335</a>
|
||
<a href="#336" id="336">336</a>
|
||
<a href="#337" id="337">337</a>
|
||
<a href="#338" id="338">338</a>
|
||
<a href="#339" id="339">339</a>
|
||
<a href="#340" id="340">340</a>
|
||
<a href="#341" id="341">341</a>
|
||
<a href="#342" id="342">342</a>
|
||
<a href="#343" id="343">343</a>
|
||
<a href="#344" id="344">344</a>
|
||
<a href="#345" id="345">345</a>
|
||
<a href="#346" id="346">346</a>
|
||
</pre></div><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="attr">#[derive(Clone)]
|
||
</span><span class="kw">pub struct </span>RedisSessionStore {
|
||
configuration: CacheConfiguration,
|
||
client: ConnectionManager,
|
||
}
|
||
|
||
<span class="attr">#[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="attr">#[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="attr">#[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="attr">#[allow(clippy::needless_pass_by_ref_mut)]
|
||
</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="attr">#[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="attr">#[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="attr">#[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="attr">#[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="attr">#[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></main></body></html> |