#http-service #tide #surf #honeycomb #sqlx #http-response #http-client

preroll

Easy boilerplate utilities for Rust http services which use async-std, Tide, Surf, and friends

29 releases

0.10.1 Apr 7, 2022
0.10.0 Dec 29, 2021
0.9.0 Oct 28, 2021
0.8.3 Jul 19, 2021
0.1.1 Dec 22, 2020

#270 in HTTP server

BlueOak-1.0.0

97KB
1.5K SLoC

preroll on crates.io Documentation (latest release)

preroll

Easy boilerplate utilities for Rust http services which use async-std, Tide, Surf, and friends.

Allows for service setup with feature-configured built-ins for maximum service consistency with low developer overhead, and for easily integration testing the service without using a live network.

Scroll to the bottom for API Reference

Example

use std::sync::Arc;

use tide::{Request, Route};

struct AppState {
    greeting: &'static str,
}

type AppRequest = Request<Arc<AppState>>;

async fn setup_app_state() -> preroll::SetupResult<AppState> {
    Ok(AppState {
        greeting: "Hello World!",
    })
}

fn setup_routes(mut server: Route<'_, Arc<AppState>>) {
    server
        .at("hello-world")
        .get(|req: AppRequest| async move {
            Ok(req.state().greeting)
        });
}

// The "magic" happens here!
preroll::main!("hello-world", setup_app_state, setup_routes);

Features

  • Boilerplate main setup via preroll::main!, with optional features automatically configured.
  • A preroll::prelude::*; with all extension traits.
  • Response logging with many details.
  • Automatic JSON responses for errors in the form of JsonError.
  • Test utils with easy mock client setup.

Optional features

Add-on features must be enabled via cargo features, e.g.

[dependencies.preroll]
version = "0.5"
features = ["honeycomb", "postgres"]

List of optional add-on features:

  • "honeycomb": Enables tracing to honeycomb.io.
    • Env variable HONEYCOMBIO_WRITE_KEY (required).
    • Env variable TRACELEVEL, sets the tracing level filter, defaults to info.
    • Writes to a dataset named {service_name}-{environment}.
      • service_name is from preroll::main!("service_name", ...).
      • environment is from ENVIRONMENT, or defaults to "development".
  • "lambda-http": Changes the HTTP listener to connect to an AWS Lambda execution environment.
    • Is no longer reachable as a regular http server, but accepts http lambda requests as if it were one.
    • Some environment variables, such as PORT, are disregarded.
    • If the "honeycomb" feature is enabled, trace events are written to stdout, and must be collected via a layer provided by Honeycomb. See: https://docs.honeycomb.io/getting-data-in/integrations/aws/aws-lambda/
  • "postgres": Enables a postgres connection pool with transactions.
    • Env variable PGURL, which should be a properly formatted postgres:// database url.
      • Defaults to "postgres://localhost/{service_name}" (default postgres port).
      • service_name is from preroll::main!("service_name", ...).
    • Env variable PGMAXCONNECTIONS, default 5 connections.
    • Env variable PGMAXLIFETIME, default 30 (minutes).
    • Enables PostgresRequestExt and test_utils::create_client_and_postgres.

List of other optional features:

  • "panic-on-error": Makes the response logger [panic][] on error rather than log.
    • Do not use in production. Prevents --release compilation.

General Environment Settings

The following environment variables are read during preroll::main!:

  • ENVIRONMENT: If this starts with prod, load the production-mode JSON logger, avoid .env.
  • FORCE_DOTENV: Override production-mode, force-load environment from .env.
  • HOST: Sets the hostname that this service will listen on. Defaults to "127.0.0.1".
  • LOGLEVEL: Set the logger's level filter, defaults to info in production-mode, debug in development-mode.
  • PORT: Sets the port that this service will listen on. Defaults to 8080.

Note:

This crate is intentionally somewhat prescriptive in how it templates a service and the interaction with add-on features such as Postgres (via SQLx).

API Reference

API Reference on Docs.rs

License

Licensed under the BlueOak Model License 1.0.0Contributions via DCO 1.1

Dependencies

~37–58MB
~1M SLoC