Deploying to gh-pages from @ 6b8ee754dd836dae3da3e3b5ead926f4854da629 🚀

src/mcaptcha/api/v1/mcaptcha/easy.rs.html

@@ -450,6 +450,92 @@
 <a href="#450" id="450">450</a>
 <a href="#451" id="451">451</a>
 <a href="#452" id="452">452</a>
+<a href="#453" id="453">453</a>
+<a href="#454" id="454">454</a>
+<a href="#455" id="455">455</a>
+<a href="#456" id="456">456</a>
+<a href="#457" id="457">457</a>
+<a href="#458" id="458">458</a>
+<a href="#459" id="459">459</a>
+<a href="#460" id="460">460</a>
+<a href="#461" id="461">461</a>
+<a href="#462" id="462">462</a>
+<a href="#463" id="463">463</a>
+<a href="#464" id="464">464</a>
+<a href="#465" id="465">465</a>
+<a href="#466" id="466">466</a>
+<a href="#467" id="467">467</a>
+<a href="#468" id="468">468</a>
+<a href="#469" id="469">469</a>
+<a href="#470" id="470">470</a>
+<a href="#471" id="471">471</a>
+<a href="#472" id="472">472</a>
+<a href="#473" id="473">473</a>
+<a href="#474" id="474">474</a>
+<a href="#475" id="475">475</a>
+<a href="#476" id="476">476</a>
+<a href="#477" id="477">477</a>
+<a href="#478" id="478">478</a>
+<a href="#479" id="479">479</a>
+<a href="#480" id="480">480</a>
+<a href="#481" id="481">481</a>
+<a href="#482" id="482">482</a>
+<a href="#483" id="483">483</a>
+<a href="#484" id="484">484</a>
+<a href="#485" id="485">485</a>
+<a href="#486" id="486">486</a>
+<a href="#487" id="487">487</a>
+<a href="#488" id="488">488</a>
+<a href="#489" id="489">489</a>
+<a href="#490" id="490">490</a>
+<a href="#491" id="491">491</a>
+<a href="#492" id="492">492</a>
+<a href="#493" id="493">493</a>
+<a href="#494" id="494">494</a>
+<a href="#495" id="495">495</a>
+<a href="#496" id="496">496</a>
+<a href="#497" id="497">497</a>
+<a href="#498" id="498">498</a>
+<a href="#499" id="499">499</a>
+<a href="#500" id="500">500</a>
+<a href="#501" id="501">501</a>
+<a href="#502" id="502">502</a>
+<a href="#503" id="503">503</a>
+<a href="#504" id="504">504</a>
+<a href="#505" id="505">505</a>
+<a href="#506" id="506">506</a>
+<a href="#507" id="507">507</a>
+<a href="#508" id="508">508</a>
+<a href="#509" id="509">509</a>
+<a href="#510" id="510">510</a>
+<a href="#511" id="511">511</a>
+<a href="#512" id="512">512</a>
+<a href="#513" id="513">513</a>
+<a href="#514" id="514">514</a>
+<a href="#515" id="515">515</a>
+<a href="#516" id="516">516</a>
+<a href="#517" id="517">517</a>
+<a href="#518" id="518">518</a>
+<a href="#519" id="519">519</a>
+<a href="#520" id="520">520</a>
+<a href="#521" id="521">521</a>
+<a href="#522" id="522">522</a>
+<a href="#523" id="523">523</a>
+<a href="#524" id="524">524</a>
+<a href="#525" id="525">525</a>
+<a href="#526" id="526">526</a>
+<a href="#527" id="527">527</a>
+<a href="#528" id="528">528</a>
+<a href="#529" id="529">529</a>
+<a href="#530" id="530">530</a>
+<a href="#531" id="531">531</a>
+<a href="#532" id="532">532</a>
+<a href="#533" id="533">533</a>
+<a href="#534" id="534">534</a>
+<a href="#535" id="535">535</a>
+<a href="#536" id="536">536</a>
+<a href="#537" id="537">537</a>
+<a href="#538" id="538">538</a>
 </pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2022  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 // SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 //
@@ -553,6 +639,79 @@
     <span class="prelude-val">Ok</span>(levels)
 }
 
