Addon Proxy

cargo run --release

Development

Routes to published addons:

# proxy_config.toml

[[routes]]
from = "stremio-addon-proxy.herokuapp.com/helloworld"
to = "https://stremio-addon-helloworld.herokuapp.com"

[[routes]]
from = "stremio-addon-proxy.herokuapp.com/rust-addon"
to = "https://stremio-addon-example.herokuapp.com"

Notes:

• Deployed addons and the proxy on Heroku may be broken for testing purposes.
• The first response may be slow because of Heroku dyno cold start.
• The proxy may have non-standard configuration - e.g. disabled cache.
• Addons and the proxy is currently deployed manually by Heroku CLI.

Benchmarks

cargo bench

See /benches/proxy_benchmark.rs

Format & Lint & Test

Run

cargo make verify

before the push.

• If you don't have cargo-make, install it by the command cargo install cargo-make

• You can run also individual verify sub-commands:

  • cargo make fmt or cargo fmt
  • cargo make clippy
  • cargo make test or cargo test

• Tested with:

  • rustc 1.44.1 (c7087fe00 2020-06-17)
  • rustc 1.46.0-nightly (feb3536eb 2020-06-09)

How it works

1. Layer - The Proxy core

1. Proxy is created and then started in main.rs.
2. New proxy requires callback on_request and HTTP client that will be sent to on_request.
3. The most important code is in proxy.rs - Proxy::start:
   1. The proxy tries to load ProxyConfigand open database.
   2. The proxy creates channel(s) for communication between the core and on_request callbacks (it's useful e.g. for ProxyConfig reloading though API calls).
   3. The server is started.

2. Layer - Middlewares

1. The most important function in this layer is on_request (in on_request.rs).
2. on_request receives user's request from the proxy core and then:
   1. The request is passed into middleware pipeline (function apply_request_middlewares).
   2. Middlewares return modified request or custom / error / cached response. Middlewares may invoke side-effects like the cache reloading during their execution.
   3. If the pipeline result is a response, then the response is returned by the proxy server.
   4. If the pipeline result is a request, then the request is sent and a successful valid response is cached and returned by the proxy server.

3. Layer - Business rules

1. Only business/domain specific rules are set in validations.rs
   • validate_request and validate_reponse.