api: serve html · seoul.systems/microcosm-rs@c3224bb

+159 -2

Cargo.lock

··· 110 110 checksum = "34ac096ce696dc2fcabef30516bb13c0a68a11d30131d3df6f04711467681b04" 111 111 112 112 [[package]] 113 + name = "askama" 114 + version = "0.12.1" 115 + source = "registry+https://github.com/rust-lang/crates.io-index" 116 + checksum = "b79091df18a97caea757e28cd2d5fda49c6cd4bd01ddffd7ff01ace0c0ad2c28" 117 + dependencies = [ 118 + "askama_derive", 119 + "askama_escape", 120 + "humansize", 121 + "num-traits", 122 + "percent-encoding", 123 + ] 124 + 125 + [[package]] 126 + name = "askama_derive" 127 + version = "0.12.5" 128 + source = "registry+https://github.com/rust-lang/crates.io-index" 129 + checksum = "19fe8d6cb13c4714962c072ea496f3392015f0989b1a2847bb4b2d9effd71d83" 130 + dependencies = [ 131 + "askama_parser", 132 + "basic-toml", 133 + "mime", 134 + "mime_guess", 135 + "proc-macro2", 136 + "quote", 137 + "serde", 138 + "syn", 139 + ] 140 + 141 + [[package]] 142 + name = "askama_escape" 143 + version = "0.10.3" 144 + source = "registry+https://github.com/rust-lang/crates.io-index" 145 + checksum = "619743e34b5ba4e9703bba34deac3427c72507c7159f5fd030aea8cac0cfe341" 146 + 147 + [[package]] 148 + name = "askama_parser" 149 + version = "0.2.1" 150 + source = "registry+https://github.com/rust-lang/crates.io-index" 151 + checksum = "acb1161c6b64d1c3d83108213c2a2533a342ac225aabd0bda218278c2ddb00c0" 152 + dependencies = [ 153 + "nom", 154 + ] 155 + 156 + [[package]] 113 157 name = "atomic-waker" 114 158 version = "1.1.2" 115 159 source = "registry+https://github.com/rust-lang/crates.io-index" ··· 176 220 ] 177 221 178 222 [[package]] 223 + name = "axum-extra" 224 + version = "0.10.0" 225 + source = "registry+https://github.com/rust-lang/crates.io-index" 226 + checksum = "460fc6f625a1f7705c6cf62d0d070794e94668988b1c38111baeec177c715f7b" 227 + dependencies = [ 228 + "axum", 229 + "axum-core", 230 + "bytes", 231 + "futures-util", 232 + "headers", 233 + "http", 234 + "http-body", 235 + "http-body-util", 236 + "mime", 237 + "pin-project-lite", 238 + "serde", 239 + "tower", 240 + "tower-layer", 241 + "tower-service", 242 + ] 243 + 244 + [[package]] 179 245 name = "axum-metrics" 180 246 version = "0.2.0" 181 247 source = "registry+https://github.com/rust-lang/crates.io-index" ··· 207 273 208 274 [[package]] 209 275 name = "base64" 276 + version = "0.21.7" 277 + source = "registry+https://github.com/rust-lang/crates.io-index" 278 + checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567" 279 + 280 + [[package]] 281 + name = "base64" 210 282 version = "0.22.1" 211 283 source = "registry+https://github.com/rust-lang/crates.io-index" 212 284 checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" 285 + 286 + [[package]] 287 + name = "basic-toml" 288 + version = "0.1.9" 289 + source = "registry+https://github.com/rust-lang/crates.io-index" 290 + checksum = "823388e228f614e9558c6804262db37960ec8821856535f5c3f59913140558f8" 291 + dependencies = [ 292 + "serde", 293 + ] 213 294 214 295 [[package]] 215 296 name = "bincode" ··· 731 812 ] 732 813 733 814 [[package]] 815 + name = "headers" 816 + version = "0.4.0" 817 + source = "registry+https://github.com/rust-lang/crates.io-index" 818 + checksum = "322106e6bd0cba2d5ead589ddb8150a13d7c4217cf80d7c4f682ca994ccc6aa9" 819 + dependencies = [ 820 + "base64 0.21.7", 821 + "bytes", 822 + "headers-core", 823 + "http", 824 + "httpdate", 825 + "mime", 826 + "sha1", 827 + ] 828 + 829 + [[package]] 830 + name = "headers-accept" 831 + version = "0.1.4" 832 + source = "registry+https://github.com/rust-lang/crates.io-index" 833 + checksum = "244c37aaa637e64fb73af1bb2a4f3f6f2b72f1f39f1cd6f4443f0cc21fe80280" 834 + dependencies = [ 835 + "headers-core", 836 + "http", 837 + "mediatype", 838 + ] 839 + 840 + [[package]] 841 + name = "headers-core" 842 + version = "0.3.0" 843 + source = "registry+https://github.com/rust-lang/crates.io-index" 844 + checksum = "54b4a22553d4242c49fddb9ba998a99962b5cc6f22cb5a3482bec22522403ce4" 845 + dependencies = [ 846 + "http", 847 + ] 848 + 849 + [[package]] 734 850 name = "heck" 735 851 version = "0.5.0" 736 852 source = "registry+https://github.com/rust-lang/crates.io-index" ··· 789 905 checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" 790 906 791 907 [[package]] 908 + name = "humansize" 909 + version = "2.1.3" 910 + source = "registry+https://github.com/rust-lang/crates.io-index" 911 + checksum = "6cb51c9a029ddc91b07a787f1d86b53ccfa49b0e86688c946ebe8d3555685dd7" 912 + dependencies = [ 913 + "libm", 914 + ] 915 + 916 + [[package]] 792 917 name = "hyper" 793 918 version = "1.5.2" 794 919 source = "registry+https://github.com/rust-lang/crates.io-index" ··· 963 1088 ] 964 1089 965 1090 [[package]] 1091 + name = "libm" 1092 + version = "0.2.11" 1093 + source = "registry+https://github.com/rust-lang/crates.io-index" 1094 + checksum = "8355be11b20d696c8f18f6cc018c4e372165b1fa8126cef092399c9951984ffa" 1095 + 1096 + [[package]] 966 1097 name = "libproc" 967 1098 version = "0.14.10" 968 1099 source = "registry+https://github.com/rust-lang/crates.io-index" ··· 1004 1135 version = "0.1.0" 1005 1136 dependencies = [ 1006 1137 "anyhow", 1138 + "askama", 1007 1139 "axum", 1140 + "axum-extra", 1008 1141 "axum-metrics", 1009 1142 "bincode", 1010 1143 "clap", 1011 1144 "ctrlc", 1012 1145 "flume", 1013 1146 "fs4", 1147 + "headers-accept", 1014 1148 "links", 1149 + "mediatype", 1015 1150 "metrics", 1016 1151 "metrics-exporter-prometheus", 1017 1152 "metrics-process", ··· 1083 1218 version = "0.8.4" 1084 1219 source = "registry+https://github.com/rust-lang/crates.io-index" 1085 1220 checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" 1221 + 1222 + [[package]] 1223 + name = "mediatype" 1224 + version = "0.19.18" 1225 + source = "registry+https://github.com/rust-lang/crates.io-index" 1226 + checksum = "8878cd8d1b3c8c8ae4b2ba0a36652b7cf192f618a599a7fbdfa25cffd4ea72dd" 1086 1227 1087 1228 [[package]] 1088 1229 name = "memchr" ··· 1106 1247 source = "registry+https://github.com/rust-lang/crates.io-index" 1107 1248 checksum = "12779523996a67c13c84906a876ac6fe4d07a6e1adb54978378e13f199251a62" 1108 1249 dependencies = [ 1109 - "base64", 1250 + "base64 0.22.1", 1110 1251 "http-body-util", 1111 1252 "hyper", 1112 1253 "hyper-util", ··· 1157 1298 version = "0.3.17" 1158 1299 source = "registry+https://github.com/rust-lang/crates.io-index" 1159 1300 checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" 1301 + 1302 + [[package]] 1303 + name = "mime_guess" 1304 + version = "2.0.5" 1305 + source = "registry+https://github.com/rust-lang/crates.io-index" 1306 + checksum = "f7c44f8e672c00fe5308fa235f821cb4198414e1c77935c1ab6948d3fd78550e" 1307 + dependencies = [ 1308 + "mime", 1309 + "unicase", 1310 + ] 1160 1311 1161 1312 [[package]] 1162 1313 name = "minimal-lexical" ··· 1680 1831 source = "registry+https://github.com/rust-lang/crates.io-index" 1681 1832 checksum = "d6b6f7f2fcb69f747921f79f3926bd1e203fce4fef62c268dd3abfb6d86029aa" 1682 1833 dependencies = [ 1683 - "base64", 1834 + "base64 0.22.1", 1684 1835 "chrono", 1685 1836 "hex", 1686 1837 "indexmap 1.9.3", ··· 2004 2155 version = "1.17.0" 2005 2156 source = "registry+https://github.com/rust-lang/crates.io-index" 2006 2157 checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825" 2158 + 2159 + [[package]] 2160 + name = "unicase" 2161 + version = "2.8.1" 2162 + source = "registry+https://github.com/rust-lang/crates.io-index" 2163 + checksum = "75b844d17643ee918803943289730bec8aac480150456169e647ed0b576ba539" 2007 2164 2008 2165 [[package]] 2009 2166 name = "unicode-ident"

