[WIP] [PoC] '&' -> '&mut' #777

This is a (incomplete) proof of concept of a possible workaround for Sync issues that appear in async code.

Roughly, the issue is this:

Route handler futures must be Send. This requirement comes from Rocket, and would be nontrivial and/or undesirable to change in Rocket.
Handlers have an &PlumeRocket or an &Connection held across an await point
Therefore, &PlumeRocket / &Connection must be Send
&T: Send iff T: Sync, so PlumeRocket / Connection must be Sync
PlumeRocket contains a Connection, and Connection contains a diesel PgConnection, which is not Sync.

The approach demonstrated here is to change every &PlumeRocket or &Connection to an &mut PlumeRocket or &mut Connection. &mut T is Send if T is Send, so the problem is eliminated:

Route handler futures must be Send.
Handlers have an &mut PlumeRocket or an &mut Connection held across an await point
Therefore, &mut PlumeRocket / &mut Connection must be Send
&mut T: Send iff T: Send, so PlumeRocket / Connection must be Send
PlumeRocket contains a Connection, and Connection contains a diesel PgConnection, which is Send.

Downsides

In theory &PlumeRocket could allow more work to be done in parallel, at least in the future. It does not look like that is currently the case, since every call to the database blocks anyway.
This change is pervasive - it reaches all the way to FromId and Inbox. I know relatively little about the overall structure of this code, so this could be incorrect or inconvenient in ways I don't know about!
Many of the remaining errors are caused by or made worse by the & -> &mut change. A different solution that keeps & in more places would be easier to work with overall.
This approach does not address the problem of making blocking database calls inside async fns, which can cause issues ranging from degraded performance to deadlocks.

Alternatives

Put a Mutex around the Connection somewhere. Uncontended mutexes (which this one should be) are not a huge performance concern, but Mutex may be at least as or more unwieldy than this solution throughout the code.
Replace or wrap Connection with an API like conn.run(|c| Post::load(&c)).await, where run handles the synchronization. This has similar tradeoffs to a Mutex, is probably the most inconvenient option in terms of overall code changes, and is also a significant chunk of new code to write and debug. However, it has the advantage of being capable of fixing the blocking-in-async-fn problem.

This is a (incomplete) proof of concept of a possible workaround for `Sync` issues that appear in `async` code. Roughly, the issue is this: * Route handler futures must be `Send`. This requirement comes from Rocket, and would be nontrivial and/or undesirable to change in Rocket. * Handlers have an `&PlumeRocket` or an `&Connection` held across an `await` point * Therefore, `&PlumeRocket` / `&Connection` must be `Send` * `&T: Send` iff `T: Sync`, so `PlumeRocket` / `Connection` must be `Sync` * `PlumeRocket` contains a `Connection`, and `Connection` contains a diesel `PgConnection`, which is not `Sync`. The approach demonstrated here is to change every `&PlumeRocket` or `&Connection` to an `&mut PlumeRocket` or `&mut Connection`. `&mut T` is `Send` if `T` is `Send`, so the problem is eliminated: * Route handler futures must be `Send`. * Handlers have an `&mut PlumeRocket` or an `&mut Connection` held across an `await` point * Therefore, `&mut PlumeRocket` / `&mut Connection` must be `Send` * **`&mut T: Send` iff `T: Send`**, so `PlumeRocket` / `Connection` must be **`Send`** * `PlumeRocket` contains a `Connection`, and `Connection` contains a diesel `PgConnection`, which **is `Send`.** ## Downsides * In theory `&PlumeRocket` *could* allow more work to be done in parallel, at least in the future. It does not look like that is currently the case, since every call to the database blocks anyway. * This change is pervasive - it reaches all the way to `FromId` and `Inbox`. I know relatively little about the overall structure of this code, so this could be incorrect or inconvenient in ways I don't know about! * Many of the remaining errors are caused by or made worse by the `&` -> `&mut` change. A different solution that keeps `&` in more places would be easier to work with overall. * This approach does not address the problem of making blocking database calls inside `async` fns, which can cause issues ranging from degraded performance to deadlocks. ## Alternatives * Put a `Mutex` around the `Connection` somewhere. Uncontended mutexes (which this one should be) are not a *huge* performance concern, but `Mutex` may be at least as or more unwieldy than this solution throughout the code. * Replace or wrap `Connection` with an API like `conn.run(|c| Post::load(&c)).await`, where `run` handles the synchronization. This has similar tradeoffs to a `Mutex`, is probably the most inconvenient option in terms of overall code changes, and is also a significant chunk of new code to write and debug. However, it has the advantage of being capable of fixing the blocking-in-`async`-fn problem.

I think the best way to handle sql connections would be to have worker threads that are basically dedicated to that, and have a mpsc channel through which requests can be send to them, alongside a one shot channel that allow to return a result.
This is basically how actors work (like in Erlang and derivative, or the Actix lib for Rust), it would allow to keep &, would properly handle blocking operation out of async context, and maybe allow to compile both Postgresql and Sqlite in the same binary (however this would also be a lot of work, not that much new code, but lots of moving things around)

I think the best way to handle sql connections would be to have worker threads that are basically dedicated to that

Yeah, I think that's more or less the direction I was going with "wrap Connection with an API like conn.run(|c| Post::load(&c)).await". I agree that it's a nicer overall solution, with the biggest drawback being:

however this would also be a lot of work, not that much new code, but lots of moving things around

I agree that it's a nicer overall solution, with the biggest drawback being:

however this would also be a lot of work, not that much new code, but lots of moving things around

🤷‍♀️

we have come this far, we might as well do it right.