Skip to main content

max / makenotwork

10.5 KB · 263 lines History Blame Raw
1 //! The creator's buyer-contacts section, described.
2 //!
3 //! S4's fourth batch, and the first taken from the set that a `data-action`
4 //! used to disqualify. Its only client behaviour was the Export CSV button, and
5 //! that turned out to be one idea on nine sites rather than a per-screen
6 //! bespoke: `Action::saving(name)` says the answer is a file the reader keeps,
7 //! and `htmx-glue.ts` performs it once for every screen that says so. See
8 //! [`export`].
9 //!
10 //! Compare `routes::pages::dashboard::tabs::user::dashboard_tab_contacts`,
11 //! which answers the same address from Askama when the screen is switched off.
12 //!
13 //! # This is the third copy of one table
14 //!
15 //! The same five columns over the same buyers already exist in
16 //! [`super::library_contacts`], which describes the reader's own view of who
17 //! shared an email with them. This is the creator's view of the same set, and
18 //! `templates/partials/tabs/buyer_contacts.html` was a third hand-written copy
19 //! of the markup. The forum-memberships batch found a pair; this makes it a
20 //! triple, and it is the same finding: a table written per template drifts per
21 //! template.
22 //!
23 //! Not folded into one function with `library_contacts` even so. The two screens
24 //! answer different questions of different people, their columns agree today by
25 //! coincidence rather than by contract, and a shared helper would make the next
26 //! divergence a merge conflict instead of an edit. The duplication worth
27 //! removing was the markup, and describing both removes it.
28 //!
29 //! # What it gives up
30 //!
31 //! The Askama version wraps the section in `<details open>`. Nothing names a
32 //! disclosure yet: 51 `<details>` sites were counted for it and it is filed on
33 //! quasicoherent, but it needs makeover-layout to name one first, so this is a
34 //! heading and its content. Since the template's disclosure is `open`, the loss
35 //! is the ability to collapse a section that starts expanded, and no reader
36 //! loses anything they can currently see.
37
38 use makeover_layout as layout;
39 use quasi_router::screen::{Cell, Cells, Column};
40 use quasi_router::{Action, Node, RegionKind, Request, Response, RouteError, Slot};
41 use quasi_webview::Webview;
42
43 use super::Viewer;
44 use crate::db;
45
46 /// This screen's name. Was the `QUASI_SCREENS` switch name until `64b33b26`
47 /// deleted the flag; it survives as the marker the tab strips read.
48 pub const SCREEN: &str = "buyer_contacts";
49
50 /// The address this screen answers, and the one the Askama route gives up.
51 pub const PATH: &str = "/dashboard/tabs/contacts";
52
53 /// The region the answer replaces.
54 ///
55 /// The Payments tab leaves an empty div here and fills it on `revealed`, so
56 /// this region is the whole of what the section is, not a pane it shares.
57 const REGION: &str = "contacts-section";
58
59 /// One buyer who chose to share their email, as the screen needs it.
60 pub struct BuyerView {
61 username: String,
62 email: String,
63 purchases: String,
64 spent: String,
65 last_purchase: String,
66 }
67
68 /// The section.
69 pub fn screen(viewer: &Viewer, _request: Request) -> Result<Response, RouteError> {
70 let contacts = viewer
71 .block_on(db::transactions::get_seller_contacts(
72 &viewer.app.db,
73 viewer.reader()?.id,
74 ))
75 .map_err(|_| RouteError::internal("your contacts could not be read"))?;
76
77 let currency = viewer.reader()?.settlement_currency;
78 let buyers: Vec<BuyerView> = contacts
79 .into_iter()
80 .map(|contact| BuyerView {
81 username: contact.username,
82 email: contact.email,
83 purchases: contact.total_purchases.to_string(),
84 spent: crate::formatting::format_revenue(contact.total_spent_cents, currency),
85 last_purchase: contact.last_purchase_at.format("%b %-d, %Y").to_string(),
86 })
87 .collect();
88
89 Ok(Response::fragment(REGION, pane(&buyers)))
90 }
91
92 /// Everything inside the section.
93 fn pane(buyers: &[BuyerView]) -> Node {
94 let slot = Slot::new(REGION, RegionKind::Pane)
95 .with(Node::section(format!("Shared Contacts ({})", buyers.len())))
96 .with(Node::text(
97 "Buyers who opted to share their email at checkout. \
98 They can revoke sharing from their library.",
99 ));
100
101 if buyers.is_empty() {
102 return Node::Region(slot.with(Node::empty(
103 "No shared contacts yet. When buyers opt to share their email at checkout, \
104 they will appear here.",
105 )));
106 }
107
108 Node::Region(slot.with(export()).with(table(buyers)))
109 }
110
111 /// The Export CSV control.
112 ///
113 /// `Action::saving` is the whole of what used to be
114 /// `data-action="exportCsvButton" data-arg="/api/export/contacts"
115 /// data-arg2="contacts.csv"`: a class naming a behaviour, plus the two things
116 /// the behaviour needed, positionally. Said here it is one sentence, the host
117 /// performs it from one attribute, and a terminal renderer can write the file to
118 /// disk without being told which button this is.
119 ///
120 /// `awaiting` because the server assembles the file before any of it comes
121 /// back, which is the report case `Action::awaiting`'s own docs name. Nothing
122 /// countable to say about it: the row count is known here but the bytes are
123 /// not, and `layout::Awaiting` takes a measurement rather than a stand-in for
124 /// one.
125 fn export() -> Node {
126 // Through `export_act` rather than spelled again here. This screen had the
127 // only described copy when it was written; there are five call sites now
128 // (`27d5e5b8`, the glue-module ruling), and one of them is the Askama
129 // fallback for this very tab. Two spellings of one control is what the
130 // conversion is for removing.
131 super::export_act::act("/api/export/contacts", "contacts.csv")
132 }
133
134 /// The buyers who shared an email.
135 fn table(buyers: &[BuyerView]) -> Node {
136 Node::Table {
137 columns: vec![
138 Column::new("Username")
139 .width(layout::Width::Content)
140 .priority(layout::Priority::Essential),
141 Column::new("Email")
142 .width(layout::Width::Fill)
143 .priority(layout::Priority::Essential),
144 Column::new("Purchases").width(layout::Width::Content),
145 Column::new("Total Spent").width(layout::Width::Content),
146 Column::new("Last Purchase")
147 .width(layout::Width::Content)
148 .priority(layout::Priority::Optional),
149 ],
150 rows: buyers
151 .iter()
152 .map(|buyer| {
153 Cells::new([
154 Cell::new(buyer.username.clone())
155 .activate(Action::get(format!("/u/{}", buyer.username)).navigating()),
156 // Plain text, unlike `library_contacts`, and the templates
157 // differ the same way: a creator's own list does not link
158 // the address it is showing. Kept rather than harmonised,
159 // because which of the two is right is a design question
160 // and this batch is a conversion.
161 Cell::new(buyer.email.clone()),
162 Cell::new(buyer.purchases.clone()),
163 Cell::new(buyer.spent.clone()),
164 Cell::new(buyer.last_purchase.clone()),
165 ])
166 })
167 .collect(),
168 // No paging described here: every one of these tables is a
169 // whole set the handler already counted.
170 more: None,
171 }
172 }
173
174 /// The renderer this screen is drawn with.
175 pub fn renderer(viewer: &Viewer) -> Webview {
176 Webview::new().with_shell(viewer.shell())
177 }
178
179 #[cfg(test)]
180 mod tests {
181 use super::*;
182 use quasi_axum::Serves;
183
184 fn buyer(username: &str) -> BuyerView {
185 BuyerView {
186 username: username.into(),
187 email: format!("{username}@example.com"),
188 purchases: "3".into(),
189 spent: "$42.00".into(),
190 last_purchase: "Aug 10, 2026".into(),
191 }
192 }
193
194 fn render(node: &Node) -> String {
195 Webview::new().fragment(node)
196 }
197
198 #[test]
199 fn the_region_is_the_one_the_payments_tab_leaves_empty() {
200 // The Payments tab fills this on `revealed`. If the id ever disagrees
201 // the section loads into nothing, and nothing else would notice.
202 let payments = include_str!("../../templates/partials/tabs/user_payments.html");
203 assert!(payments.contains(&format!("id=\"{REGION}\"")), "{REGION}");
204 assert!(payments.contains(&format!("hx-get=\"{PATH}\"")));
205 }
206
207 #[test]
208 fn the_export_says_what_it_produces_rather_than_naming_a_behaviour() {
209 let html = render(&export());
210
211 assert!(html.contains("data-saves=\"contacts.csv\""), "{html}");
212 assert!(html.contains("hx-post=\"/api/export/contacts\""), "{html}");
213 // The thing this replaced. A described screen naming a JS function by
214 // string would be the vocabulary gap papered over rather than closed.
215 assert!(!html.contains("data-action"), "{html}");
216 assert!(!html.contains("exportCsvButton"), "{html}");
217 }
218
219 #[test]
220 fn the_export_address_is_one_the_api_answers() {
221 // The S3 failure class: a control addressing a route registered nowhere
222 // renders fine and answers 404 when pressed.
223 let api = include_str!("../routes/api/mod.rs");
224 assert!(api.contains("/api/export/contacts"), "registered route");
225 }
226
227 #[test]
228 fn an_empty_list_offers_no_export_of_nothing() {
229 // The template hides the button and the table together, which is worth
230 // keeping: an export of an empty set is a file nobody wants.
231 let html = render(&pane(&[]));
232
233 assert!(html.contains("Shared Contacts (0)"), "{html}");
234 assert!(html.contains("No shared contacts yet."), "{html}");
235 assert!(!html.contains("data-saves"), "{html}");
236 assert!(!html.contains("role=\"table\""), "{html}");
237 }
238
239 #[test]
240 fn a_buyers_name_goes_to_their_profile() {
241 let html = render(&table(&[buyer("ada")]));
242
243 assert!(html.contains("href=\"/u/ada\""), "{html}");
244 assert!(
245 !html.contains("hx-get=\"/u/ada\""),
246 "a navigation carries no verb: {html}"
247 );
248 assert!(
249 html.contains("Shared Contacts") || html.contains("ada@example.com"),
250 "{html}"
251 );
252 // The address is shown and not linked here, unlike the library's view of
253 // the same data. Both templates say so; see `table`.
254 assert!(!html.contains("mailto:"), "{html}");
255 }
256
257 #[test]
258 fn a_username_cannot_smuggle_markup() {
259 let html = render(&table(&[buyer("<script>x()</script>")]));
260 assert!(!html.contains("<script>x()"), "{html}");
261 }
262 }
263