+4

link_aggregator/Cargo.toml

··· 5 5 6 6 [dependencies] 7 7 anyhow = "1.0.95" 8 + askama = "0.12.1" 8 9 axum = "0.8.1" 10 + axum-extra = { version = "0.10.0", features = ["typed-header"] } 9 11 axum-metrics = "0.2" 10 12 bincode = "1.3.3" 11 13 clap = { version = "4.5.26", features = ["derive"] } 12 14 ctrlc = "3.4.5" 13 15 flume = { version = "0.11.1", default-features = false } 14 16 fs4 = { version = "0.12.0", features = ["sync"] } 17 + headers-accept = "0.1.4" 15 18 links = { path = "../links" } 19 + mediatype = "0.19.18" 16 20 metrics = "0.24.1" 17 21 metrics-exporter-prometheus = { version = "0.16.1", default-features = false, features = ["http-listener"] } 18 22 metrics-process = "2.4.0"

+2 -1

link_aggregator/readme.md

··· 110 110 - [x] handle shutdown cleanly -- be nice to rocksdb 111 111 - [x] add user-agent to jetstream request 112 112 - [ ] wow the shutdown stuff i wrote is really bad and doesn't work a lot 113 - - [ ] serve html for browser requests 113 + - [~] serve html for browser requests 114 114 - [ ] add a health check endpoint 115 115 - [ ] add seq numbers to metrics 116 116 - [ ] persist the jetstream server url, error if started with a different one (maybe with --switch-streams or something) ··· 120 120 - [x] add rkey to linkers 🤦‍♀️ 121 121 - [x] don't remove deleted links from the reverse records -- null them out. this will keep things stable for paging. 122 122 - [x] don't show deactivated accounts in link responses 123 + - [ ] canonicalize handles to dids! 123 124 - [ ] links: 124 125 - [~] pull `$type`/`type` from object children of arrays (distinguish replies, quotes, etc) 125 126 - just $type to start

