kvarn/comprash.rs
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 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
//! ***Compr***ess and c***ach***e.
//!
//! Provides the [`MokaCache`] for Kvarn.
//! When a response is made cacheable, several important headers are appended.
//! See [`FatResponse`] for more info.
//!
//! The main type in this module is [`CompressedResponse`], a dynamically compressed
//! response receiving correct headers and [`extensions`].
use crate::prelude::{chrono::*, *};
#[allow(unused_imports)]
use std::cell::UnsafeCell;
use std::{borrow::Borrow, hash::Hash};
/// The HTTP date time format in the [`time`] format.
pub static HTTP_DATE: &[time::format_description::FormatItem] = time::macros::format_description!("[weekday repr:short case_sensitive:true], [day padding:zero] [month repr:short case_sensitive:true] [year padding:zero repr:full base:calendar sign:automatic] [hour repr:24 padding:zero]:[minute padding:zero]:[second padding:zero] GMT");
/// A [`MokaCache`] with appropriate type parameters for a file cache.
pub type FileCache = MokaCache<CompactString, Option<(OffsetDateTime, Bytes)>>;
/// A [`MokaCache`] with appropriate type parameters for a response cache.
pub type ResponseCache = MokaCache<UriKey, LifetimeCache<Arc<VariedResponse>>>;
/// A path an optional query used in [`UriKey`]
///
/// Represented as a [`String`] with a [`usize`] indicating the start of query.
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
#[must_use]
pub struct PathQuery {
string: CompactString,
query_start: usize,
}
impl PathQuery {
/// Get the path segment.
#[inline]
#[must_use]
pub fn path(&self) -> &str {
&self.string[..self.query_start]
}
/// Get the optional query segment.
/// `&str` will never be empty if the return value is [`None`].
#[inline]
#[must_use]
pub fn query(&self) -> Option<&str> {
if self.query_start == self.string.len() {
None
} else {
Some(&self.string[self.query_start..])
}
}
/// Discards any [`Self::query()`].
pub fn truncate_query(&mut self) {
self.string.truncate(self.query_start);
}
/// Discards any [`Self::query()`] and returns the [`Self::path()`] as a [`String`]
#[inline]
#[must_use]
pub fn into_path(mut self) -> CompactString {
self.truncate_query();
self.string
}
}
/// Converts a [`Uri`] using one allocation.
impl From<&Uri> for PathQuery {
fn from(uri: &Uri) -> Self {
match uri.query() {
Some(query) => {
let mut string = CompactString::with_capacity(uri.path().len() + query.len());
string.push_str(uri.path());
string.push_str(query);
Self {
string,
query_start: uri.path().len(),
}
}
None => Self {
string: uri.path().to_compact_string(),
query_start: uri.path().len(),
},
}
}
}
/// A key for an Uri used in [`ResponseCache`].
///
/// This is, for now, an opaque type in it's API.
/// Though, you can extract the path and query through matching.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum UriKey {
/// Uri with only a path component.
///
/// Searching the cache with this should be avoided.
/// See [`Self::call_all`].
Path(CompactString),
/// Uri with a path and optional query.
///
/// See [`PathQuery`].
PathQuery(PathQuery),
}
impl UriKey {
/// Constructs a new [`UriKey`] from `uri`.
///
/// This variant will math both [`Self::PathQuery`] and [`Self::Path`]
/// if [`Self::call_all`] is called on it.
#[inline]
pub fn path_and_query(uri: &Uri) -> Self {
Self::PathQuery(PathQuery::from(uri))
}
/// Tries to get type `T` from `callback` using current variant and other variants with fewer data.
/// Returns `Self` which got a result from `callback` or, if none, truncated to `Self::Path`.
///
/// # Examples
///
/// ```
/// use kvarn::prelude::*;
/// let key = UriKey::path_and_query(&Uri::from_static("https://icelk.dev/status?format=json"));
///
/// // First gets called once with key as UriKey::PathQuery("/status?format=json")
/// // then, the query gets truncated and we get a key as UriKey::Path("/status").
/// let (_key, found) = key.call_all(|key| {
/// match key {
/// UriKey::Path(path) if *path == "/status" => Some(true),
/// _ => None
/// }
/// });
///
/// assert_eq!(found, Some(true));
/// ```
#[inline]
pub fn call_all<T>(
mut self,
mut callback: impl FnMut(&Self) -> Option<T>,
) -> (Self, Option<T>) {
match callback(&self) {
Some(t) => (self, Some(t)),
None => match self {
Self::Path(_) => (self, None),
Self::PathQuery(path_query) => {
self = Self::Path(path_query.into_path());
let result = callback(&self);
(self, result)
}
},
}
}
}
/// Guesses the mime. `file_contents` should be < 16 bytes.
#[must_use]
pub fn get_mime(extension: &str, file_contents: &[u8]) -> Mime {
mime_guess::from_ext(extension)
.first_raw()
.unwrap_or_else(|| tree_magic_mini::from_u8(file_contents))
.parse()
.unwrap_or(mime::APPLICATION_OCTET_STREAM)
}
/// Heuristically checks `mime` for UTF-8 text formats.
#[must_use]
pub fn is_text(mime: &Mime) -> bool {
mime.type_() == mime::TEXT
|| mime.type_() == mime::APPLICATION
&& (mime.subtype() == mime::JAVASCRIPT
|| mime.subtype() == "graphql"
|| mime.subtype() == mime::JSON
|| mime.subtype() == mime::XML)
}
/// Checks `mime` if the content should be compressed;
/// heuristically checks for compressed formats.
#[must_use]
#[allow(clippy::nonminimal_bool)]
pub fn do_compress(mime: &Mime) -> bool {
// IMAGE first, because it is the most likely
!(mime.type_() == mime::IMAGE && !(mime.subtype() == "svg"))
&& mime.type_() != mime::FONT
&& mime.type_() != mime::VIDEO
&& mime.type_() != mime::AUDIO
&& mime.type_() != mime::STAR
// compressed applications
&& mime != &mime::APPLICATION_PDF
&& mime.subtype() != "zip"
&& mime.subtype() != "zstd"
// all applications which are not js, graphql, json, xml, or valid utf-8
&& !(mime.type_() == mime::APPLICATION
&& !(mime.subtype() == mime::JAVASCRIPT
|| mime.subtype() == "graphql"
|| mime.subtype() == mime::JSON
|| mime.subtype() == mime::XML
|| mime.subtype() == "wasm"
|| mime.subtype() == "octet-stream"))
}
/// The preferred compression algorithm.
///
/// The default is chosen according to the [cargo features](https://kvarn.org/cargo-features.) in
/// the following order:
/// - Zstd
/// - Brotli
/// - Gzip
/// - None
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum PreferredCompression {
/// Prefer the Zstd algorithm.
///
/// This is the default and is the best.
#[cfg(feature = "zstd")]
Zstd,
/// Prefer the brotli algorithm.
///
/// This is the second best.
#[cfg(feature = "br")]
Brotli,
/// Prefer the gzip algorithm.
///
/// Uses a bit less memory than [`Self::Brotli`] at the expense of compression.
#[cfg(feature = "gzip")]
Gzip,
/// Prefer no compression. This is the default if no compression features are enabled.
None,
}
impl PreferredCompression {
/// Return the name used in the `content-encoding` header.
#[must_use]
pub fn as_str(&self) -> &'static str {
match self {
#[cfg(feature = "zstd")]
Self::Zstd => "zstd",
#[cfg(feature = "br")]
Self::Brotli => "br",
#[cfg(feature = "gzip")]
Self::Gzip => "gzip",
Self::None => "identity",
}
}
}
impl Default for PreferredCompression {
fn default() -> Self {
let list = &[
#[cfg(feature = "zstd")]
PreferredCompression::Zstd,
#[cfg(feature = "br")]
PreferredCompression::Brotli,
#[cfg(feature = "gzip")]
PreferredCompression::Gzip,
PreferredCompression::None,
];
list[0]
}
}
/// Some options for how to compress the response.
#[derive(Debug, Clone)]
pub struct CompressionOptions {
/// The preferred compression algorithm.
pub preferred: PreferredCompression,
/// The level of zstd compression.
///
/// `0` means that the C zstd library decides the default.
/// Note that this can be negative.
/// See <https://facebook.github.io/zstd/> for more context.
#[cfg(feature = "zstd")]
pub zstd_level: i32,
/// The level of zstd compression.
///
/// See [some benchmarks](https://quixdb.github.io/squash-benchmark/#results) for more context.
#[cfg(feature = "br")]
pub brotli_level: u32,
/// The level of gzip compression.
///
/// See [some benchmarks](https://quixdb.github.io/squash-benchmark/#results) for more context.
#[cfg(feature = "gzip")]
pub gzip_level: u32,
}
impl CompressionOptions {
/// Default for responses which are not cached.
#[must_use]
pub fn oneshot() -> Self {
Self {
preferred: PreferredCompression::default(),
#[cfg(feature = "zstd")]
zstd_level: 1,
#[cfg(feature = "br")]
brotli_level: 3,
#[cfg(feature = "gzip")]
gzip_level: 1,
}
}
/// Default for responses which are cached.
#[must_use]
pub fn cached() -> Self {
Self {
preferred: PreferredCompression::default(),
#[cfg(feature = "zstd")]
zstd_level: 4,
#[cfg(feature = "br")]
brotli_level: 4,
#[cfg(feature = "gzip")]
gzip_level: 2,
}
}
}
/// A response with a lazily compressed body.
///
/// The compressed body is cached.
/// It therefore uses `unsafe` to mutate the [`Option`]s containing the compressed data.
/// This should be fine; we only write once, if the value is [`None`].
#[derive(Debug)]
#[must_use]
pub struct CompressedResponse {
identity: Response<Bytes>,
// `TODO`: write atomics
#[cfg(feature = "gzip")]
gzip: UnsafeCell<Option<Bytes>>,
#[cfg(feature = "br")]
br: UnsafeCell<Option<Bytes>>,
#[cfg(feature = "zstd")]
zstd: UnsafeCell<Option<Bytes>>,
compress: CompressPreference,
}
unsafe impl Send for CompressedResponse {}
unsafe impl Sync for CompressedResponse {}
impl CompressedResponse {
pub(crate) fn new(
mut identity: Response<Bytes>,
compress: CompressPreference,
client_cache: ClientCachePreference,
extension: &str,
) -> Self {
let headers = identity.headers_mut();
Self::set_client_cache(headers, client_cache);
Self::check_content_type(&mut identity, extension);
Self {
identity,
#[cfg(feature = "gzip")]
gzip: UnsafeCell::new(None),
#[cfg(feature = "br")]
br: UnsafeCell::new(None),
#[cfg(feature = "zstd")]
zstd: UnsafeCell::new(None),
compress,
}
}
#[cfg(feature = "gzip")]
fn gzip(&self) -> &Option<Bytes> {
unsafe { &*self.gzip.get() }
}
#[cfg(feature = "br")]
fn br(&self) -> &Option<Bytes> {
unsafe { &*self.br.get() }
}
#[cfg(feature = "zstd")]
fn zstd(&self) -> &Option<Bytes> {
unsafe { &*self.zstd.get() }
}
/// Gets the response with an uncompressed body.
#[inline]
pub fn get_identity(&self) -> &Response<Bytes> {
&self.identity
}
/// Clones the preferred compression type based on
/// `accept-encoding` header in `request`
/// and already cached bodies.
///
/// If an error occurs, you should respond with an [`StatusCode::NOT_ACCEPTABLE`].
///
/// # Errors
///
/// May return a &str to be used to inform the client what error occurred in content negotiation.
#[allow(clippy::unused_async)] // for when we have no compression
pub async fn clone_preferred<T>(
&self,
request: &Request<T>,
regular_options: &CompressionOptions,
cached_options: &CompressionOptions,
do_cache: bool,
) -> Result<Response<Bytes>, &'static str> {
if self.compress == CompressPreference::None {
return Ok(self.clone_identity_set_compression(
self.get_identity().body().clone(),
HeaderValue::from_static("identity"),
));
}
let options = if do_cache {
cached_options
} else {
regular_options
};
let values = match request
.headers()
.get("accept-encoding")
.map(HeaderValue::to_str)
.and_then(Result::ok)
{
Some(header) => utils::list_header(header),
None => Vec::new(),
};
let disable_identity = values
.iter()
.any(|v| v.value == "identity" && v.quality == 0.0);
let only_identity = values.len() == 1
&& values[0]
== utils::ValueQualitySet {
value: "identity",
quality: 1.0,
};
// Only identity makes sure identity quality is `1.0`; identity encoding can't be disabled.
if only_identity {
return Ok(self.clone_identity_set_compression(
Bytes::clone(self.get_identity().body()),
HeaderValue::from_static("identity"),
));
}
#[cfg(any(feature = "gzip", feature = "br", feature = "zstd"))]
let contains = |name| values.iter().any(|v| v.value == name && v.quality != 0.0);
let mime = self
.get_identity()
.headers()
.get("content-type")
.and_then(|header| header.to_str().ok())
.and_then(|header| header.parse().ok());
debug!("Recognised mime {:?}", &mime);
let (bytes, compression) = match &mime {
Some(mime) => {
if do_compress(mime) {
#[cfg(feature = "zstd")]
let contains_zstd = contains("zstd");
#[cfg(feature = "br")]
let contains_br = contains("br");
#[cfg(feature = "gzip")]
let contains_gzip = contains("gzip");
#[allow(unused_mut)]
let mut preferred = match options.preferred.as_str() {
#[cfg(feature = "zstd")]
"zstd" if contains_zstd => {
Some((self.get_zstd(options.zstd_level).await, "zstd"))
}
#[cfg(feature = "br")]
"br" if contains_br => {
Some((self.get_br(options.brotli_level).await, "br"))
}
#[cfg(feature = "gzip")]
"gzip" if contains_gzip => {
Some((self.get_gzip(options.gzip_level).await, "gzip"))
}
_ => None,
};
#[cfg(feature = "zstd")]
if preferred.is_none() && contains_zstd {
preferred = Some((self.get_zstd(options.zstd_level).await, "zstd"));
}
#[cfg(feature = "br")]
if preferred.is_none() && contains_br {
preferred = Some((self.get_br(options.brotli_level).await, "br"));
}
#[cfg(feature = "gzip")]
if preferred.is_none() && contains_gzip {
preferred = Some((self.get_gzip(options.gzip_level).await, "gzip"));
}
preferred.unwrap_or_else(|| (self.get_identity().body(), "identity"))
} else {
debug!("Not compressing; filtered out.");
(self.get_identity().body(), "identity")
}
}
None => (self.get_identity().body(), "identity"),
};
if disable_identity && compression == "identity" {
return Err(
"identity compression is the only option, but the client refused to accept it",
);
}
Ok(self.clone_identity_set_compression(
Bytes::clone(bytes),
HeaderValue::from_static(compression),
))
}
#[inline]
fn set_client_cache(headers: &mut HeaderMap, preference: ClientCachePreference) {
let header = preference.as_header();
if let Some(h) = header {
headers.entry("cache-control").or_insert(h);
}
}
fn check_content_type(identity_response: &mut Response<Bytes>, extension: &str) {
fn add_utf_8(headers: &mut HeaderMap, mime: &Mime) {
let charset = if mime.get_param(mime::CHARSET) == Some(mime::UTF_8) {
""
} else {
"; charset=utf-8"
};
// We know the added bytes are safe for a http::HeaderValue
// unwrap is ok.
let mut header = mime.to_string();
header.push_str(charset);
let content_type =
HeaderValue::from_maybe_shared::<Bytes>(header.into_bytes().into()).unwrap();
headers.insert("content-type", content_type);
}
match identity_response.headers().get("content-type") {
Some(content_type) => {
if let Some(mime_type) = content_type
.to_str()
.ok()
.and_then(|s| s.parse::<Mime>().ok())
{
#[allow(clippy::match_same_arms)] // we have comments
match mime_type.get_param("charset") {
None if is_text(&mime_type) => {
add_utf_8(identity_response.headers_mut(), &mime_type);
}
// Has charset attribute or we shouldn't add a charset parameter
Some(_) | None => {}
}
}
}
None if !identity_response.body().is_empty() => {
let short_body = identity_response
.body()
.get(..8)
.unwrap_or(identity_response.body());
let mime = get_mime(extension, short_body);
let utf_8 = is_text(&mime);
if utf_8 {
add_utf_8(identity_response.headers_mut(), &mime);
} else {
// Mime will only contains valid bytes.
let content_type = HeaderValue::from_maybe_shared::<Bytes>(
mime.to_string().into_bytes().into(),
)
.unwrap();
identity_response
.headers_mut()
.insert("content-type", content_type);
}
}
None => {}
}
}
fn clone_identity_set_compression(
&self,
new_data: Bytes,
compression: HeaderValue,
) -> Response<Bytes> {
let response = &self.identity;
let mut builder = Response::builder()
.version(response.version())
.status(response.status());
let mut map = response.headers().clone();
if !new_data.is_empty() {
let headers = &mut map;
debug!(
"Changing content-encoding from {:?}. Has content-type {:?}",
headers.get("content-encoding"),
headers.get("content-type"),
);
headers.insert("content-encoding", compression);
}
*builder.headers_mut().unwrap() = map;
builder.body(new_data).unwrap()
}
/// Gets the gzip compressed version of [`CompressedResponse::get_identity()`]
///
/// You should use [`Self::clone_preferred`] to get the preferred compression instead,
/// as it is available with any set of features
#[cfg(feature = "gzip")]
pub async fn get_gzip(&self, level: u32) -> &Bytes {
if self.gzip().is_none() {
let bytes = self.identity.body().clone();
let buffer = threading::spawn_blocking(move || {
let mut buffer = utils::WriteableBytes::with_capacity(bytes.len() / 3 + 64);
// 1-9, 1 is fast, 9 is slow. 4 is equal to brotli's 3
let mut c =
flate2::write::GzEncoder::new(&mut buffer, flate2::Compression::new(level));
c.write_all(&bytes).expect("Failed to compress using gzip!");
c.finish().expect("Failed to compress using gzip!");
let buffer = buffer.into_inner();
buffer.freeze()
})
.await
.unwrap();
// Last check to make sure we don't override any value.
if self.gzip().is_none() {
// maybe shooting myself in the foot...
// but should be OK, since we only set it once, otherwise it's None.
unsafe { (*self.gzip.get()).replace(buffer) };
}
}
self.gzip().as_ref().unwrap()
}
/// Gets the Brotli compressed version of [`CompressedResponse::get_identity()`]
///
/// You should use [`Self::clone_preferred`] to get the preferred compression instead,
/// as it is available with any set of features
#[cfg(feature = "br")]
pub async fn get_br(&self, level: u32) -> &Bytes {
if self.br().is_none() {
let bytes = self.identity.body().clone();
let buffer = threading::spawn_blocking(move || {
let mut buffer = utils::WriteableBytes::with_capacity(bytes.len() / 3 + 64);
// 1-10, 1 is fast, 10 is really slow
let mut c = brotli::CompressorWriter::new(&mut buffer, 4096, level, 21);
c.write_all(&bytes)
.expect("Failed to compress using Brotli!");
c.flush().expect("Failed to compress using Brotli!");
c.into_inner();
let buffer = buffer.into_inner();
buffer.freeze()
})
.await
.unwrap();
// Last check to make sure we don't override any value.
if self.br().is_none() {
// maybe shooting myself in the foot...
// but should be OK, since we only set it once, otherwise it's None.
unsafe { (*self.br.get()).replace(buffer) };
}
}
self.br().as_ref().unwrap()
}
/// Gets the Zstd compressed version of [`CompressedResponse::get_identity()`]
///
/// You should use [`Self::clone_preferred`] to get the preferred compression instead,
/// as it is available with any set of features
#[cfg(feature = "zstd")]
pub async fn get_zstd(&self, level: i32) -> &Bytes {
if self.zstd().is_none() {
let bytes = self.identity.body().clone();
let buffer = threading::spawn_blocking(move || {
let mut buffer = utils::WriteableBytes::with_capacity(bytes.len() / 3 + 64);
let mut encoder = zstd::Encoder::new(&mut buffer, level).unwrap();
#[cfg(feature = "zstd-multithread")]
#[allow(clippy::cast_possible_truncation)]
// we won't saturate a u32!!
if let Err(err) = encoder
.multithread(std::thread::available_parallelism().map_or(8, |v| v.get() as u32))
{
error!("Failed to enable multithread support for zstd: {err}");
}
encoder
.write_all(&bytes)
.expect("Failed to compress using Zstd!");
encoder.flush().expect("Failed to compress using Zstd!");
let buffer = buffer.into_inner();
buffer.freeze()
})
.await
.unwrap();
// Last check to make sure we don't override any value.
if self.zstd().is_none() {
// maybe shooting myself in the foot...
// but should be OK, since we only set it once, otherwise it's None.
unsafe { (*self.zstd.get()).replace(buffer) };
}
}
self.zstd().as_ref().unwrap()
}
}
/// The preference of compression in [`CompressedResponse`].
#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
pub enum CompressPreference {
/// Will not auto-compress response body
None,
/// Will automatically compress and send compressed versions of the response
Full,
}
/// Error in parsing cache preference.
///
/// # Examples
///
/// ```
/// # use kvarn::prelude::{*, comprash::CachePreferenceError, comprash::ServerCachePreference,
/// comprash::ClientCachePreference};
/// assert_eq!(Err(CachePreferenceError::Empty), "".parse::<ServerCachePreference>());
/// assert_eq!(Err(CachePreferenceError::Invalid), "FULL".parse::<ClientCachePreference>());
/// assert_eq!(Ok(ServerCachePreference::QueryMatters), "query-matters".parse());
/// use std::convert::TryInto;
/// assert_eq!(Ok(ClientCachePreference::MaxAge(Duration::from_secs(42))), "42s".parse());
/// assert_eq!(Ok(ServerCachePreference::MaxAge(Duration::from_secs(3600))), "3600s".parse());
/// assert_eq!(Err(CachePreferenceError::ZeroDuration), "0s".parse::<ClientCachePreference>());
/// assert_eq!(Err(CachePreferenceError::ZeroDuration), "0s".parse::<ServerCachePreference>());
/// ```
#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
pub enum CachePreferenceError {
/// Input string is empty.
Empty,
/// Input string has an invalid syntax.
Invalid,
/// Duration is zero
ZeroDuration,
}
/// The preference for caching the item on the server.
///
/// This can be overridden by the `cache-control` or `kvarn-cache-control` headers.
///
/// Note: It's only a preference. Disabling the cache in compile-time will
/// disable this behaviour. Some other factors also play a role, such as number of cached
/// `Vary` responses on a page.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
pub enum ServerCachePreference {
/// Will not cache response
None,
/// Will cache response with query
QueryMatters,
/// Query does not matter and will be discarded
Full,
/// Sets a max age for the content.
/// Query will be discarded in cache, same as [`Self::Full`].
MaxAge(Duration),
}
impl ServerCachePreference {
/// If a response with `cache_action` (from [`host::CacheAction`]) should be cached.
#[inline]
#[must_use]
#[allow(clippy::unused_self)]
pub fn cache(self, cache_action: host::CacheAction, method: &Method) -> bool {
let of_self = match self {
Self::None => false,
Self::QueryMatters | Self::Full | Self::MaxAge(_) => true,
};
#[allow(clippy::unnested_or_patterns)] // matches! macro
let of_response =
cache_action.into_cache() && matches!(method, &Method::GET | &Method::HEAD);
of_self && of_response
}
/// If query matters in cache.
///
/// Ultimately dictates which variant of [`UriKey`] should be cached.
#[inline]
#[must_use]
pub fn query_matters(self) -> bool {
match self {
Self::None | Self::Full | Self::MaxAge(_) => false,
Self::QueryMatters => true,
}
}
}
impl str::FromStr for ServerCachePreference {
type Err = CachePreferenceError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(match s {
"full" => ServerCachePreference::Full,
"query_matters" | "query-matters" | "QueryMatters" | "queryMatters" => {
ServerCachePreference::QueryMatters
}
"none" => ServerCachePreference::None,
"" => return Err(CachePreferenceError::Empty),
_ => {
if let Some(integer) = s.strip_suffix('s') {
if let Ok(integer) = integer.parse::<u64>() {
if integer == 0 {
return Err(CachePreferenceError::ZeroDuration);
}
return Ok(Self::MaxAge(integer.std_seconds()));
}
}
return Err(CachePreferenceError::Invalid);
}
})
}
}
/// Automatically add `cache-control` header to response.
///
/// If a `cache-control` header is already present, it will be prioritized.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
pub enum ClientCachePreference {
/// Don't manage the `cache-control` header.
Ignore,
/// Will not cache on client
None,
/// A two-minute cache lifetime
Changing,
/// Will cache for 1 week
Full,
/// Sets a max age for the content.
///
/// Note that this must be in seconds when sending a header.
/// This will be rounded up.
MaxAge(Duration),
}
impl ClientCachePreference {
/// Gets the [`HeaderValue`] representation of the preference.
#[inline]
#[must_use]
pub fn as_header(self) -> Option<HeaderValue> {
Some(match self {
Self::Ignore => return None,
Self::None => HeaderValue::from_static("no-store"),
Self::Changing => HeaderValue::from_static("max-age=120"),
Self::Full => HeaderValue::from_static("public, max-age=604800, immutable"),
Self::MaxAge(duration) => {
let bytes = build_bytes!(
b"public, max-age=",
// if > second integer, add 1 second (ceil the duration).
// i64::from(bool) returns 1 if true.
(duration.as_secs() + u64::from(duration.subsec_nanos() > 0))
.to_string()
.as_bytes(),
b", immutable"
);
// We know these bytes are safe.
HeaderValue::from_maybe_shared(bytes).unwrap()
}
})
}
}
impl str::FromStr for ClientCachePreference {
type Err = CachePreferenceError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
if let Some(integer) = s.strip_suffix('s') {
if let Ok(integer) = integer.parse::<u64>() {
if integer == 0 {
return Err(CachePreferenceError::ZeroDuration);
}
return Ok(Self::MaxAge(integer.std_seconds()));
}
}
Ok(match s {
"ignore" => ClientCachePreference::Ignore,
"full" => ClientCachePreference::Full,
"changing" => ClientCachePreference::Changing,
"none" => ClientCachePreference::None,
"" => return Err(CachePreferenceError::Empty),
_ => return Err(CachePreferenceError::Invalid),
})
}
}
/// Output of cache operations.
///
/// [`CacheOut::None`] and [`CacheOut::Present`] reflects the [`HashMap`] API.
/// [`CacheOut::NotInserted`] is added to indicate the content to be cached
/// does not meet the requirements (e.g. it's too big)
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
pub enum CacheOut<V> {
/// No value.
///
/// Returned when no item occupies the input key.
None,
/// Successful cache lookup.
///
/// Returned when an item occupies the input key.
Present(V),
/// Error when value failed to get inserted. See [`CacheOut`].
NotInserted(V),
}
impl<V> CacheOut<V> {
/// Maps self to an [`Option`].
///
/// Variants with a value are turned to [`Some`]
/// and [`CacheOut::None`] to [`None`].
#[inline]
pub fn into_option(self) -> Option<V> {
match self {
Self::None => None,
Self::Present(v) | Self::NotInserted(v) => Some(v),
}
}
/// Applies a function to the inner value `V` of [`CacheOut`],
/// if not [`CacheOut::None`] and returns a `CacheOut` with
/// the transformed `K`.
pub fn map<K>(self, f: impl FnOnce(V) -> K) -> CacheOut<K> {
match self {
Self::None => CacheOut::None,
Self::NotInserted(v) => CacheOut::NotInserted(f(v)),
Self::Present(v) => CacheOut::Present(f(v)),
}
}
}
/// Cache using [`moka`].
#[derive(Debug)]
pub struct MokaCache<K: Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static> {
size_limit: usize,
/// The inner cache, with direct access allowed.
/// Please check the size of your item before inserting.
pub cache: moka::sync::Cache<K, V>,
}
impl<K: Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static> Default
for MokaCache<K, V>
{
fn default() -> Self {
Self {
size_limit: 4 * 1024 * 1024,
cache: moka::sync::Cache::new(1024),
}
}
}
impl<K: Hash + Eq + Send + Sync + 'static> MokaCache<K, LifetimeCache<Arc<VariedResponse>>> {
pub(crate) fn get_cache_item<Q: Hash + Eq>(
&self,
key: &Q,
) -> CacheOut<LifetimeCache<Arc<VariedResponse>>>
where
K: Borrow<Q>,
{
match self.cache.get(key) {
Some(value_and_lifetime)
if value_and_lifetime.1 .2.map_or(true, |lifetime| {
OffsetDateTime::now_utc() - value_and_lifetime.1 .0 <= lifetime
}) =>
{
CacheOut::Present(value_and_lifetime)
}
Some(_) => {
self.cache.invalidate(key);
CacheOut::None
}
None => CacheOut::None,
}
}
pub(crate) fn insert(
&self,
len: usize,
lifetime: Option<Duration>,
key: K,
response: VariedResponse,
) -> CacheOut<VariedResponse> {
if len >= self.size_limit {
return CacheOut::NotInserted(response);
}
let date_time = OffsetDateTime::now_utc();
let header = HeaderValue::from_str(
&date_time
.format(&comprash::HTTP_DATE)
.expect("failed to format datetime"),
)
.expect("We know these bytes are valid.");
self.cache
.insert(key, (Arc::new(response), (date_time, header, lifetime)));
CacheOut::None
}
pub(crate) fn insert_cache_item(
&self,
key: K,
response: VariedResponse,
) -> CacheOut<VariedResponse> {
let lifetime =
parse::CacheControl::from_headers(response.first().0.get_identity().headers())
.ok()
.as_ref()
.and_then(parse::CacheControl::as_freshness)
.map(|s| u64::from(s).std_seconds());
debug!("Inserted item to cache with lifetime {:?}", lifetime);
self.insert(
response.first().0.get_identity().body().len(),
lifetime,
key,
response,
)
}
}
/// The item used in the cache.
/// `T` represents the cached data.
///
/// The other information is for lifetimes of the cache.
/// The [`OffsetDateTime`] is when the item was added and
/// the [`Duration`] how long the item can be kept.
/// A `Duration` value of `None` means the item will never expire.
pub type LifetimeCache<T> = (T, (OffsetDateTime, HeaderValue, Option<Duration>));
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn path_query_empty_query_1() {
let uri: Uri = "https://kvarn.org/index.html?".parse().unwrap();
let path_query = PathQuery::from(&uri);
assert_eq!(path_query.query(), None);
}
#[test]
fn path_query_empty_query_2() {
let uri: Uri = "https://kvarn.org/index.html?hi".parse().unwrap();
let path_query = PathQuery::from(&uri);
assert_eq!(path_query.query(), Some("hi"));
}
#[test]
fn path_query_empty_query_3() {
let uri: Uri = "https://kvarn.org/index.html??".parse().unwrap();
let path_query = PathQuery::from(&uri);
assert_eq!(path_query.query(), Some("?"));
}
#[test]
fn path_query_empty_query_4() {
let uri: Uri = "https://kvarn.org/".parse().unwrap();
let path_query = PathQuery::from(&uri);
assert_eq!(path_query.query(), None);
}
}