Fasttime Save

⏱️ A Fastly serverless compute@edge runtime for running wasm applications locally

Project README

fasttime

A lightweight Fastly Compute@Edge runtime for running and testing WASM applications locally


about

Fastly allows you to run WASM request handlers within a WASI-based runtime hosted on its managed edge servers. fasttime implements those runtime interfaces using wasmtime serving up your application on a local HTTP server allowing you to run you Compute@Edge applications ✨ locally on your laptop ✨.

🤸 usage

Building your app

The fastest way to get started with Compute@Edge is though the Fastly CLI

$ fastly compute build

Alternatively, you can also build your WASM application using Rust's standard cargo tooling.

Fastly assumes a Rust toolchain version of 1.46.0

# optionally install 1.46.0 if you have not done so already
$ rustup install 1.46.0 --profile minimal
# optionally install the wasm32 toolchain if you have not done so already
$ rustup target add wasm32-wasi --toolchain 1.46.0
# build a release mode .wasm executable
$ cargo +1.46.0 build --release --target wasm32-wasi

To start fasttime, just provide it with the path to your Fastly Compute@Edge .wasm build artifact.

Serving up your app

$ fasttime -w target/wasm32-wasi/release/app.wasm

This starts up a localhost HTTP server listening on port 3000 which you can interact with with an HTTP client like curl

curl -i "http://localhost:3000"

♻️ hot reloading

fasttime can monitor your WASM applicaion for changes, and gracefully reload the module when needed allowing for live-editing. Using the --watch flag, there's no need to restart fasttime after running fastly compute build!

$ fasttime -w target/wasm32-wasi/release/app.wasm \
    --watch

This pairs well with a cargo watch workflow. In another terminal, run

$ cargo +1.46.0 watch -x 'build --release --target wasm32-wasi'

You can then make changes to your application in your text editor, have cargo automatically rebuild your application, and have fasttime automatically reload it as you develop your application

↔️ backends

A common usecase for Fastly is proxying a set of backend hosts referred to by name. fasttime supports providing multiple -b | --backend flags with values of the form {backend}:{host}. By default, if you send a request to a backend that you have not mapped, a bad gateway response will be returned by the server.

$ fasttime -w target/wasm32-wasi/release/app.wasm \
    -b backend-two:localhost:3001 \
    -b backend-two:you.com

📚 dictionaries

A common way to look up key-value'd information in Fastly is to use edge dictionaries. fasttime supports providing multiple -d | --dictionary flags with values of the form {dictionary}:{key}={value},{key2}={value2}.

$ fasttime -w target/wasm32-wasi/release/app.wasm \
    -d dictionary-one:foo=bar \
    -d dictionary-two:baz=boom

🪵 logging

The Compute@Edge runtime supports the notion of remote logging endpoints. These are addressed by name within your applications.

use fastly::log::Endpoint;

let mut endpoint = Endpoint::from_name("endpoint-name");
writeln!(endpoint, "hello {}", "wasm");

fasttime currently support these by logging directly to stdout by default.

🤝 tls

Using a tls certificate making tool like mkcert, create a new tls certificate and private key

mkcert -key-file key.pem -cert-file cert.pem 127.0.0.1 localhost

Then provide --tls-cert with a tls certifificate and --tls-key and tls private key to fasttime

$ fasttime -w target/wasm32-wasi/release/app.wasm \
    --tls-cert=./cert.pem \
    --tls-key=./key.pem

🔍 debugging

Set the RUST_LOG env variable to fastime=debug and run the cli as usual

RUST_LOG=fasttime=debug fasttime -w target/wasm32-wasi/release/app.wasm

⚙️ configuration file

All settings can also be put in a configuration file which can be loaded from the commandline. Commandline arguments override any settings in the config file, except backends and dictionaries, which will be merged with entries from the commandline superceding those with the same key from the config file.

$ fasttime -c my_config.toml

Example config file:

wasm = "my_app.wasm"
port = 3001
watch = true
tls-cert = "cert.pem"
tls-key = "key.pem"

[[backend]]
name = "backend-one"
address = "example.net"

[[backend]]
name = "backend-two"
address = "example.com"

[[dictionary]]
name = "dictionary-one"

[dictionary.entries]
hello = "there"
"key with a space" = "something"

[[dictionary]]
name = "dictionary-two"

[dictionary.entries]
apples = "oranges"

🚧 roadmap

  • list intentionally left blank.

Doug Tangren (softprops) 2020

Open Source Agenda is not affiliated with "Fasttime" Project. README Source: softprops/fasttime
Stars
60
Open Issues
12
Last Commit
3 years ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating