loading...
Cover image for Piecing Together a Rust Web Application

Piecing Together a Rust Web Application

jculverhouse profile image Jeff Culverhouse Originally published at rust.graystorm.com on ・4 min read

Designing a Full-Featured WebApp with Rust (6 Part Series)

1) Piecing Together a Rust Web Application 2) Adding Rocket to my Rust Web Application 3 ... 4 3) It’s Not a Web Application Without a Database 4) Better Logging for the Web Application 5) Rust Web App Session Management with AWS 6) OAuth Requests, APIs, Diesel, and Sessions

Hrm… how to find the right piece on Crates.io ???

For over a decade, I’ve worked on web apps with Perl, the last several years with Catalyst/Moose/DBIC and a slew of internal abstractions. There are a bunch of features I expect to need in any web app: config files (at different platform levels); structured logging; database ORM; templating; cookie, authentication, and session controls; en/decryption for access secrets; etc. I spent most of the overnight hours playing with piecing together a Rust web application, though I still have much more to do. After struggling for hours for what amounts to 279 lines of Rust code, I decided it was well worth it. I’ll try to explore some of my problems and what I worked out. This might take more than one post, so I don’t put you to sleep.

Global (Static) Application Config

This probably isn’t idiomatic Rust and frowned upon for even more reasons. I’m sure I’ll adapt to Rustic thinking as I learn, but for now, I’m liking this. I like to have a Config struct that is set up at init time and is immutable (music to the Rust compiler’s ears, I’m sure). I battled this with const and lazy_static and numerous other things. Eventually, I settled on a Crate that the author seems to have stumbled into writing/publishing (unless I’m missing some context): OnceCell. Where I was having trouble getting lazy_static to work, once_cell::sync::OnceCell seemed to work for me rather quickly.

Coupled with that, I like the notion of having Config settings initialized by YAML or JSON or TOML files and also able to be overridden in some way – usually environment variables. This path (and an earlier post) took me to the aptly named Config Crate. It does just what I need for pulling settings into a config from various places. I ended up adding the dotenv Crate as well, because something else used it in an example. I’m not sure I’ll keep ALL of these options forever, but it’s in the mix for now. There are, obviously, many ways to allow overrides vs protect the settings on disk, and many ways to decide which platform you are running on besides an ENV variable – and I’m flexible.

EDIT: I just realized that putting <Mutex> on my type means I have to lock() it to read it – and that prevents other functions (and other threads) from reading it. Since I’m ok with CONFIG being immutable, I really don’t need the Mutex, so I dropped it.

My settings.rs module looks like this for now:

use config::{Config, Environment, File};
use dotenv::dotenv;
use once_cell::sync::Lazy;
use serde_derive::Deserialize;
use std::env;

#[derive(Debug, Deserialize)]
pub struct Server {
    pub run_level: String,
}

#[derive(Debug, Deserialize)]
pub struct WebService {
    pub bind_address: String,
    pub bind\_port: u16,
}

#[derive(Debug, Deserialize)] 
pub struct Settings {
    pub server: Server,
    pub webservice: WebService,
    pub database_url: String,
}

pub static CONFIG: Lazy<Settings> = Lazy::new(|| {
    dotenv().ok();
    let mut config = Config::default();
    let env = env::var("PPS\_RUN\_MODE")
        .unwrap\_or("development".into());
    config
        .merge(File::with_name("conf/default"))
        .unwrap()
        .merge(File::with_name(&format!("conf/{}", env))
            .required(false))
        .unwrap()
        .merge(File::with_name("conf/local")
            .required(false))
        .unwrap()
        .merge(Environment::with_prefix("PPS"))
        .unwrap();

    match config.try_into() {
        Ok(c) => c,
        Err(e) => 
            panic!("error parsing config files: {}", e),
    }
});

And config files like these examples:

conf/default.toml:

[server] run_level = "default"

conf/development.toml:

[server]
run_level = "development"

[webservice]
bind_address = "0.0.0.0"
bind_port = 3000

conf/staging.toml:

[server]
run_level = "staging"

[webservice]
bind_address = "0.0.0.0"
bind_port = 3000

and, conf/production.toml:

[server]
run_level = "production"

[webservice]
bind_address = "0.0.0.0"
bind_port = 80

Application Logging

Piecing together a Rust web application includes another area of big concern – logging! Logging can easily become a tremendous burden of bandwidth and storage space, but a single log record might explain a production incident and lead you to a quick fix! Structured logging is great for logging platforms because storing and especially searching can be greatly improved when the message is static and data fields attached to the log record fill in the variable gaps.

To get things going, I started with the Crates log and simple_logger, but I probably will move to slog for the structured logging. The very first line in my main() is to call setup_logging() so if anything breaks on app initialization, we should get a log for it. With CONFIG a global static, this simple function looks like this for now, but soon I will work out specifying the logging level in the settings so it can be verbose for devs, but tamer on production:

pub fn setup_logging() {
    simple_logger::init_with_level(log::Level::Info)
        .expect("Trouble starting simple_logger");

    let run_level = &CONFIG.server.run_level;
    warn!("Running as run_level {}", run_level);
}

We still have the web framework, the database, encryption and more to come. Next up, more single-word Crates: Iron, Rocket and Diesel. I’d love to hear what Rust developers think of this so far – suggestions are welcome. Here’s the repository on Github – you can skip ahead and see what other messes I’ve made.

The post Piecing Together a Rust Web Application appeared first on Learning Rust.

Designing a Full-Featured WebApp with Rust (6 Part Series)

1) Piecing Together a Rust Web Application 2) Adding Rocket to my Rust Web Application 3 ... 4 3) It’s Not a Web Application Without a Database 4) Better Logging for the Web Application 5) Rust Web App Session Management with AWS 6) OAuth Requests, APIs, Diesel, and Sessions

Posted on Aug 8 '19 by:

jculverhouse profile

Jeff Culverhouse

@jculverhouse

I am a remote Sr Software Engineer for ZipRecruiter.com, mainly perl, but learning Rust in my spare time. Plus taking classes at James Madison University.

Discussion

markdown guide