+<span class="kw">async fn </span>calculate_with_percentile(
+    data: <span class="kw-2">&amp;</span>AppData,
+    tp: <span class="kw-2">&amp;</span>TrafficPattern,
+) -&gt; ServiceResult&lt;<span class="prelude-ty">Option</span>&lt;Vec&lt;Level&gt;&gt;&gt; {
+    <span class="kw">use </span><span class="kw">crate</span>::api::v1::stats::{percentile_bench_runner, PercentileReq};
+
+    <span class="kw">let </span>strategy = <span class="kw-2">&amp;</span>data.settings.captcha.default_difficulty_strategy;
+
+    <span class="kw">if </span>strategy.avg_traffic_time.is_none()
+        &amp;&amp; strategy.peak_sustainable_traffic_time.is_none()
+        &amp;&amp; strategy.broke_my_site_traffic_time.is_none()
+    {
+        <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
+    }
+
+    <span class="kw">let </span><span class="kw-2">mut </span>req = PercentileReq {
+        time: strategy.avg_traffic_time.unwrap(),
+        percentile: <span class="number">90.00</span>,
+    };
+    <span class="kw">let </span>resp = percentile_bench_runner(data, <span class="kw-2">&amp;</span>req).<span class="kw">await</span><span class="question-mark">?</span>;
+    <span class="kw">if </span>resp.difficulty_factor.is_none() {
+        <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
+    }
+    <span class="kw">let </span>avg_traffic_difficulty = resp.difficulty_factor.unwrap();
+
+    req.time = strategy.peak_sustainable_traffic_time.unwrap();
+    <span class="kw">let </span>resp = percentile_bench_runner(data, <span class="kw-2">&amp;</span>req).<span class="kw">await</span><span class="question-mark">?</span>;
+    <span class="kw">if </span>resp.difficulty_factor.is_none() {
+        <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
+    }
+    <span class="kw">let </span>peak_sustainable_traffic_difficulty = resp.difficulty_factor.unwrap();
+
+    req.time = strategy.broke_my_site_traffic_time.unwrap();
+    <span class="kw">let </span>resp = percentile_bench_runner(data, <span class="kw-2">&amp;</span>req).<span class="kw">await</span><span class="question-mark">?</span>;
+    <span class="kw">let </span>broke_my_site_traffic_difficulty = <span class="kw">if </span>resp.difficulty_factor.is_none() {
+        resp.difficulty_factor.unwrap()
+    } <span class="kw">else </span>{
+        peak_sustainable_traffic_difficulty * <span class="number">2
+    </span>};
+
+    <span class="kw">let </span><span class="kw-2">mut </span>levels = <span class="macro">vec!</span>[
+        LevelBuilder::default()
+            .difficulty_factor(avg_traffic_difficulty)<span class="question-mark">?
+            </span>.visitor_threshold(tp.avg_traffic)
+            .build()<span class="question-mark">?</span>,
+        LevelBuilder::default()
+            .difficulty_factor(peak_sustainable_traffic_difficulty)<span class="question-mark">?
+            </span>.visitor_threshold(tp.peak_sustainable_traffic)
+            .build()<span class="question-mark">?</span>,
+    ];
+    <span class="kw">let </span><span class="kw-2">mut </span>highest_level = LevelBuilder::default();
+    highest_level.difficulty_factor(broke_my_site_traffic_difficulty)<span class="question-mark">?</span>;
+
+    <span class="kw">match </span>tp.broke_my_site_traffic {
+        <span class="prelude-val">Some</span>(broke_my_site_traffic) =&gt; {
+            highest_level.visitor_threshold(broke_my_site_traffic)
+        }
+        <span class="prelude-val">None </span>=&gt; <span class="kw">match </span>tp
+            .peak_sustainable_traffic
+            .checked_add(tp.peak_sustainable_traffic / <span class="number">2</span>)
+        {
+            <span class="prelude-val">Some</span>(num) =&gt; highest_level.visitor_threshold(num),
+            <span class="comment">// TODO check for overflow: database saves these values as i32, so this u32 is cast
+            // into i32. Should choose bigger number or casts properly
+            </span><span class="prelude-val">None </span>=&gt; highest_level.visitor_threshold(u32::MAX),
+        },
+    };
+
+    levels.push(highest_level.build()<span class="question-mark">?</span>);
+
+    <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(levels))
+}
+
 <span class="attr">#[my_codegen::post(
     path = <span class="string">&quot;crate::V1_API_ROUTES.captcha.easy.create&quot;</span>,
     wrap = <span class="string">&quot;crate::api::v1::get_middleware()&quot;
@@ -565,8 +724,12 @@
     <span class="kw">let </span>username = id.identity().unwrap();
     <span class="kw">let </span>payload = payload.into_inner();
     <span class="kw">let </span>pattern = (<span class="kw-2">&amp;</span>payload).into();
