ordinary-app 0.6.0

Application server for Ordinary
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
// Copyright (C) 2026 Ordinary Labs, LLC.
//
// SPDX-License-Identifier: AGPL-3.0-only

use crate::server::ops::assets::get_asset_to_res;
use arrayvec::ArrayVec;
use async_compression::Level;
use async_compression::tokio::write::{BrotliEncoder, GzipEncoder, ZlibEncoder, ZstdEncoder};
use axum::body::Bytes;
use axum::extract::{MatchedPath, Path, Request, State};
use axum::http::header::CONTENT_TYPE;
use axum::http::{HeaderValue, StatusCode, header};
use axum::response::{IntoResponse, Redirect};
use axum_extra::extract::CookieJar;
use base64::{Engine as B64Engine, engine::general_purpose::URL_SAFE_NO_PAD as b64};
use hyper::HeaderMap;
use ordinary_config::{CompressionAlgorithm, StoredCache};
use ordinary_storage::{CacheCompression, CacheDependency, CacheRead, CacheWrite};
use ordinary_template::{Template, TemplateResult};
use ordinary_utils::middleware::{check_if_none_match, get_etag_hash};
use ordinary_utils::{GMT_FORMAT, get_host};
use std::sync::Arc;
use time::{Duration, UtcDateTime};
use tokio::io::AsyncWriteExt;
use tracing::{Instrument, Span};

fn insert_headers(
    template: &Template,
    header_map: &mut HeaderMap,
    etag: &str,
    last_modified: &str,
) {
    if let Ok(etag) = HeaderValue::from_str(etag) {
        header_map.insert(header::ETAG, etag);
    }

    if let Ok(last_modified) = HeaderValue::from_str(last_modified) {
        header_map.insert(header::LAST_MODIFIED, last_modified);
    }

    if let Some(cache_control) = &template.cache_control
        && let Ok(cache_control) = HeaderValue::from_str(cache_control.as_str())
    {
        header_map.insert(header::CACHE_CONTROL, cache_control);
    }

    if let Some(cache) = &template.config.cache
        && let Some(http_cache) = &cache.http
        && let Some(expires_s) = http_cache.expires
    {
        let future = UtcDateTime::now() + Duration::seconds(expires_s.cast_signed());

        if let Ok(formatted) = future.format(&GMT_FORMAT)
            && let Ok(expires) = HeaderValue::from_str(formatted.as_str())
        {
            header_map.insert(header::EXPIRES, expires);
        }
    }
}

