Small middleware for helping you implement server-on-client solutions with rust.
Idea inspired by wasm-service, which presented me to the server-on-client concept.
- Static hosting friendly! (Github Pages, Neocities, etc)¹
- Easier to share code between client-server and server-server in offline-first applications!
NOTE¹: most rust backend frameworks don't support wasm32-unknown-unknown (only axum apparently). This is due to the need for native dependencies.
WASI targets are the alternative, but WASI and its support in the browser is not good enough to make an effort towards making most frameworks WASI-compatible there.
- annotate a function with
#[oph::get_response]. The function should receive aRequestand return aResponse.
#[oph_macros::get_response]
fn handler(req: oph::Request) -> oph::Response {
oph::Response {
status: oph::http::status::StatusCode::OK,
headers: vec![("Content-Type".to_string(), "text/html".to_string())],
body: b"<p>hello world!<p>".to_vec()
}
}
- Pass an URL that returns the
.wasmto theOphconstructor andserveit.
const oph = new Oph("server.wasm")
oph.serve();
- Have
/ophSW.jsreturn theophSW.jsfile from the library
That's it! A service worker will then intercept all in-browser requests in that domain and forward them to the function marked with get_response in the Rust world.
From the project root:
cargo build -p <example-folder-name>
In an examples/ folder:
- Install the
oph-jsdependency
npm i
- Link
.wasmandophSW.jsto example folder root and run http server- The linking is needed so that
/ophSW.jsreturns the service worker during registration. Our service worker wouldn't be able to intercept all requests in the domain if its file wasn't served from the top level. - We also can't just do
../../target/during fetch to get the.wasmfile, hence its linking
- The linking is needed so that
npm run serve
- Access
localhost:8080and see the response in the console by typing³:
(await fetch('http://localhost:8080/hi')).text()
NOTE²: you may need to unregister the service worker to see different responses when switching between examples