+18 -3

link_aggregator/src/server.rs link_aggregator/src/server/mod.rs

··· 1 - use axum::{extract::Query, http, routing::get, Json, Router}; 1 + use askama::Template; 2 + use axum::{ 3 + extract::Query, 4 + http, 5 + response::{IntoResponse, Json}, 6 + routing::get, 7 + Router, 8 + }; 2 9 use bincode::Options; 3 10 use serde::{Deserialize, Serialize}; 4 11 use serde_with::serde_as; ··· 9 16 10 17 use crate::storage::LinkReader; 11 18 use link_aggregator::RecordId; 19 + 20 + mod acceptable; 21 + 22 + use acceptable::{acceptable, ExtractAccept}; 12 23 13 24 const DEFAULT_CURSOR_LIMIT: u64 = 16; 14 25 const DEFAULT_CURSOR_LIMIT_MAX: u64 = 100; ··· 52 63 Ok(()) 53 64 } 54 65 55 - async fn hello() -> &'static str { 56 - "helloooo\n" 66 + #[derive(Template, Serialize, Deserialize)] 67 + #[template(path = "hello.html.j2")] 68 + struct HelloReponse {} 69 + async fn hello(accept: ExtractAccept) -> impl IntoResponse { 70 + let o = HelloReponse {}; 71 + acceptable(accept, o) 57 72 } 58 73 59 74 #[derive(Deserialize)]

