Files
mCaptcha/src/mcaptcha/api/v1/notifications/mark_read.rs.html
2024-04-17 18:31:47 +00:00

283 lines
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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/api/v1/notifications/mark_read.rs`."><title>mark_read.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-5bc39a1768837dd0.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.77.2 (25ef9e3d8 2024-04-09)" data-channel="1.77.2" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../../../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-04d5337699b92874.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"><div class="src-sidebar-title">
<h2>Files</h2></div></nav><div class="sidebar-resizer"></div>
<main><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../../../mcaptcha/all.html" title="show sidebar"></a></div><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" tabindex="-1"><a href="../../../../../help.html" title="help">?</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>
</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;
//
// SPDX-License-Identifier: AGPL-3.0-or-later
</span><span class="kw">use </span>actix_identity::Identity;
<span class="kw">use </span>actix_web::{web, HttpResponse, Responder};
<span class="kw">use </span>serde::{Deserialize, Serialize};
<span class="kw">use </span><span class="kw">crate</span>::errors::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::AppData;
<span class="attr">#[derive(Deserialize, Serialize)]
</span><span class="kw">pub struct </span>MarkReadReq {
<span class="kw">pub </span>id: i32,
}
<span class="doccomment">/// route handler that marks a notification read
</span><span class="attr">#[my_codegen::post(
path = <span class="string">"crate::V1_API_ROUTES.notifications.mark_read"</span>,
wrap = <span class="string">"crate::api::v1::get_middleware()"
</span>)]
</span><span class="kw">pub async fn </span>mark_read(
data: AppData,
payload: web::Json&lt;MarkReadReq&gt;,
id: Identity,
) -&gt; ServiceResult&lt;<span class="kw">impl </span>Responder&gt; {
<span class="kw">let </span>receiver = id.identity().unwrap();
<span class="comment">// TODO handle error where payload.to doesn't exist
// TODO get payload from path /api/v1/notifications/{id}/read"
</span>data.db
.mark_notification_read(<span class="kw-2">&amp;</span>receiver, payload.id)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(HttpResponse::Ok())
}
<span class="attr">#[cfg(test)]
</span><span class="kw">pub mod </span>tests {
<span class="kw">use </span>actix_web::http::StatusCode;
<span class="kw">use </span>actix_web::test;
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::api::v1::notifications::add::AddNotificationRequest;
<span class="kw">use </span><span class="kw">crate</span>::api::v1::notifications::get::NotificationResp;
<span class="kw">use </span><span class="kw">crate</span>::tests::<span class="kw-2">*</span>;
<span class="kw">use crate</span>::<span class="kw-2">*</span>;
<span class="attr">#[actix_rt::test]
</span><span class="kw">async fn </span>notification_mark_read_works_pg() {
<span class="kw">let </span>data = pg::get_data().<span class="kw">await</span>;
notification_mark_read_works(data).<span class="kw">await</span>;
}
<span class="attr">#[actix_rt::test]
</span><span class="kw">async fn </span>notification_mark_read_works_maria() {
<span class="kw">let </span>data = maria::get_data().<span class="kw">await</span>;
notification_mark_read_works(data).<span class="kw">await</span>;
}
<span class="kw">pub async fn </span>notification_mark_read_works(data: ArcData) {
<span class="kw">const </span>NAME1: <span class="kw-2">&amp;</span>str = <span class="string">"notifuser122"</span>;
<span class="kw">const </span>NAME2: <span class="kw-2">&amp;</span>str = <span class="string">"notiuser222"</span>;
<span class="kw">const </span>PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">"longpassworddomain"</span>;
<span class="kw">const </span>EMAIL1: <span class="kw-2">&amp;</span>str = <span class="string">"testnotification122@a.com"</span>;
<span class="kw">const </span>EMAIL2: <span class="kw-2">&amp;</span>str = <span class="string">"testnotification222@a.com"</span>;
<span class="kw">const </span>HEADING: <span class="kw-2">&amp;</span>str = <span class="string">"testing notifications get"</span>;
<span class="kw">const </span>MESSAGE: <span class="kw-2">&amp;</span>str = <span class="string">"testing notifications get message"</span>;
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>data;
delete_user(data, NAME1).<span class="kw">await</span>;
delete_user(data, NAME2).<span class="kw">await</span>;
register_and_signin(data, NAME1, EMAIL1, PASSWORD).<span class="kw">await</span>;
register_and_signin(data, NAME2, EMAIL2, PASSWORD).<span class="kw">await</span>;
<span class="kw">let </span>(_creds, signin_resp) = signin(data, NAME1, PASSWORD).<span class="kw">await</span>;
<span class="kw">let </span>(_creds2, signin_resp2) = signin(data, NAME2, PASSWORD).<span class="kw">await</span>;
<span class="kw">let </span>cookies = <span class="macro">get_cookie!</span>(signin_resp);
<span class="kw">let </span>cookies2 = <span class="macro">get_cookie!</span>(signin_resp2);
<span class="kw">let </span>app = <span class="macro">get_app!</span>(data).<span class="kw">await</span>;
<span class="kw">let </span>msg = AddNotificationRequest {
to: NAME2.into(),
heading: HEADING.into(),
message: MESSAGE.into(),
};
<span class="kw">let </span>send_notification_resp = test::call_service(
<span class="kw-2">&amp;</span>app,
<span class="macro">post_request!</span>(<span class="kw-2">&amp;</span>msg, V1_API_ROUTES.notifications.add)
.cookie(cookies.clone())
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(send_notification_resp.status(), StatusCode::OK);
<span class="kw">let </span>get_notifications_resp = test::call_service(
<span class="kw-2">&amp;</span>app,
test::TestRequest::get()
.uri(V1_API_ROUTES.notifications.get)
.cookie(cookies2.clone())
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(get_notifications_resp.status(), StatusCode::OK);
<span class="kw">let </span><span class="kw-2">mut </span>notifications: Vec&lt;NotificationResp&gt; =
test::read_body_json(get_notifications_resp).<span class="kw">await</span>;
<span class="kw">let </span>notification = notifications.pop().unwrap();
<span class="macro">assert_eq!</span>(notification.name, NAME1);
<span class="macro">assert_eq!</span>(notification.message, MESSAGE);
<span class="macro">assert_eq!</span>(notification.heading, HEADING);
<span class="kw">let </span>mark_read_payload = MarkReadReq {
id: notification.id,
};
<span class="kw">let </span>mark_read_resp = test::call_service(
<span class="kw-2">&amp;</span>app,
<span class="macro">post_request!</span>(<span class="kw-2">&amp;</span>mark_read_payload, V1_API_ROUTES.notifications.mark_read)
.cookie(cookies2.clone())
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(mark_read_resp.status(), StatusCode::OK);
<span class="kw">let </span>get_notifications_resp = test::call_service(
<span class="kw-2">&amp;</span>app,
test::TestRequest::get()
.uri(V1_API_ROUTES.notifications.get)
.cookie(cookies2.clone())
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(get_notifications_resp.status(), StatusCode::OK);
<span class="kw">let </span><span class="kw-2">mut </span>notifications: Vec&lt;NotificationResp&gt; =
test::read_body_json(get_notifications_resp).<span class="kw">await</span>;
<span class="macro">assert!</span>(notifications.pop().is_none());
}
}
</code></pre></div></section></main></body></html>