-    <span class="kw">let </span>levels =
-        calculate(<span class="kw-2">&amp;</span>pattern, <span class="kw-2">&amp;</span>data.settings.captcha.default_difficulty_strategy)<span class="question-mark">?</span>;
+    <span class="kw">let </span>levels = <span class="kw">if let </span><span class="prelude-val">Some</span>(levels) = calculate_with_percentile(<span class="kw-2">&amp;</span>data, <span class="kw-2">&amp;</span>pattern).<span class="kw">await</span><span class="question-mark">?
+    </span>{
+        levels
+    } <span class="kw">else </span>{
+        calculate(<span class="kw-2">&amp;</span>pattern, <span class="kw-2">&amp;</span>data.settings.captcha.default_difficulty_strategy)<span class="question-mark">?
+    </span>};
     <span class="kw">let </span>msg = CreateCaptcha {
         levels,
         duration: data.settings.captcha.default_difficulty_strategy.duration,
@@ -599,6 +762,15 @@
 ) -&gt; ServiceResult&lt;<span class="kw">impl </span>Responder&gt; {
     <span class="kw">let </span>username = id.identity().unwrap();
     <span class="kw">let </span>payload = payload.into_inner();
+    update_runner(<span class="kw-2">&amp;</span>data, payload, username).<span class="kw">await</span><span class="question-mark">?</span>;
+    <span class="prelude-val">Ok</span>(HttpResponse::Ok())
+}
+
+<span class="kw">pub async fn </span>update_runner(
+    data: <span class="kw-2">&amp;</span>AppData,
+    payload: UpdateTrafficPattern,
+    username: String,
+) -&gt; ServiceResult&lt;()&gt; {
     <span class="kw">let </span>pattern = (<span class="kw-2">&amp;</span>payload.pattern).into();
     <span class="kw">let </span>levels =
         calculate(<span class="kw-2">&amp;</span>pattern, <span class="kw-2">&amp;</span>data.settings.captcha.default_difficulty_strategy)<span class="question-mark">?</span>;
@@ -619,7 +791,7 @@
         .add_traffic_pattern(<span class="kw-2">&amp;</span>username, <span class="kw-2">&amp;</span>msg.key, <span class="kw-2">&amp;</span>pattern)
         .<span class="kw">await</span><span class="question-mark">?</span>;
 
-    <span class="prelude-val">Ok</span>(HttpResponse::Ok())
+    <span class="prelude-val">Ok</span>(())
 }
 
 <span class="attr">#[cfg(test)]

src/mcaptcha/demo.rs.html

@@ -165,6 +165,34 @@
 <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>
 </pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2022  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 // SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 //
@@ -175,6 +203,7 @@
 
 </span><span class="kw">use </span>actix::clock::sleep;
 <span class="kw">use </span>actix::spawn;
+<span class="kw">use </span>tokio::sync::oneshot::{channel, error::TryRecvError, Receiver, Sender};
 <span class="kw">use </span>tokio::task::JoinHandle;
 
 <span class="kw">use </span><span class="kw">crate</span>::api::v1::account::delete::runners::delete_user;