+22

link_aggregator/src/server/acceptable.rs

··· 1 + use askama::Template; 2 + use axum::response::{Html, IntoResponse, Json, Response}; 3 + use axum_extra::TypedHeader; 4 + use headers_accept::Accept; 5 + use mediatype::names::{APPLICATION, HTML, JSON, TEXT}; 6 + use mediatype::MediaType; 7 + use serde::Serialize; 8 + 9 + const TEXT_HTML: MediaType = MediaType::new(TEXT, HTML); 10 + const APPLICATION_JSON: MediaType = MediaType::new(APPLICATION, JSON); 11 + const AVAILABLE: &[MediaType] = &[APPLICATION_JSON, TEXT_HTML]; 12 + 13 + pub type ExtractAccept = Option<TypedHeader<Accept>>; 14 + 15 + pub fn acceptable<T: Serialize + Template>(accept: ExtractAccept, thing: T) -> Response { 16 + if let Some(accepting) = accept { 17 + if accepting.negotiate(AVAILABLE) == Some(&TEXT_HTML) { 18 + return Html(thing.render().unwrap()).into_response(); // TODO 19 + } 20 + } 21 + Json(thing).into_response() 22 + }

+26

link_aggregator/templates/base.html.j2

··· 1 + <!doctype html> 2 + <html lang="en"> 3 + <head> 4 + <meta charset="utf8"> 5 + <title>{% block title %}{% endblock %} — Link Aggregator</title> 6 + <meta name="viewport" content="width=device-width, initial-scale=1" /> 7 + <style> 8 + body { 9 + font-family: sans-serif; 10 + } 11 + code { 12 + background: #cdf; 13 + display: inline-block; 14 + font-size: 1em; 15 + padding: 0 0.3em; 16 + border-radius: 0.2em; 17 + } 18 + h1, h2, h3, h4 { 19 + margin-top: 1.618em; 20 + } 21 + </style> 22 + </head> 23 + <body> 24 + {% block content %}{% endblock %} 25 + </body> 26 + </html>

+81

link_aggregator/templates/hello.html.j2

··· 1 + {% extends "base.html.j2" %} 2 + 3 + {% block title %}Hello!{% endblock %} 4 + 5 + {% block content %} 6 + <h1>This is an <a href="https://github.com/at-ucosm/links/tree/main/link_aggregator">atproto link aggregator</a> server from <a href="https://github.com/at-ucosm">µcosm</a>!</h1> 7 + 8 + <p>Every interaction in Bluesky and atproto at large tends to appear as a <em>link</em> from a new repository record to <em>somewhere</em>: liking a post creates a record with a link to the post, blocking a spammer creates a record with reference to their DID.</p> 9 + 10 + <p>This service attempts to aggregate all of these links, globally, from all content coming throught the firehose. It provides generic API endpoints to answer questions like <strong>how many likes does a post have</strong> and <strong>who follows a user</strong>.</p> 11 + 12 + <p>It is very much a <strong>work in progress</strong>. The database has not been backfilled, so any interactions occurring before its last reset will be missing.</p> 13 + 14 + <p><small>µcosm ("microcosm") is a project by <a href="https://bsky.app/profile/bad-example.com">@bad-example.com</a>, making building apps on atproto easier.</small></p> 15 + 16 + <h2>Endpoints</h2> 17 + 18 + <h3><code>GET /links</code></h3> 19 + 20 + <p>A list of records linking to a target.</p> 21 + 22 + <h4>Query parameters:</h4> 23 + 24 + <ul> 25 + <li><code>target</code>: required, must url-encode. Example: <code>did:plc:vc7f4oafdgxsihk4cry2xpze</code></li> 26 + <li><code>collection</code>: required. Example: <code>app.bsky.feed.follow</code></li> 27 + <li><code>path</code>: required, must url-encode. Example: <code>.subject</code></li> 28 + </ul> 29 + 30 + <p><strong>Live example:</strong> <code><a href="/links?target=at://did:plc:vc7f4oafdgxsihk4cry2xpze/app.bsky.feed.post/3lgwdn7vd722r&collection=app.bsky.feed.like&path=.subject.uri">/links?target=at://did:plc:vc7f4oafdgxsihk4cry2xpze/app.bsky.feed.post/3lgwdn7vd722r&collection=app.bsky.feed.like&path=.subject.uri</a></code></p> 31 + 32 + 33 + <h3><code>GET /links/count</code></h3> 34 + 35 + <p>The total number of links pointing at a given target.</p> 36 + 37 + <h4>Query parameters:</h4> 38 + 39 + <ul> 40 + <li><code>target</code>: required, must url-encode. Example: <code>did:plc:vc7f4oafdgxsihk4cry2xpze</code></li> 41 + <li><code>collection</code>: required. Example: <code>app.bsky.feed.follow</code></li> 42 + <li><code>path</code>: required, must url-encode. Example: <code>.subject</code></li> 43 + <li><code>cursor</code>: optional, see Definitions.</li> 44 + </ul> 45 + 46 + <p><strong>Live example:</strong> <code><a href="/links/count?target=at://did:plc:vc7f4oafdgxsihk4cry2xpze/app.bsky.feed.post/3lgwdn7vd722r&collection=app.bsky.feed.like&path=.subject.uri">/links/count?target=at://did:plc:vc7f4oafdgxsihk4cry2xpze/app.bsky.feed.post/3lgwdn7vd722r&collection=app.bsky.feed.like&path=.subject.uri</a></code></p> 47 + 48 + 49 + <h3><code>GET /links/all/count</code></h3> 50 + 51 + <p>The total number of links pointing at a given target from any collection and path.</p> 52 + 53 + <h4>Query parameters:</h4> 54 + 55 + <ul> 56 + <li><code>target</code>: required, must url-encode. Example: <code>did:plc:vc7f4oafdgxsihk4cry2xpze</code></li> 57 + </ul> 58 + 59 + <p><strong>Live example:</strong> <code><a href="/links/all/count?target=did:plc:vc7f4oafdgxsihk4cry2xpze">/links/all/count?target=did:plc:vc7f4oafdgxsihk4cry2xpze</a></code></p> 60 + 61 + 62 + <h2>Definitions</h2> 63 + 64 + <h3>Target</h3> 65 + 66 + <p>A DID like <code>did:plc:hdhoaan3xa3jiuq4fg4mefid</code>, or an AT-URI like <code>at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3lgu4lg6j2k2v</code>, or a URI like <code>https://example.com</code>.</p> 67 + 68 + <h3>Collection</h3> 69 + 70 + <p>A record NSID like <code>app.bsky.feed.like</code>.</p> 71 + 72 + <h3>Path</h3> 73 + 74 + <p>A (currently-very-very-hacky) json-path-ish representation of the source of a link in a record. Records may contain multiple links with different meanings, so this specifies which specific link is of interest. Like <code>.subject.uri</code>.</p> 75 + 76 + <h3>Cursor</h3> 77 + 78 + <p>Paged responses include a <code>cursor</code> property. When it's <code>null</code>, no more data is available. If it's not null, you can repeat the request with <code>&cursor=<cursor></code> in the URL query to get the next set of responses.</p> 79 + 80 + 81 + {% endblock %}

Configure Feed

Configure Feed