livesplit / splits-io-api Goto Github PK

For the speedrun.com API we use the exact same code. Instead of copy pasting it, we should make it available via some crate that anyone can use. One possibility is to usptream it into the http-client crate, which already has a similar, but really buggy implementation. However I consider those maintainers fairly toxic, so I'm not sure if I really want to upstream the code into that repository.

Additionally for the event stream we are introducing an async WebSocket implementation which we likely also want to upstream somewhere. The http-client crate may not be what we want for that as it doesn't have any WebSocket capabilities and we would need to provide one for their native backends. However for the native implementation we use tokio-tungstenite and the http-client maintainers have personal issues with the tokio maintainers. So that will cause even more problems.

I really just want to make a gloo-http crate (gloo is the JS APIs but as idiomatic Rust, so gloo-http would be ideal), but I'm not sure if making such a crate without having talked to the gloo maintainers beforehand is a good idea.

This needs a websocket implementation for WebAssembly and is blocked by snapview/tokio-tungstenite#68

We want to migrate to rustls for the dependencies that support it. This is blocked on hyper-rustls 0.19.0 releasing.

This commit added them to the JSON schema: glacials/splits-io@e89d7b2

The splits-io-api should work not only on Desktop platforms, but also when targeting the web. For that we'll use the wasm-bindgen ecosystem.

We soon want to release a version on crates.io, so it can be used from other crates such as livesplit-core.

This is blocked on our dependencies releasing non-preview crates now:

• hyper-rustls - There is a PR rustls/hyper-rustls#96
  • tokio-rustls - Released as 0.12.0
  • hyper - Released as 0.13.0, PR is merged hyperium/hyper#2030
    • h2 - Released as 0.2.0, PR is merged hyperium/h2#428
      • http - Released as 0.2.0 https://github.com/hyperium/http/releases/tag/v0.2.0

Alternatively

• hyper-tls - Released as 0.4.0, PR is merged hyperium/hyper-tls#54

We need some documentation for all of the public API.

I'm currently implementing the WASM support, and I'm seeing that the requests are like this:

So far we only have free standing functions that resemble the API, but we can do better by providing methods for the different types, that guide us along the API.

So we could do something like this:

let categories = runner::search(&client, "cryze").await?
    .first()?
    .pbs(&client).await?
    .first()?
    .game
    .categories(&client).await?
    .first()?;

This is a new API they have added that we don't yet support.

When lazily uploading a run, the custom error when writing to the body is just unwrapped instead of properly handled.