@@ -190,20 +219,24 @@
 </span><span class="kw">pub const </span>DEMO_PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">&quot;password&quot;</span>;
 
 <span class="kw">pub struct </span>DemoUser {
-    handle: JoinHandle&lt;()&gt;,
+    tx: Sender&lt;()&gt;,
 }
 
 <span class="kw">impl </span>DemoUser {
-    <span class="kw">pub async fn </span>spawn(data: AppData, duration: Duration) -&gt; ServiceResult&lt;<span class="self">Self</span>&gt; {
-        <span class="kw">let </span>handle = <span class="self">Self</span>::run(data, duration).<span class="kw">await</span><span class="question-mark">?</span>;
-        <span class="kw">let </span>d = <span class="self">Self </span>{ handle };
+    <span class="kw">pub async fn </span>spawn(
+        data: AppData,
+        duration: u32,
+    ) -&gt; ServiceResult&lt;(<span class="self">Self</span>, JoinHandle&lt;()&gt;)&gt; {
+        <span class="kw">let </span>(tx, rx) = channel();
+        <span class="kw">let </span>handle = <span class="self">Self</span>::run(data, duration, rx).<span class="kw">await</span><span class="question-mark">?</span>;
+        <span class="kw">let </span>d = <span class="self">Self </span>{ tx };
 
-        <span class="prelude-val">Ok</span>(d)
+        <span class="prelude-val">Ok</span>((d, handle))
     }
 
     <span class="attr">#[allow(dead_code)]
-    </span><span class="kw">pub fn </span>abort(<span class="kw-2">&amp;</span><span class="self">self</span>) {
-        <span class="self">self</span>.handle.abort();
+    </span><span class="kw">pub fn </span>abort(<span class="kw-2">mut </span><span class="self">self</span>) {
+        <span class="self">self</span>.tx.send(());
     }
 
     <span class="doccomment">/// register demo user runner
@@ -238,16 +271,38 @@
 
     <span class="kw">pub async fn </span>run(
         data: AppData,
-        duration: Duration,
+        duration: u32,
+        <span class="kw-2">mut </span>rx: Receiver&lt;()&gt;,
     ) -&gt; ServiceResult&lt;JoinHandle&lt;()&gt;&gt; {
         <span class="self">Self</span>::register_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await</span><span class="question-mark">?</span>;
 
+        <span class="kw">fn </span>can_run(rx: <span class="kw-2">&amp;mut </span>Receiver&lt;()&gt;) -&gt; bool {
+            <span class="kw">match </span>rx.try_recv() {
+                <span class="prelude-val">Err</span>(TryRecvError::Empty) =&gt; <span class="bool-val">true</span>,
+                <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
+            }
+        }
+
+        <span class="kw">let </span><span class="kw-2">mut </span>exit = <span class="bool-val">false</span>;
         <span class="kw">let </span>fut = <span class="kw">async move </span>{
             <span class="kw">loop </span>{
-                sleep(duration).<span class="kw">await</span>;
+                <span class="kw">if </span>exit {
+                    <span class="kw">break</span>;
+                }
+                <span class="kw">for _ in </span><span class="number">0</span>..duration {
+                    <span class="kw">if </span>can_run(<span class="kw-2">&amp;mut </span>rx) {
+                        sleep(Duration::new(<span class="number">1</span>, <span class="number">0</span>)).<span class="kw">await</span>;
+                        <span class="kw">continue</span>;
+                    } <span class="kw">else </span>{
+                        exit = <span class="bool-val">true</span>;
+                        <span class="kw">break</span>;
+                    }
+                }
+
                 <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">Self</span>::delete_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await </span>{
                     <span class="macro">log::error!</span>(<span class="string">&quot;Error while deleting demo user: {:?}&quot;</span>, e);
                 }
+
                 <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">Self</span>::register_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await </span>{
                     <span class="macro">log::error!</span>(<span class="string">&quot;Error while registering demo user: {:?}&quot;</span>, e);
                 }
@@ -300,7 +355,7 @@
         <span class="macro">assert!</span>(!username_exists(<span class="kw-2">&amp;</span>payload, <span class="kw-2">&amp;</span>data).<span class="kw">await</span>.unwrap().exists);
 
         <span class="comment">// test the runner
-        </span><span class="kw">let </span>user = DemoUser::spawn(data, duration).<span class="kw">await</span>.unwrap();
+        </span><span class="kw">let </span>user = DemoUser::spawn(data, DURATION <span class="kw">as </span>u32).<span class="kw">await</span>.unwrap();
         <span class="kw">let </span>(<span class="kw">_</span>, signin_resp, token_key) =
             add_levels_util(data_inner, DEMO_USER, DEMO_PASSWORD).<span class="kw">await</span>;
         <span class="kw">let </span>cookies = <span class="macro">get_cookie!</span>(signin_resp);
@@ -329,7 +384,8 @@
         <span class="macro">assert_eq!</span>(resp.status(), StatusCode::OK);
         <span class="kw">let </span>res_levels: Vec&lt;Level&gt; = test::read_body_json(resp).<span class="kw">await</span>;
         <span class="macro">assert!</span>(res_levels.is_empty());
-        user.abort();
+        user.<span class="number">0</span>.abort();
+        user.<span class="number">1</span>.<span class="kw">await</span>.unwrap();
     }
 }
 </code></pre></div></section></main></body></html>

src/mcaptcha/easy.rs.html

@@ -0,0 +1,265 @@
+<!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 `src/easy.rs`."><title>easy.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mcaptcha" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.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-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></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"><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>
+</pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2024// Copyright (C) 2024  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
+// SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+</span><span class="kw">use </span>std::time::Duration;
+<span class="comment">//use std::sync::atomicBool
+
+</span><span class="kw">use </span>actix::clock::sleep;
+<span class="kw">use </span>actix::spawn;
+<span class="kw">use </span>tokio::sync::oneshot::{channel, error::TryRecvError, Receiver, Sender};
+<span class="kw">use </span>tokio::task::JoinHandle;
+
+<span class="kw">use </span><span class="kw">crate</span>::api::v1::mcaptcha::easy::{
+    update_runner, TrafficPatternRequest, UpdateTrafficPattern,
+};
+<span class="kw">use crate</span>::<span class="kw-2">*</span>;
+
+<span class="kw">use </span>errors::<span class="kw-2">*</span>;
+
+<span class="kw">pub struct </span>UpdateEasyCaptcha {
+    tx: Sender&lt;()&gt;,
+}
+
+<span class="kw">impl </span>UpdateEasyCaptcha {
+    <span class="kw">pub async fn </span>spawn(
+        data: AppData,
+        duration: u32,
+    ) -&gt; ServiceResult&lt;(<span class="self">Self</span>, JoinHandle&lt;()&gt;)&gt; {
+        <span class="kw">let </span>(tx, rx) = channel();
+        <span class="kw">let </span>handle = <span class="self">Self</span>::run(data, duration, rx).<span class="kw">await</span><span class="question-mark">?</span>;
+        <span class="kw">let </span>d = <span class="self">Self </span>{ tx };
+
+        <span class="prelude-val">Ok</span>((d, handle))
+    }
+
+    <span class="attr">#[allow(dead_code)]
+    </span><span class="kw">pub fn </span>abort(<span class="kw-2">mut </span><span class="self">self</span>) {
+        <span class="self">self</span>.tx.send(());
+    }
+
+    <span class="doccomment">/// update configurations
+    </span><span class="kw">async fn </span>update_captcha_configurations(
+        data: <span class="kw-2">&amp;</span>AppData,
+        rx: <span class="kw-2">&amp;mut </span>Receiver&lt;()&gt;,
+    ) -&gt; ServiceResult&lt;()&gt; {
+        <span class="kw">let </span>limit = <span class="number">10</span>;
+        <span class="kw">let </span><span class="kw-2">mut </span>offset = <span class="number">0</span>;
+        <span class="kw">let </span><span class="kw-2">mut </span>page = <span class="number">0</span>;
+        <span class="kw">loop </span>{
+            offset = page * limit;
+
+            <span class="kw">if </span>!<span class="self">Self</span>::can_run(rx) {
+                <span class="kw">return </span><span class="prelude-val">Ok</span>(());
+            }
+
+            <span class="kw">let </span><span class="kw-2">mut </span>patterns = data.db.get_all_easy_captchas(limit, offset).<span class="kw">await</span><span class="question-mark">?</span>;
+            <span class="kw">for </span>pattern <span class="kw">in </span>patterns.drain(<span class="number">0</span>..) {
+                <span class="kw">if </span>!<span class="self">Self</span>::can_run(rx) {
+                    <span class="kw">return </span><span class="prelude-val">Ok</span>(());
+                }
+
+                <span class="kw">let </span>publish_benchmarks =
+                    data.db.analytics_captcha_is_published(<span class="kw-2">&amp;</span>pattern.key).<span class="kw">await</span><span class="question-mark">?</span>;
+
+                <span class="kw">let </span>req = UpdateTrafficPattern {
+                    pattern: TrafficPatternRequest {
+                        avg_traffic: pattern.traffic_pattern.avg_traffic,
+                        peak_sustainable_traffic: pattern
+                            .traffic_pattern
+                            .peak_sustainable_traffic,
+                        broke_my_site_traffic: pattern
+                            .traffic_pattern
+                            .broke_my_site_traffic,
+                        description: pattern.description,
+                        publish_benchmarks,
+                    },
+                    key: pattern.key,
+                };
+                <span class="kw">if </span>!<span class="self">Self</span>::can_run(rx) {
+                    <span class="kw">return </span><span class="prelude-val">Ok</span>(());
+                }
+
+                update_runner(<span class="kw-2">&amp;</span>data, req, pattern.username).<span class="kw">await</span><span class="question-mark">?</span>;
+            }
+            page += <span class="number">1</span>;
+        }
+    }
+
+    <span class="kw">fn </span>can_run(rx: <span class="kw-2">&amp;mut </span>Receiver&lt;()&gt;) -&gt; bool {
+        <span class="kw">match </span>rx.try_recv() {
+            <span class="prelude-val">Err</span>(TryRecvError::Empty) =&gt; <span class="bool-val">true</span>,
+            <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
+        }
+    }
+
+    <span class="kw">pub async fn </span>run(
+        data: AppData,
+        duration: u32,
+        <span class="kw-2">mut </span>rx: Receiver&lt;()&gt;,
+    ) -&gt; ServiceResult&lt;JoinHandle&lt;()&gt;&gt; {
+        <span class="kw">let </span><span class="kw-2">mut </span>exit = <span class="bool-val">false</span>;
+        <span class="kw">let </span>fut = <span class="kw">async move </span>{
+            <span class="kw">loop </span>{
+                <span class="kw">if </span>exit {
+                    <span class="kw">break</span>;
+                }
+                <span class="kw">for _ in </span><span class="number">0</span>..duration {
+                    <span class="kw">if </span><span class="self">Self</span>::can_run(<span class="kw-2">&amp;mut </span>rx) {
+                        sleep(Duration::new(<span class="number">1</span>, <span class="number">0</span>)).<span class="kw">await</span>;
+                        <span class="kw">continue</span>;
+                    } <span class="kw">else </span>{
+                        exit = <span class="bool-val">true</span>;
+                        <span class="kw">break</span>;
+                    }
+                }
+
+                <span class="kw">if let </span><span class="prelude-val">Some</span>(err) = <span class="self">Self</span>::update_captcha_configurations(<span class="kw-2">&amp;</span>data, <span class="kw-2">&amp;mut </span>rx)
+                    .<span class="kw">await
+                    </span>.err()
+                {
+                    <span class="macro">log::error!</span>(
+                        <span class="string">&quot;Tried to update easy captcha configurations in background {:?}&quot;</span>,
+                        err
+                    );
+                }
+            }
+        };
+        <span class="kw">let </span>handle = spawn(fut);
+        <span class="prelude-val">Ok</span>(handle)
+    }
+}
+</code></pre></div></section></main></body></html>

src/mcaptcha/main.rs.html

@@ -202,6 +202,25 @@
 <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>
 </pre></div><pre class="rust"><code><span class="attr">#![allow(warnings)]
 </span><span class="comment">// Copyright (C) 2022  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 // SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -218,6 +237,7 @@
 };
 <span class="kw">use </span>lazy_static::lazy_static;
 <span class="kw">use </span>log::info;
+<span class="kw">use </span>tokio::task::JoinHandle;
 
 <span class="kw">mod </span>api;
 <span class="kw">mod </span>data;
@@ -225,6 +245,7 @@
 <span class="kw">mod </span>db;
 <span class="kw">mod </span>demo;
 <span class="kw">mod </span>docs;
+<span class="kw">mod </span>easy;
 <span class="kw">mod </span>email;
 <span class="kw">mod </span>errors;
 <span class="attr">#[macro_use]
@@ -314,11 +335,22 @@
     <span class="kw">let </span>data = Data::new(<span class="kw-2">&amp;</span>settings, secrets.clone()).<span class="kw">await</span>;
     <span class="kw">let </span>data = actix_web::web::Data::new(data);
 
-    <span class="kw">let </span><span class="kw-2">mut </span>demo_user: <span class="prelude-ty">Option</span>&lt;DemoUser&gt; = <span class="prelude-val">None</span>;
+    <span class="kw">let </span><span class="kw-2">mut </span>demo_user: <span class="prelude-ty">Option</span>&lt;(DemoUser, JoinHandle&lt;()&gt;)&gt; = <span class="prelude-val">None</span>;
 
     <span class="kw">if </span>settings.allow_demo &amp;&amp; settings.allow_registration {
-        demo_user = <span class="prelude-val">Some</span>(
-            DemoUser::spawn(data.clone(), Duration::from_secs(<span class="number">60 </span>* <span class="number">30</span>))
+        demo_user = <span class="prelude-val">Some</span>(DemoUser::spawn(data.clone(), <span class="number">60 </span>* <span class="number">30</span>).<span class="kw">await</span>.unwrap());
+    }
+
+    <span class="kw">let </span><span class="kw-2">mut </span>update_easy_captcha: <span class="prelude-ty">Option</span>&lt;(easy::UpdateEasyCaptcha, JoinHandle&lt;()&gt;)&gt; =
+        <span class="prelude-val">None</span>;
+    <span class="kw">if </span>settings
+        .captcha
+        .default_difficulty_strategy
+        .avg_traffic_time
+        .is_some()
+    {
+        update_easy_captcha = <span class="prelude-val">Some</span>(
+            easy::UpdateEasyCaptcha::spawn(data.clone(), <span class="number">60 </span>* <span class="number">30</span>)
                 .<span class="kw">await
                 </span>.unwrap(),
         );
@@ -360,7 +392,13 @@
     }
 
     <span class="kw">if let </span><span class="prelude-val">Some</span>(demo_user) = demo_user {
-        demo_user.abort();
+        demo_user.<span class="number">0</span>.abort();
+        demo_user.<span class="number">1</span>.<span class="kw">await</span>.unwrap();
+    }
+
+    <span class="kw">if let </span><span class="prelude-val">Some</span>(update_easy_captcha) = update_easy_captcha {
+        update_easy_captcha.<span class="number">0</span>.abort();
+        update_easy_captcha.<span class="number">1</span>.<span class="kw">await</span>.unwrap();
     }
 
     <span class="kw">if let </span><span class="prelude-val">Some</span>(survey_upload_handle) = survey_upload_handle {

src/mcaptcha/settings.rs.html

@@ -591,6 +591,58 @@
 <a href="#591" id="591">591</a>
 <a href="#592" id="592">592</a>
 <a href="#593" id="593">593</a>
+<a href="#594" id="594">594</a>
+<a href="#595" id="595">595</a>
+<a href="#596" id="596">596</a>
+<a href="#597" id="597">597</a>
+<a href="#598" id="598">598</a>
+<a href="#599" id="599">599</a>
+<a href="#600" id="600">600</a>
+<a href="#601" id="601">601</a>
+<a href="#602" id="602">602</a>
+<a href="#603" id="603">603</a>
+<a href="#604" id="604">604</a>
+<a href="#605" id="605">605</a>
+<a href="#606" id="606">606</a>
+<a href="#607" id="607">607</a>
+<a href="#608" id="608">608</a>
+<a href="#609" id="609">609</a>
+<a href="#610" id="610">610</a>
+<a href="#611" id="611">611</a>
+<a href="#612" id="612">612</a>
+<a href="#613" id="613">613</a>
+<a href="#614" id="614">614</a>
+<a href="#615" id="615">615</a>
+<a href="#616" id="616">616</a>
+<a href="#617" id="617">617</a>
+<a href="#618" id="618">618</a>
+<a href="#619" id="619">619</a>
+<a href="#620" id="620">620</a>
+<a href="#621" id="621">621</a>
+<a href="#622" id="622">622</a>
+<a href="#623" id="623">623</a>
+<a href="#624" id="624">624</a>
+<a href="#625" id="625">625</a>
+<a href="#626" id="626">626</a>
+<a href="#627" id="627">627</a>
+<a href="#628" id="628">628</a>
+<a href="#629" id="629">629</a>
+<a href="#630" id="630">630</a>
+<a href="#631" id="631">631</a>
+<a href="#632" id="632">632</a>
+<a href="#633" id="633">633</a>
+<a href="#634" id="634">634</a>
+<a href="#635" id="635">635</a>
+<a href="#636" id="636">636</a>
+<a href="#637" id="637">637</a>
+<a href="#638" id="638">638</a>
+<a href="#639" id="639">639</a>
+<a href="#640" id="640">640</a>
+<a href="#641" id="641">641</a>
+<a href="#642" id="642">642</a>
+<a href="#643" id="643">643</a>
+<a href="#644" id="644">644</a>
+<a href="#645" id="645">645</a>
 </pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2022  Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 // SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
 //
@@ -630,8 +682,11 @@
 <span class="attr">#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
 </span><span class="kw">pub struct </span>DefaultDifficultyStrategy {
     <span class="kw">pub </span>avg_traffic_difficulty: u32,
-    <span class="kw">pub </span>broke_my_site_traffic_difficulty: u32,
+    <span class="kw">pub </span>avg_traffic_time: <span class="prelude-ty">Option</span>&lt;u32&gt;,
     <span class="kw">pub </span>peak_sustainable_traffic_difficulty: u32,
+    <span class="kw">pub </span>peak_sustainable_traffic_time: <span class="prelude-ty">Option</span>&lt;u32&gt;,
+    <span class="kw">pub </span>broke_my_site_traffic_time: <span class="prelude-ty">Option</span>&lt;u32&gt;,
+    <span class="kw">pub </span>broke_my_site_traffic_difficulty: u32,
     <span class="kw">pub </span>duration: u32,
 }
 
@@ -706,7 +761,7 @@
     <span class="kw">pub </span>smtp: <span class="prelude-ty">Option</span>&lt;Smtp&gt;,
 }
 
-<span class="kw">const </span>ENV_VAR_CONFIG: [(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str); <span class="number">29</span>] = [
+<span class="kw">const </span>ENV_VAR_CONFIG: [(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str); <span class="number">32</span>] = [
     <span class="comment">/* top-level */
     </span>(<span class="string">&quot;debug&quot;</span>, <span class="string">&quot;MCAPTCHA_debug&quot;</span>),
     (<span class="string">&quot;commercial&quot;</span>, <span class="string">&quot;MCAPTCHA_commercial&quot;</span>),
@@ -743,6 +798,9 @@
     ( <span class="string">&quot;captcha.default_difficulty_strategy.duration&quot;</span>,
          <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_duration&quot;
      </span>),
+    (<span class="string">&quot;captcha.default_difficulty_strategy.avg_traffic_time&quot;</span>, <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_avg_traffic_time&quot;</span>),
+    (<span class="string">&quot;captcha.default_difficulty_strategy.peak_sustainable_traffic_time&quot;</span>, <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_peak_sustainable_traffic_time&quot;</span>),
+    (<span class="string">&quot;captcha.default_difficulty_strategy.broke_my_site_traffic_time&quot;</span>, <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_broke_my_site_traffic_time&quot;</span>),
 
 
     <span class="comment">/* SMTP */
@@ -844,6 +902,28 @@
 
         <span class="prelude-val">Ok</span>(settings)
     }
+    <span class="kw">fn </span>check_easy_captcha_config(<span class="kw-2">&amp;</span><span class="self">self</span>) {
+        <span class="kw">let </span>s = <span class="kw-2">&amp;</span><span class="self">self</span>.captcha.default_difficulty_strategy;
+        <span class="kw">if </span>s.avg_traffic_time.is_some() {
+            <span class="kw">if </span>s.broke_my_site_traffic_time.is_none()
+                || s.peak_sustainable_traffic_time.is_none()
+            {
+                <span class="macro">panic!</span>(<span class="string">&quot;if captcha.default_difficulty_strategy.avg_traffic_time is set, then captcha.default_difficulty_strategy.broke_my_site_traffic_time and captcha.default_difficulty_strategy.peak_sustainable_traffic_time must also be set&quot;</span>);
+            }
+        }
+        <span class="kw">if </span>s.peak_sustainable_traffic_time.is_some() {
+            <span class="kw">if </span>s.avg_traffic_time.is_none() || s.peak_sustainable_traffic_time.is_none()
+            {
+                <span class="macro">panic!</span>(<span class="string">&quot;if captcha.default_difficulty_strategy.peak_sustainable_traffic_time is set, then captcha.default_difficulty_strategy.broke_my_site_traffic_time and captcha.default_difficulty_strategy.avg_traffic_time must also be set&quot;</span>);
+            }
+        }
+        <span class="kw">if </span>s.broke_my_site_traffic_time.is_some() {
+            <span class="kw">if </span>s.avg_traffic_time.is_none() || s.peak_sustainable_traffic_time.is_none()
+            {
+                <span class="macro">panic!</span>(<span class="string">&quot;if captcha.default_difficulty_strategy.broke_my_site_traffic_time is set, then captcha.default_difficulty_strategy.peak_sustainable_traffic_time and captcha.default_difficulty_strategy.avg_traffic_time must also be set&quot;</span>);
+            }
+        }
+    }
 
     <span class="kw">fn </span>env_override(<span class="kw-2">mut </span>s: ConfigBuilder&lt;DefaultState&gt;) -&gt; ConfigBuilder&lt;DefaultState&gt; {
         <span class="kw">for </span>(parameter, env_var_name) <span class="kw">in </span>DEPRECATED_ENV_VARS.iter() {
@@ -1131,6 +1211,30 @@
             <span class="number">999</span>,
             captcha.default_difficulty_strategy.duration
         );
+        <span class="macro">helper!</span>(
+            <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_avg_traffic_time&quot;</span>,
+            <span class="string">&quot;10&quot;</span>,
+            <span class="prelude-val">Some</span>(<span class="number">10</span>),
+            captcha.default_difficulty_strategy.avg_traffic_time
+        );
+
+        <span class="macro">helper!</span>(
+            <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_peak_sustainable_traffic_time&quot;</span>,
+            <span class="string">&quot;20&quot;</span>,
+            <span class="prelude-val">Some</span>(<span class="number">20</span>),
+            captcha
+                .default_difficulty_strategy
+                .peak_sustainable_traffic_time
+        );
+
+        <span class="macro">helper!</span>(
+            <span class="string">&quot;MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_broke_my_site_traffic_time&quot;</span>,
+            <span class="string">&quot;30&quot;</span>,
+            <span class="prelude-val">Some</span>(<span class="number">30</span>),
+            captcha
+                .default_difficulty_strategy
+                .broke_my_site_traffic_time
+        );
 
         <span class="comment">/* SMTP */