Compare commits
3 Commits
11d7f8b0d0
...
08586f0a7a
| Author | SHA1 | Date | |
|---|---|---|---|
| 08586f0a7a | |||
| 6493476565 | |||
| d5067ff381 |
22
README.md
Normal file
22
README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
[`utoipa`]: https://docs.rs/utoipa/latest/utoipa/
|
||||
[`axum`]: https://docs.rs/axum/latest/axum/
|
||||
|
||||
# Mark's webpage
|
||||
|
||||
This is the source code behind [betalupi.com](https://betalupi.com), featuring a very efficient mini web framework written from scratch in Rust. It uses...
|
||||
- [Axum](https://github.com/tokio-rs/axum) as an http server
|
||||
- [Maud](https://maud.lambda.xyz/) for html templates
|
||||
- [Grass](https://github.com/connorskees/grass) to parse and compile [sass](https://sass-lang.com/)
|
||||
- [markdown-it](https://github.com/markdown-it-rust/markdown-it) to convert md to html
|
||||
|
||||
|
||||
## Overview & Arch:
|
||||
- [`bin/webpage`](./crates/bin/webpage/): Simple cli that starts `service-webpage`
|
||||
- [`lib/libservice`](./crates/lib/libservice): Provides the `Service` trait. A service is a group of http routes with an optional [`utoipa`] schema. \
|
||||
This library decouples compiled binaries from the services they provide, and makes sure all services are self-contained.
|
||||
- [`lib/page`](./crates/lib/page): Provides [PageServer], which builds an [`axum`] router that provides a caching and headers for resources served through http.
|
||||
- Also provides [Servable], which is a trait for any resource that may be served.
|
||||
- the [Page] servable serves html generated by a closure.
|
||||
- the [StaticAsset] servable serves static assets (css, images, misc files), and provides transformation utilties for image assets (via [`pixel-transform`](./crates/lib/pixel-transform)).
|
||||
|
||||
- [`service/service-webpage`](./crates/service/service-webpage): A `Service` that runs a `PageServer` that provides the content on [betalupi.com](https://betalupi.com)
|
||||
@@ -93,9 +93,7 @@ impl Default for Page {
|
||||
fn default() -> Self {
|
||||
Page {
|
||||
meta: Default::default(),
|
||||
html_ttl: Some(TimeDelta::seconds(60 * 60 * 24 * 30)),
|
||||
//css_ttl: Duration::from_secs(60 * 60 * 24 * 30),
|
||||
//generate_css: None,
|
||||
html_ttl: Some(TimeDelta::days(1)),
|
||||
generate_html: Box::new(|_, _| Box::pin(async { html!() })),
|
||||
immutable: true,
|
||||
}
|
||||
|
||||
@@ -52,6 +52,29 @@ pub trait Servable: Send + Sync {
|
||||
) -> Pin<Box<dyn Future<Output = Rendered> + 'a + Send + Sync>>;
|
||||
}
|
||||
|
||||
pub struct Default404 {}
|
||||
impl Servable for Default404 {
|
||||
fn render<'a>(
|
||||
&'a self,
|
||||
_ctx: &'a RequestContext,
|
||||
) -> Pin<Box<dyn Future<Output = Rendered> + 'a + Send + Sync>> {
|
||||
Box::pin(async {
|
||||
return Rendered {
|
||||
code: StatusCode::NOT_FOUND,
|
||||
body: RenderedBody::String("page not found".into()),
|
||||
ttl: Some(TimeDelta::days(1)),
|
||||
immutable: true,
|
||||
headers: HeaderMap::new(),
|
||||
mime: Some(MimeType::Html),
|
||||
};
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// MARK: server
|
||||
//
|
||||
|
||||
pub struct PageServer {
|
||||
/// If true, expired pages will be rerendered before being sent to the user.
|
||||
/// If false, requests never trigger rerenders. We rely on the rerender task.
|
||||
@@ -61,7 +84,9 @@ pub struct PageServer {
|
||||
never_rerender_on_request: bool,
|
||||
|
||||
/// Map of `{ route: page }`
|
||||
pages: Arc<Mutex<HashMap<String, Arc<dyn Servable>>>>,
|
||||
pages: Mutex<HashMap<String, Arc<dyn Servable>>>,
|
||||
|
||||
notfound: Mutex<Arc<dyn Servable>>,
|
||||
|
||||
/// Map of `{ route: (page data, expire time) }`
|
||||
///
|
||||
@@ -75,12 +100,19 @@ impl PageServer {
|
||||
let cache_size = NonZero::new(128).unwrap();
|
||||
|
||||
Arc::new(Self {
|
||||
pages: Arc::new(Mutex::new(HashMap::new())),
|
||||
pages: Mutex::new(HashMap::new()),
|
||||
page_cache: Mutex::new(LruCache::new(cache_size)),
|
||||
never_rerender_on_request: true,
|
||||
notfound: Mutex::new(Arc::new(Default404 {})),
|
||||
})
|
||||
}
|
||||
|
||||
/// Set this server's "not found" page
|
||||
pub fn with_404<S: Servable + 'static>(&self, page: S) -> &Self {
|
||||
*self.notfound.lock() = Arc::new(page);
|
||||
self
|
||||
}
|
||||
|
||||
pub fn add_page<S: Servable + 'static>(&self, route: impl Into<String>, page: S) -> &Self {
|
||||
#[expect(clippy::expect_used)]
|
||||
let route = route
|
||||
@@ -102,23 +134,23 @@ impl PageServer {
|
||||
reason: &'static str,
|
||||
route: &str,
|
||||
ctx: RequestContext,
|
||||
) -> Option<(Rendered, Option<DateTime<Utc>>)> {
|
||||
) -> (Rendered, Option<DateTime<Utc>>) {
|
||||
let now = Utc::now();
|
||||
let start = Instant::now();
|
||||
|
||||
let page = match self.pages.lock().get(route) {
|
||||
Some(x) => x.clone(),
|
||||
None => return None,
|
||||
None => self.notfound.lock().clone(),
|
||||
};
|
||||
|
||||
trace!(
|
||||
message = "Rendering page",
|
||||
route,
|
||||
route = route.to_owned(),
|
||||
reason,
|
||||
lock_time_ms = start.elapsed().as_millis()
|
||||
);
|
||||
|
||||
let rendered = page.render(&ctx).await;
|
||||
//let html = (self.render_page)(&page, &req_ctx).await.0;
|
||||
|
||||
let mut expires = None;
|
||||
if let Some(ttl) = rendered.ttl {
|
||||
@@ -129,8 +161,13 @@ impl PageServer {
|
||||
}
|
||||
|
||||
let elapsed = start.elapsed().as_millis();
|
||||
trace!(message = "Rendered page", route, reason, time_ms = elapsed);
|
||||
return Some((rendered, expires));
|
||||
trace!(
|
||||
message = "Rendered page",
|
||||
route = route.to_owned(),
|
||||
reason,
|
||||
time_ms = elapsed
|
||||
);
|
||||
return (rendered, expires);
|
||||
}
|
||||
|
||||
async fn handler(
|
||||
@@ -206,30 +243,7 @@ impl PageServer {
|
||||
|
||||
if html_expires.is_none() {
|
||||
cached = false;
|
||||
html_expires = match state.render_page("request", &route, ctx).await {
|
||||
Some(x) => Some(x.clone()),
|
||||
None => {
|
||||
trace!(
|
||||
message = "Not found",
|
||||
route,
|
||||
addr = ?addr.addr,
|
||||
user_agent = ua,
|
||||
device_type = ?client_info.device_type
|
||||
);
|
||||
|
||||
trace!(
|
||||
message = "Served route",
|
||||
route,
|
||||
addr = ?addr.addr,
|
||||
user_agent = ua,
|
||||
device_type = ?client_info.device_type,
|
||||
cached,
|
||||
time_ns = start.elapsed().as_nanos()
|
||||
);
|
||||
|
||||
return StatusCode::NOT_FOUND.into_response();
|
||||
}
|
||||
};
|
||||
html_expires = Some(state.render_page("request", &route, ctx).await);
|
||||
}
|
||||
|
||||
#[expect(clippy::unwrap_used)]
|
||||
|
||||
@@ -81,9 +81,11 @@ body {
|
||||
color: var(--fgColor);
|
||||
}
|
||||
|
||||
main {
|
||||
margin-top: 2ex;
|
||||
overflow-wrap: break-word;
|
||||
div.wrapper {
|
||||
min-height: 100vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
hr.footline {
|
||||
@@ -92,18 +94,14 @@ hr.footline {
|
||||
|
||||
hr {
|
||||
border: 1pt dashed;
|
||||
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
iframe {
|
||||
max-width: 90%;
|
||||
}
|
||||
|
||||
.wrapper {
|
||||
min-height: 100vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
.footContainer {
|
||||
padding-top: 0;
|
||||
|
||||
@@ -262,7 +262,7 @@ pub fn handouts() -> Page {
|
||||
br {}
|
||||
};
|
||||
|
||||
page_wrapper(&page.meta, inner).await
|
||||
page_wrapper(&page.meta, inner, true).await
|
||||
})
|
||||
}),
|
||||
}
|
||||
|
||||
@@ -16,7 +16,7 @@ pub fn index() -> Page {
|
||||
meta: PageMetadata {
|
||||
title: "Betalupi: About".into(),
|
||||
author: Some("Mark".into()),
|
||||
description: Some("Description".into()),
|
||||
description: None,
|
||||
image: Some("/assets/img/icon.png".to_owned()),
|
||||
backlinks: Some(false),
|
||||
},
|
||||
@@ -74,7 +74,7 @@ pub fn index() -> Page {
|
||||
(Markdown(include_str!("index.md")))
|
||||
};
|
||||
|
||||
page_wrapper(&page.meta, inner).await
|
||||
page_wrapper(&page.meta, inner, true).await
|
||||
})
|
||||
}),
|
||||
|
||||
|
||||
@@ -10,9 +10,11 @@ use crate::components::{
|
||||
|
||||
mod handouts;
|
||||
mod index;
|
||||
mod notfound;
|
||||
|
||||
pub use handouts::handouts;
|
||||
pub use index::index;
|
||||
pub use notfound::notfound;
|
||||
|
||||
pub fn links() -> Page {
|
||||
/*
|
||||
@@ -67,7 +69,7 @@ fn page_from_markdown(md: impl Into<String>, default_image: Option<String>) -> P
|
||||
meta,
|
||||
immutable: true,
|
||||
|
||||
html_ttl: Some(TimeDelta::seconds(60 * 24 * 30)),
|
||||
html_ttl: Some(TimeDelta::days(1)),
|
||||
generate_html: Box::new(move |page, ctx| {
|
||||
let html = html.clone();
|
||||
|
||||
@@ -80,7 +82,7 @@ fn page_from_markdown(md: impl Into<String>, default_image: Option<String>) -> P
|
||||
(html)
|
||||
};
|
||||
|
||||
page_wrapper(&page.meta, inner).await
|
||||
page_wrapper(&page.meta, inner, true).await
|
||||
})
|
||||
}),
|
||||
}
|
||||
@@ -93,6 +95,7 @@ fn page_from_markdown(md: impl Into<String>, default_image: Option<String>) -> P
|
||||
pub fn page_wrapper<'a>(
|
||||
meta: &'a PageMetadata,
|
||||
inner: Markup,
|
||||
footer: bool,
|
||||
) -> Pin<Box<dyn Future<Output = Markup> + 'a + Send + Sync>> {
|
||||
Box::pin(async move {
|
||||
html! {
|
||||
@@ -110,6 +113,9 @@ pub fn page_wrapper<'a>(
|
||||
title { (PreEscaped(meta.title.clone())) }
|
||||
|
||||
|
||||
// Use a small blurred placeholder while full-size images load.
|
||||
// Requires no other special scripts or css, just add some tags
|
||||
// to your <img>!
|
||||
script {
|
||||
(PreEscaped("
|
||||
window.onload = function() {
|
||||
@@ -133,27 +139,36 @@ pub fn page_wrapper<'a>(
|
||||
}
|
||||
|
||||
body {
|
||||
div class="wrapper" {
|
||||
main { (inner) }
|
||||
main{
|
||||
div class="wrapper" style=(
|
||||
// for 404 page. Margin makes it scroll.
|
||||
match footer {
|
||||
true => "margin-top:3ex;",
|
||||
false =>""
|
||||
}
|
||||
) {
|
||||
(inner)
|
||||
|
||||
footer {
|
||||
hr class = "footline" {}
|
||||
div class = "footContainer" {
|
||||
p {
|
||||
"This site was built by hand with "
|
||||
(FarLink("https://rust-lang.org", "Rust"))
|
||||
", "
|
||||
(FarLink("https://maud.lambda.xyz", "Maud"))
|
||||
", "
|
||||
(FarLink("https://github.com/connorskees/grass", "Grass"))
|
||||
", and "
|
||||
(FarLink("https://docs.rs/axum/latest/axum", "Axum"))
|
||||
"."
|
||||
@if footer {
|
||||
footer {
|
||||
hr class = "footline" {}
|
||||
div class = "footContainer" {
|
||||
p {
|
||||
"This site was built by hand with "
|
||||
(FarLink("https://rust-lang.org", "Rust"))
|
||||
", "
|
||||
(FarLink("https://maud.lambda.xyz", "Maud"))
|
||||
", "
|
||||
(FarLink("https://github.com/connorskees/grass", "Grass"))
|
||||
", and "
|
||||
(FarLink("https://docs.rs/axum/latest/axum", "Axum"))
|
||||
"."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
32
crates/service/service-webpage/src/pages/notfound.rs
Normal file
32
crates/service/service-webpage/src/pages/notfound.rs
Normal file
@@ -0,0 +1,32 @@
|
||||
use maud::html;
|
||||
use page::page::{Page, PageMetadata};
|
||||
|
||||
use crate::pages::page_wrapper;
|
||||
|
||||
pub fn notfound() -> Page {
|
||||
Page {
|
||||
meta: PageMetadata {
|
||||
title: "Betalupi: About".into(),
|
||||
author: None,
|
||||
description: None,
|
||||
image: Some("/assets/img/icon.png".to_owned()),
|
||||
backlinks: Some(false),
|
||||
},
|
||||
|
||||
generate_html: Box::new(move |page, _ctx| {
|
||||
Box::pin(async {
|
||||
let inner = html! {
|
||||
div style="display:flex;flex-direction:column;align-items:center;justify-content:center;min-height:100vh" {
|
||||
p style="font-weight:bold;font-size:50pt;margin:0;" { "404" }
|
||||
p style="font-size:13pt;margin:0;color:var(--grey);" { "(page not found)" }
|
||||
a style="font-size:12pt;margin:10pt;padding:5px;" href="/" {"<- Back to site"}
|
||||
}
|
||||
};
|
||||
|
||||
page_wrapper(&page.meta, inner, false).await
|
||||
})
|
||||
}),
|
||||
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,7 @@ fn build_server() -> Arc<PageServer> {
|
||||
|
||||
#[expect(clippy::unwrap_used)]
|
||||
server
|
||||
.with_404(pages::notfound())
|
||||
.add_page("/", pages::index())
|
||||
.add_page("/links", pages::links())
|
||||
.add_page("/whats-a-betalupi", pages::betalupi())
|
||||
|
||||
Reference in New Issue
Block a user