#[allow(clippy::too_many_lines)]
pub async fn get(
    State(state): State<Arc<crate::server::OrdinaryAppServerState>>,
    jar: CookieJar,
    matched_path: MatchedPath,
    req: Request,
) -> Result<impl IntoResponse, (StatusCode, Redirect)> {
    let span = tracing::info_span!(
        "template",
        i = tracing::field::Empty,
        nm = tracing::field::Empty,
    );

    let uri = req.uri();
    let headers = req.headers();

    // todo: normalize and join query for refs that are included in config.
    //
    // todo: including every permutation of the QueryString would lead to
    // todo: unnecessary cache duplicates.
    let path_and_query = req.uri().path();

    async {
        let Some(host) = get_host(headers, uri) else {
            tracing::error!("no host");
            return Ok(StatusCode::BAD_REQUEST.into_response());
        };

        let params = uri.query().map(ToString::to_string);

        let token: Vec<u8>;
        let mut claims = None;

        if let Some(idx) = state.template_route_map.get(matched_path.as_str()) {
            if let Some(template) = state.templates.get(*idx) {
                span.record("i", template.idx);
                span.record("nm", tracing::field::display(&template.config.name));

                if let Some(_check) = &template.config.protected {
                    let cookie_name = if state.secure_cookies {
                        "__Host-ORDINARY-ACCESS-TOKEN"
                    } else {
                        "ORDINARY-ACCESS-TOKEN"
                    };

                    token = if let Some(token) = jar.get(cookie_name) {
                        if let Ok(token) = b64.decode(token.value()) {
                            token
                        } else {
                            return Err((
                                StatusCode::UNAUTHORIZED,
                                Redirect::to("/accounts/access/redirect"),
                            ));
                        }
                    } else {
                        return Err((
                            StatusCode::UNAUTHORIZED,
                            Redirect::to("/accounts/access/redirect"),
                        ));
                    };

                    match state.auth.verify_access_token(&token) {
                        Ok((_account, real_claims)) => {
                            claims = Some(real_claims);
                        }
                        Err(_) => {
                            return Err((
                                StatusCode::UNAUTHORIZED,
                                Redirect::to("/accounts/access/redirect"),
                            ));
                        }
                    }
                }

                let mut compression_opts = ArrayVec::<CacheCompression, 4>::new();
                let mut header_map = HeaderMap::with_capacity(11);

                insert_base_headers(template, &mut header_map);

                let cache_span = tracing::info_span!("cache");

                if let Some(cache) = &template.config.cache
                    && let Some(stored_cache) = &cache.stored
                {
                    set_compression_opts(headers, &mut compression_opts, &cache_span, stored_cache);

                    if let Ok(Some((hit, compression))) = async {
                        state
                            .storage
                            .cache
                            .check(
                                &CacheRead::Template,
                                &compression_opts,
                                template.idx,
                                path_and_query,
                            )
                            .await
                    }
                    .instrument(cache_span.clone())
                    .await
                        && let Ok(root) = flexbuffers::Reader::get_root(hit.as_ref())
                    {
                        let root_vec = root.as_vector();

                        let etag = root_vec.idx(1).as_str();
                        let last_modified = root_vec.idx(2).as_str();
                        let res = root_vec.idx(3).as_blob().0;

                        return Ok(process_response(
                            true,
                            headers,
                            template,
                            header_map,
                            compression,
                            etag,
                            last_modified,
                            res,
                        )
                        .into_response());
                    }
                }

                {
                    match template.render(
                        host.as_str(),
                        path_and_query.into(),
                        params.clone(),
                        None,
                        None,
                        &claims,
                    ) {
                        Ok(res) => {
                            let mut res = match res {
                                TemplateResult::Result(bytes) => bytes,
                                TemplateResult::StatusCode(code) => return Ok(code.into_response()),
                            };

                            let mut etag = cache_span.in_scope(|| {
                                if let Some(config) = &template.config.cache
                                    && let Some(http_cache) = &config.http
                                {
                                    get_etag_hash(res.as_ref(), Some(http_cache))
                                } else {
                                    get_etag_hash(res.as_ref(), None)
                                }
                            });

                            let Ok(last_modified) = UtcDateTime::now().format(&GMT_FORMAT) else {
                                return Ok(StatusCode::INTERNAL_SERVER_ERROR.into_response());
                            };

                            let last_modified_str = last_modified.as_str();

                            let mut cache_compression = None;

                            if let Some(cache) = &template.config.cache
                                && let Some(stored_cache) = &cache.stored
                            {
                                async {
                                    if let Some(compression) = compression_opts.first() {
                                        res = get_compressed_res(&res, compression).await;

                                        cache_compression = Some(compression);
                                        etag.push(compression.as_char());
                                    }

                                    if let Err(err) = state
                                        .storage
                                        .cache
                                        .write(
                                            CacheWrite::Template(
                                                etag.as_str(),
                                                last_modified_str,
                                                &res,
                                            ),
                                            cache_compression,
                                            template.idx,
                                            stored_cache,
                                            path_and_query,
                                            // todo: pass in `Model` dependency UUIDs
                                            if template.config.content.is_some() {
                                                vec![CacheDependency::Content]
                                            } else {
                                                vec![]
                                            },
                                        )
                                        .await
                                    {
                                        tracing::error!(%err, "failed to write to cache");
                                    }
                                }
                                .instrument(cache_span)
                                .await;
                            }

                            return Ok(process_response(
                                false,
                                headers,
                                template,
                                header_map,
                                cache_compression,
                                etag.as_str(),
                                last_modified_str,
                                res.as_ref(),
                            )
                            .into_response());
                        }
                        Err(err) => tracing::error!("{err}"),
                    }
                }
            }
        } else {
            tracing::warn!("no template for route '{:?}'", matched_path);
        }

        if let Some(idx) = state.error_template_idx
            && let Some(err_template) = state.templates.get(idx as usize)
        {
            match err_template.render(
                host.as_str(),
                "/error".into(),
                params,
                Some(("no template for this route".into(), 404)),
                None,
                &claims,
            ) {
                Ok(res) => {
                    return match res {
                        TemplateResult::Result(bytes) => Ok((
                            StatusCode::NOT_FOUND,
                            [(CONTENT_TYPE, err_template.mime.clone())],
                            bytes,
                        )
                            .into_response()),
                        TemplateResult::StatusCode(code) => return Ok(code.into_response()),
                    };
                }
                Err(err) => tracing::error!("{err}"),
            }
        } else if let Some(error_config) = &state.config.error
            && let Some(asset_name) = &error_config.asset
        {
            return Ok(get_asset_to_res(
                state.clone(),
                Some(asset_name.clone()),
                uri.clone(),
                headers.clone(),
                true,
            )
            .into_response());
        }

        Ok((
            StatusCode::NOT_FOUND,
            [(CONTENT_TYPE, "text/plain")],
            Bytes::copy_from_slice(b"no template for the specified route"),
        )
            .into_response())
    }
    .instrument(span.clone())
    .await
}

async fn get_compressed_res(res: &Bytes, compression: &CacheCompression) -> Bytes {
    match compression {
        CacheCompression::Gzip => {
            let mut encoder = GzipEncoder::new(Vec::new());
            if let Err(err) = encoder.write_all(res.as_ref()).await {
                tracing::error!(%err);
            }
            if let Err(err) = encoder.shutdown().await {
                tracing::error!(%err);
            }
            Bytes::copy_from_slice(encoder.into_inner().as_slice())
        }
        CacheCompression::Zstd { level } => {
            let mut encoder =
                ZstdEncoder::with_quality(Vec::new(), Level::Precise(i32::from(*level)));
            if let Err(err) = encoder.write_all(res.as_ref()).await {
                tracing::error!(%err);
            }
            if let Err(err) = encoder.shutdown().await {
                tracing::error!(%err);
            }
            Bytes::copy_from_slice(encoder.into_inner().as_slice())
        }
        CacheCompression::Brotli => {
            let mut encoder = BrotliEncoder::new(Vec::new());
            if let Err(err) = encoder.write_all(res.as_ref()).await {
                tracing::error!(%err);
            }
            if let Err(err) = encoder.shutdown().await {
                tracing::error!(%err);
            }
            Bytes::copy_from_slice(encoder.into_inner().as_slice())
        }
        CacheCompression::Deflate => {
            let mut encoder = ZlibEncoder::new(Vec::new());
            if let Err(err) = encoder.write_all(res.as_ref()).await {
                tracing::error!(%err);
            }
            if let Err(err) = encoder.shutdown().await {
                tracing::error!(%err);
            }
            Bytes::copy_from_slice(encoder.into_inner().as_slice())
        }
    }
}

#[allow(clippy::too_many_arguments)]
fn process_response(
    check_last_modified: bool,
    headers: &HeaderMap,
    template: &Template,
    mut header_map: HeaderMap,
    compression: Option<&CacheCompression>,
    etag: &str,
    last_modified: &str,
    res: &[u8],
) -> impl IntoResponse {
    insert_headers(template, &mut header_map, etag, last_modified);

    if let Some(etag) = check_if_none_match(headers, etag)
        && let Ok(etag_header) = HeaderValue::from_str(etag)
    {
        header_map.insert(header::ETAG, etag_header);

        (StatusCode::NOT_MODIFIED, header_map).into_response()
    } else if check_last_modified
        && let Some(if_modified_since) = headers.get(header::IF_MODIFIED_SINCE)
        && let Ok(if_modified_since_str) = if_modified_since.to_str()
        && let Ok(if_modified_since) = UtcDateTime::parse(if_modified_since_str, &GMT_FORMAT)
        && let Ok(last_modified) = UtcDateTime::parse(last_modified, &GMT_FORMAT)
        && if_modified_since >= last_modified
    {
        (StatusCode::NOT_MODIFIED, header_map).into_response()
    } else {
        if let Some(compression) = compression {
            header_map.insert(
                header::CONTENT_ENCODING,
                HeaderValue::from_static(compression.as_str()),
            );
        }

        header_map.insert(CONTENT_TYPE, template.mime.clone());

        (StatusCode::OK, header_map, Bytes::copy_from_slice(res)).into_response()
    }
}

fn set_compression_opts(
    headers: &HeaderMap,
    compression_opts: &mut ArrayVec<CacheCompression, 4>,
    cache_span: &Span,
    stored_cache: &StoredCache,
) {
    cache_span.in_scope(|| {
        if let Some(compression) = &stored_cache.internal_compression
            && let Some(compressions) = headers.get(header::ACCEPT_ENCODING)
            && let Ok(compressions_str) = compressions.to_str()
        {
            for compression in compression {
                match compression {
                    CompressionAlgorithm::Brotli => {
                        if compressions_str.contains("br") {
                            compression_opts.push(CacheCompression::Brotli);
                        }
                    }
                    CompressionAlgorithm::Deflate => {
                        if compressions_str.contains("deflate") {
                            compression_opts.push(CacheCompression::Deflate);
                        }
                    }
                    CompressionAlgorithm::Zstd { level } => {
                        if compressions_str.contains("zstd") {
                            compression_opts.push(CacheCompression::Zstd { level: *level });
                        }
                    }
                    CompressionAlgorithm::Gzip => {
                        if compressions_str.contains("gzip") {
                            compression_opts.push(CacheCompression::Gzip);
                        }
                    }
                    CompressionAlgorithm::All => {
                        tracing::error!("should not be able to hit 'CompressionAlgorithm::All'");
                    }
                }
            }
        }
    });
}

fn insert_base_headers(template: &Template, header_map: &mut HeaderMap) {
    {
        let csp_lock = template.csp.read();
        if let Some(csp) = csp_lock.as_ref() {
            header_map.insert(
                template.reporting_endpoints.0.clone(),
                template.reporting_endpoints.1.clone(),
            );
            header_map.insert(header::CONTENT_SECURITY_POLICY, csp.to_owned());
        }
    }

    header_map.insert(
        header::VARY,
        HeaderValue::from_static(header::ACCEPT_ENCODING.as_str()),
    );
}

pub async fn query(
    State(state): State<Arc<crate::server::OrdinaryAppServerState>>,
    Path((idx, path)): Path<(u8, String)>,
    req: Request,
) -> impl IntoResponse {
    let span = tracing::info_span!(
        "template",
        i = tracing::field::Empty,
        nm = tracing::field::Empty,
    );

    let uri = req.uri();
    let headers = req.headers();
    let query = req.uri().query();

    async {
        let Some(host) = get_host(headers, uri) else {
            tracing::error!("no host");
            return StatusCode::BAD_REQUEST.into_response();
        };

        let token: Vec<u8>;
        let mut claims = None;

        if let Some(template) = state.templates.get(idx as usize) {
            span.record("i", template.idx);
            span.record("nm", tracing::field::display(&template.config.name));

            if let Some(_check) = &template.config.protected
                && let Some(val) = headers.get("authorization")
                && let Ok(str_val) = val.to_str()
                && let Some(b64_token) = str_val.strip_prefix("Bearer ")
                && let Ok(t) = b64.decode(b64_token)
            {
                token = t;
                match state.auth.verify_access_token(&token) {
                    Ok((_account, real_claims)) => {
                        // todo: validate claims against the `_check`
                        claims = Some(real_claims);
                    }
                    Err(err) => {
                        tracing::error!("{err}");
                        return (
                            StatusCode::UNAUTHORIZED,
                            Bytes::copy_from_slice(b"unauthorized"),
                        )
                            .into_response();
                    }
                }
            }

            let params = query.map(ToString::to_string);

            match template.query(host.as_str(), path, params, None, None, &claims) {
                Ok(res) => {
                    let mut header_map = HeaderMap::with_capacity(11);

                    {
                        let csp_lock = template.csp.read();
                        if let Some(csp) = csp_lock.as_ref() {
                            header_map.insert(
                                template.reporting_endpoints.0.clone(),
                                template.reporting_endpoints.1.clone(),
                            );
                            header_map.insert(header::CONTENT_SECURITY_POLICY, csp.to_owned());
                        }
                    }

                    header_map.insert(
                        header::VARY,
                        HeaderValue::from_static(header::ACCEPT_ENCODING.as_str()),
                    );

                    let etag = if let Some(config) = &template.config.cache
                        && let Some(http_cache) = &config.http
                    {
                        get_etag_hash(res.as_ref(), Some(http_cache))
                    } else {
                        get_etag_hash(res.as_ref(), None)
                    };

                    let etag_str = etag.as_str();

                    let Ok(last_modified) = UtcDateTime::now().format(&GMT_FORMAT) else {
                        return StatusCode::INTERNAL_SERVER_ERROR.into_response();
                    };

                    insert_headers(template, &mut header_map, etag_str, last_modified.as_str());

                    return if let Some(etag) = check_if_none_match(headers, etag_str)
                        && let Ok(etag_header) = HeaderValue::from_str(etag)
                    {
                        header_map.insert(header::ETAG, etag_header);

                        (StatusCode::NOT_MODIFIED, header_map).into_response()
                    } else {
                        (StatusCode::OK, header_map, res).into_response()
                    };
                }
                Err(err) => {
                    tracing::error!("{err}");
                }
            }
        } else {
            tracing::warn!("no template for index '{idx}'");
        }
        (StatusCode::NOT_FOUND, Bytes::copy_from_slice(b"not found")).into_response()
    }
    .instrument(span.clone())
    .await
}