Compare commits
15 Commits
v2.0.0
...
6d83df0a2c
| Author | SHA1 | Date | |
|---|---|---|---|
| 6d83df0a2c | |||
| a8f1804de9 | |||
| f39dfa4f84 | |||
| d83bb1748c | |||
| 5cdd80e694 | |||
| 5d909ca0a3 | |||
| d38a9e8a75 | |||
| 93411966d7 | |||
| d13ad11eb0 | |||
| 5612fba744 | |||
| 8b9dd0d9e8 | |||
| f41237392d | |||
| d0c2e7d6e1 | |||
| 4b8ea768b6 | |||
| 6fb063818a |
@@ -149,6 +149,39 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# ── Orphan sweep ────────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# The check above is VERSION-SCOPED: it only ever asks about the one
|
||||||
|
# version this run computed. That is enough to recover an orphan on
|
||||||
|
# the very next run, and useless afterwards — once any releasable
|
||||||
|
# commit lands, the next run computes a NEW version, never looks at
|
||||||
|
# the old tag again, and the orphan becomes permanent and silent.
|
||||||
|
#
|
||||||
|
# servuo-plugins v0.1.0 is the proof, and the proof is pointed: the
|
||||||
|
# commit that ADDED the recovery above was itself typed
|
||||||
|
# `fix(release): ... recover the orphaned v0.1.0 tag`, so it bumped to
|
||||||
|
# v0.1.1 — and the run that introduced the recovery stepped straight
|
||||||
|
# past the tag it was written to rescue. That tag is still orphaned.
|
||||||
|
#
|
||||||
|
# So every v* tag is checked, and anything missing a release is
|
||||||
|
# WARNED about. Deliberately not recovered: publishing an old version
|
||||||
|
# would mean building today's tree and shipping it under a tag whose
|
||||||
|
# tree it is not, which is worse than the inconsistency it fixes.
|
||||||
|
# A human decides whether to recover or drop it.
|
||||||
|
#
|
||||||
|
# Never fails the run. A sweep that can break a good release is a
|
||||||
|
# sweep someone will delete.
|
||||||
|
ORPHANS=""
|
||||||
|
for T in $(git tag -l 'v*' --sort=-v:refname); do
|
||||||
|
T_HTTP="$(curl -s -o /dev/null -w '%{http_code}' \
|
||||||
|
-H "Authorization: token $(printf '%s' "${REGISTRY_TOKEN:-}" | tr -d '\r\n')" \
|
||||||
|
"https://${GITEA_HOST}/api/v1/repos/${REPO}/releases/tags/${T}" || echo 000)"
|
||||||
|
[ "$T_HTTP" = "404" ] && ORPHANS="${ORPHANS} ${T}"
|
||||||
|
done
|
||||||
|
if [ -n "${ORPHANS}" ]; then
|
||||||
|
echo "::warning::Tags with no release:${ORPHANS} — a run failed after tagging. Publish or delete them; this job will not do either."
|
||||||
|
fi
|
||||||
|
|
||||||
# Changelog range. A recovery run has nothing after the tag, so
|
# Changelog range. A recovery run has nothing after the tag, so
|
||||||
# summarize what the tag itself contains rather than emitting an empty
|
# summarize what the tag itself contains rather than emitting an empty
|
||||||
# list: the range that produced it, i.e. previous-tag..this-tag.
|
# list: the range that produced it, i.e. previous-tag..this-tag.
|
||||||
@@ -342,18 +375,75 @@ jobs:
|
|||||||
# corrupt the Authorization header.
|
# corrupt the Authorization header.
|
||||||
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
||||||
|
|
||||||
REL_ID="$(curl -sSf -X POST "${API}/releases" \
|
PAYLOAD="$(jq -n --arg tag "$TAG" --arg body "$BODY" \
|
||||||
|
'{tag_name:$tag, name:$tag, body:$body, draft:false, prerelease:false}')"
|
||||||
|
|
||||||
|
# This POST is the step that orphaned tag v0.1.1 (run 75): it landed one
|
||||||
|
# second after the tag push and Gitea answered 500, having not finished
|
||||||
|
# processing the pushed tag. Re-running the workflow published the same
|
||||||
|
# four assets untouched, so the failure was a race, not a bad request.
|
||||||
|
#
|
||||||
|
# Two things went wrong there, and both are fixed here.
|
||||||
|
#
|
||||||
|
# 1. `curl -sSf` prints NO response body on an error status, so all the
|
||||||
|
# log carried was "curl: (22) ... error: 500" and the cause had to be
|
||||||
|
# inferred from timestamps. Capture the body and print it.
|
||||||
|
# 2. Nothing retried, so a transient 5xx became a permanent orphan tag.
|
||||||
|
# The plan step CAN recover one, but only on a run that reaches it --
|
||||||
|
# and a later push with no releasable commits stands down before it
|
||||||
|
# gets there, so in practice the tag sits until a human notices.
|
||||||
|
#
|
||||||
|
# 4xx is deliberately NOT retried: a bad token or a malformed body does
|
||||||
|
# not improve by being sent again, and retrying only turns a clear
|
||||||
|
# failure into a slow one.
|
||||||
|
REL_ID=""
|
||||||
|
for attempt in 1 2 3 4 5; do
|
||||||
|
HTTP="$(curl -s -o /tmp/rel.json -w '%{http_code}' -X POST "${API}/releases" \
|
||||||
-H "Authorization: token ${CI_TOKEN}" \
|
-H "Authorization: token ${CI_TOKEN}" \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d "$(jq -n --arg tag "$TAG" --arg body "$BODY" \
|
-d "${PAYLOAD}" || echo 000)"
|
||||||
'{tag_name:$tag, name:$tag, body:$body, draft:false, prerelease:false}')" \
|
|
||||||
| jq -r '.id')"
|
if [ "$HTTP" = "201" ] || [ "$HTTP" = "200" ]; then
|
||||||
|
REL_ID="$(jq -r '.id' /tmp/rel.json)"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "::warning::POST /releases attempt ${attempt} returned HTTP ${HTTP}"
|
||||||
|
echo "--- response body ---"
|
||||||
|
cat /tmp/rel.json || true
|
||||||
|
echo
|
||||||
|
echo "---------------------"
|
||||||
|
|
||||||
|
case "$HTTP" in
|
||||||
|
4*) echo "::error::HTTP ${HTTP} is a client error - not retrying."; exit 1 ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ "$attempt" = 5 ]; then
|
||||||
|
echo "::error::POST /releases still failing after 5 attempts. Tag ${TAG} is pushed but has no release."
|
||||||
|
echo "::error::Re-run this workflow - the plan step detects the orphan tag and republishes it."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
sleep $(( attempt * 5 ))
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ -z "$REL_ID" ] || [ "$REL_ID" = "null" ]; then
|
||||||
|
echo "::error::Release created but no id came back; refusing to upload assets blind."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
echo "Created release ${TAG} (id=${REL_ID})"
|
echo "Created release ${TAG} (id=${REL_ID})"
|
||||||
|
|
||||||
for f in "${BIN}-linux-x86_64" "${BIN}-linux-aarch64" "${BIN}-windows-x86_64.exe" SHA256SUMS; do
|
for f in "${BIN}-linux-x86_64" "${BIN}-linux-aarch64" "${BIN}-windows-x86_64.exe" SHA256SUMS; do
|
||||||
curl -sSf -X POST "${API}/releases/${REL_ID}/assets?name=${f}" \
|
# Same treatment. An upload that fails quietly leaves a release whose
|
||||||
|
# SHA256SUMS does not cover every binary it advertises, which is worse
|
||||||
|
# than no release at all -- that file IS the trust anchor.
|
||||||
|
HTTP="$(curl -s -o /tmp/asset.json -w '%{http_code}' -X POST "${API}/releases/${REL_ID}/assets?name=${f}" \
|
||||||
-H "Authorization: token ${CI_TOKEN}" \
|
-H "Authorization: token ${CI_TOKEN}" \
|
||||||
-F "attachment=@dist/${f}" >/dev/null
|
-F "attachment=@dist/${f}" || echo 000)"
|
||||||
|
if [ "$HTTP" != "201" ] && [ "$HTTP" != "200" ]; then
|
||||||
|
echo "::error::uploading ${f} returned HTTP ${HTTP}"
|
||||||
|
cat /tmp/asset.json || true
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
echo " uploaded ${f}"
|
echo " uploaded ${f}"
|
||||||
done
|
done
|
||||||
|
|
||||||
|
|||||||
@@ -52,7 +52,71 @@ use tracing_subscriber::EnvFilter;
|
|||||||
/// kinds are new, `GET /guilds` grows a `roster` key, and nothing existing changed shape. This is the
|
/// kinds are new, `GET /guilds` grows a `roster` key, and nothing existing changed shape. This is the
|
||||||
/// first bump that also needed a **store migration** (`guilds.members`), because it is the first to
|
/// first bump that also needed a **store migration** (`guilds.members`), because it is the first to
|
||||||
/// add a column to a table that already exists rather than a whole new table; see `store::migrate`.
|
/// add a column to a table that already exists rather than a whole new table; see `store::migrate`.
|
||||||
pub const PROTOCOL_VERSION: u32 = 4;
|
///
|
||||||
|
/// v5 (Protocol 5): three enrichments that are additive in the same way again, bumped together
|
||||||
|
/// rather than one at a time because a protocol bump is not cheap here — it costs a sidecar
|
||||||
|
/// release, a republished bundle and an operator update on every shard, so a field left out costs
|
||||||
|
/// a whole second round of that rather than a follow-up commit. They are:
|
||||||
|
///
|
||||||
|
/// * `house.decay` gains `ownerName` and a decay SCHEDULE — `nextStage`, `decayPeriodSec`,
|
||||||
|
/// `dynamicDecay`, and `estimatedCollapse` only where it is exactly knowable (at IDOC under
|
||||||
|
/// dynamic decay; at any stage under static decay, which has no randomness to wait out).
|
||||||
|
/// * `vendor.listing` gains `ownerAcct` — without which the frame names an owner nobody can
|
||||||
|
/// resolve to a person — and a `fees` object carrying the charge, the funds, the pay interval
|
||||||
|
/// and the resolved `dismissalAt`.
|
||||||
|
/// * `account.login.result` is a NEW kind: the verdict of a login, which the pre-existing
|
||||||
|
/// `account.login.attempt` structurally cannot carry (its EventSink fires before the auth
|
||||||
|
/// decision is made).
|
||||||
|
///
|
||||||
|
/// **No store migration this time**, unlike v4. Every frame is persisted whole and the board tables
|
||||||
|
/// index only the columns they already had, so the new fields ride inside the stored JSON and the
|
||||||
|
/// new kind lands in `events` like any other. That is the dumb-forwarder property doing its job:
|
||||||
|
/// the sidecar defines no schema for a frame's contents and so needs no change when they grow.
|
||||||
|
///
|
||||||
|
/// v6 (Protocol 6): the first bump that is about a GUARANTEE rather than about data, and the first
|
||||||
|
/// the sidecar mostly gets for free. Two things:
|
||||||
|
///
|
||||||
|
/// * **`idempotencyKey` on inbound commands.** A command that carries one is executed by the shard
|
||||||
|
/// at most once; a repeat is answered with the original reply rather than re-run. That is what
|
||||||
|
/// makes a world-writing verb retryable at all — until now a lost acknowledgement was
|
||||||
|
/// indistinguishable from a command that never applied, so the website had to declare every
|
||||||
|
/// write un-retryable and accept losing one rather than risk doubling it. The sidecar's part is
|
||||||
|
/// to CARRY the key (it rides in the command body, which every write endpoint already passes
|
||||||
|
/// through verbatim) and to understand the one new answer the shard can now give: `bridge.busy`,
|
||||||
|
/// meaning a command under that key is still in flight. See `web::respond`.
|
||||||
|
/// * **`champ.boss.killed` is a new kind**: a champion's defeat, with the damage table only the
|
||||||
|
/// shard ever sees. It was previously inferable from `champ.update` going `bossUp` true then
|
||||||
|
/// false alongside a nearby `mob.killed`, which is fragile and says nothing about who did the
|
||||||
|
/// work. It lands in `events` and on the feed like any other kind, with no code here at all —
|
||||||
|
/// the dumb-forwarder property again.
|
||||||
|
///
|
||||||
|
/// **No store migration.** Nothing gains a column; the new kind is persisted whole like every other.
|
||||||
|
///
|
||||||
|
/// # Protocol 8 — the Asset Bridge (docs/link/v8.md)
|
||||||
|
///
|
||||||
|
/// The shard starts sending the operator's own **client assets** over this link: the cliloc string
|
||||||
|
/// table, creature and item art, player models. The point is that an operator stops having to run
|
||||||
|
/// a GUI converter on a desktop to make their site render a bestiary, and the shard is the only
|
||||||
|
/// host that already has the client files — a ServUO server cannot boot without them.
|
||||||
|
///
|
||||||
|
/// Phase 1 is the transport, and the sidecar's share of it is three things:
|
||||||
|
///
|
||||||
|
/// * **A new command family, `assets.*`, forwarded verbatim** like every other. The first of them
|
||||||
|
/// is `assets.sources` — stage 1 of the import gate: what the client files currently are, and
|
||||||
|
/// what version of the shard's extractor would read them. No pixels cross on this call.
|
||||||
|
/// * **An inbound line cap** — [`shard::MAX_INBOUND_LINE_BYTES`]. This is the one change that is
|
||||||
|
/// not additive. `read_line` had no bound at all, which was survivable while the shard had no
|
||||||
|
/// reason to send a large line; protocol 8 gives it one deliberately, and an unbounded read
|
||||||
|
/// facing a component that now sends megabytes is a memory-exhaustion shape we would be
|
||||||
|
/// inventing ourselves.
|
||||||
|
/// * **Nothing else.** Assets ride the request/reply path, so `rpc::try_route` consumes them
|
||||||
|
/// before `app.rs` can persist them to the store and fan them out to every WebSocket
|
||||||
|
/// subscriber — which is what keeps a 512 KiB reply from being written to SQLite and broadcast
|
||||||
|
/// to every connected client. The dumb-forwarder property is doing real work here: the sidecar
|
||||||
|
/// does not know what an asset is, and must not learn.
|
||||||
|
///
|
||||||
|
/// **No store migration**, again: nothing on this plane is an event, so nothing is persisted.
|
||||||
|
pub const PROTOCOL_VERSION: u32 = 8;
|
||||||
|
|
||||||
// Not `#[tokio::main]`: on Windows the SCM dispatcher takes over this thread and starts the runtime
|
// Not `#[tokio::main]`: on Windows the SCM dispatcher takes over this thread and starts the runtime
|
||||||
// itself, on its own thread, once the service actually begins. The runtime is built by whichever
|
// itself, on its own thread, once the service actually begins. The runtime is built by whichever
|
||||||
|
|||||||
@@ -7,15 +7,130 @@
|
|||||||
//! Framing is newline-delimited JSON, bidirectional: the shard sends events, we send commands. We
|
//! Framing is newline-delimited JSON, bidirectional: the shard sends events, we send commands. We
|
||||||
//! accept one shard connection at a time and re-accept when it drops (the shard reconnects on its
|
//! accept one shard connection at a time and re-accept when it drops (the shard reconnects on its
|
||||||
//! own, with a bounded backoff).
|
//! own, with a bounded backoff).
|
||||||
|
//!
|
||||||
|
//! Inbound lines are **capped** (see [`MAX_INBOUND_LINE_BYTES`]). Until protocol 8 they were not:
|
||||||
|
//! `read_line` will buffer a line of any length, which was survivable only because the shard had
|
||||||
|
//! never had a reason to send a large one. The Asset Bridge gives it one, so the gap had to close
|
||||||
|
//! before it became a memory-exhaustion shape we invented ourselves.
|
||||||
|
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
use serde_json::Value;
|
use serde_json::Value;
|
||||||
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
|
use tokio::io::{AsyncBufRead, AsyncBufReadExt, AsyncWriteExt, BufReader};
|
||||||
use tokio::net::TcpListener;
|
use tokio::net::TcpListener;
|
||||||
use tokio::sync::{mpsc, Mutex};
|
use tokio::sync::{mpsc, Mutex};
|
||||||
use tracing::{info, warn};
|
use tracing::{info, warn};
|
||||||
|
|
||||||
|
/// The longest line the sidecar will accept from the shard, in bytes.
|
||||||
|
///
|
||||||
|
/// Set above the largest legal batch rather than at it: the shard cuts a batch when the next item
|
||||||
|
/// would take it past `Bridge.AssetBatchBytes` (512 KiB), and always admits the first item of a
|
||||||
|
/// page even when that item alone is bigger than the budget — so one page can legitimately
|
||||||
|
/// overshoot by one item. Doubling the budget to get this cap is what makes that overshoot safe
|
||||||
|
/// instead of a dropped reply.
|
||||||
|
///
|
||||||
|
/// Over-long lines are **discarded, not buffered**, and the connection stays up. That is the same
|
||||||
|
/// disposition `BridgeLink.cs` has always had for its own 1 MiB inbound cap in the other
|
||||||
|
/// direction, and it is the right one here: a single malformed frame is not a reason to tear down
|
||||||
|
/// a link that live events are flowing over. The dropped reply simply times out and is
|
||||||
|
/// re-requested, which is safe because everything on the asset plane is idempotent.
|
||||||
|
pub const MAX_INBOUND_LINE_BYTES: usize = 1024 * 1024;
|
||||||
|
|
||||||
|
/// What one read off the shard socket produced.
|
||||||
|
#[derive(Debug)]
|
||||||
|
enum Line {
|
||||||
|
/// A complete line, within the cap.
|
||||||
|
Complete(String),
|
||||||
|
/// A line that ran past the cap. Carries how many bytes were thrown away, for the log.
|
||||||
|
TooLong(usize),
|
||||||
|
/// The shard closed the connection.
|
||||||
|
Eof,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A cancel-safe, capped, newline-delimited reader.
|
||||||
|
///
|
||||||
|
/// Every piece of state that must survive a partial read lives here rather than in a local,
|
||||||
|
/// because this is polled inside a `tokio::select!`: the loop below drops the future whenever a
|
||||||
|
/// command wins the race, and a `discarding` flag or a half-filled buffer held in a local would be
|
||||||
|
/// lost with it. Losing the buffer corrupts the *next* line; losing `discarding` turns the tail of
|
||||||
|
/// an over-long line into a line of its own. Both are silent.
|
||||||
|
///
|
||||||
|
/// The only await point is `fill_buf`, and nothing is consumed until after it returns, so a
|
||||||
|
/// cancellation between the two can lose at most the wakeup.
|
||||||
|
#[derive(Default)]
|
||||||
|
struct LineReader {
|
||||||
|
buf: Vec<u8>,
|
||||||
|
discarding: bool,
|
||||||
|
discarded: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LineReader {
|
||||||
|
async fn next<R: AsyncBufRead + Unpin>(&mut self, reader: &mut R) -> std::io::Result<Line> {
|
||||||
|
loop {
|
||||||
|
let consumed;
|
||||||
|
let outcome;
|
||||||
|
|
||||||
|
{
|
||||||
|
let available = reader.fill_buf().await?;
|
||||||
|
|
||||||
|
if available.is_empty() {
|
||||||
|
return Ok(Line::Eof);
|
||||||
|
}
|
||||||
|
|
||||||
|
match available.iter().position(|&b| b == b'\n') {
|
||||||
|
Some(at) => {
|
||||||
|
consumed = at + 1;
|
||||||
|
|
||||||
|
if self.discarding {
|
||||||
|
// The tail of a line we already gave up on. Swallow it, terminator
|
||||||
|
// included, and report the size once.
|
||||||
|
self.discarded += at;
|
||||||
|
let total = self.discarded;
|
||||||
|
self.discarding = false;
|
||||||
|
self.discarded = 0;
|
||||||
|
outcome = Some(Line::TooLong(total));
|
||||||
|
} else if self.buf.len() + at > MAX_INBOUND_LINE_BYTES {
|
||||||
|
// The cap is reached only now, on the chunk that also holds the
|
||||||
|
// terminator — so there is nothing left to discard.
|
||||||
|
let total = self.buf.len() + at;
|
||||||
|
self.buf.clear();
|
||||||
|
outcome = Some(Line::TooLong(total));
|
||||||
|
} else {
|
||||||
|
self.buf.extend_from_slice(&available[..at]);
|
||||||
|
let line = String::from_utf8_lossy(&self.buf).into_owned();
|
||||||
|
self.buf.clear();
|
||||||
|
outcome = Some(Line::Complete(line));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
consumed = available.len();
|
||||||
|
|
||||||
|
if self.discarding {
|
||||||
|
self.discarded += consumed;
|
||||||
|
} else if self.buf.len() + consumed > MAX_INBOUND_LINE_BYTES {
|
||||||
|
// Refuse rather than buffer: this is the whole point of the cap.
|
||||||
|
// Everything up to the next newline is now dropped on the floor.
|
||||||
|
self.discarded = self.buf.len() + consumed;
|
||||||
|
self.buf.clear();
|
||||||
|
self.discarding = true;
|
||||||
|
} else {
|
||||||
|
self.buf.extend_from_slice(available);
|
||||||
|
}
|
||||||
|
|
||||||
|
outcome = None;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
reader.consume(consumed);
|
||||||
|
|
||||||
|
if let Some(line) = outcome {
|
||||||
|
return Ok(line);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// An event line received from the shard, parsed. `kind` is lifted out for routing.
|
/// An event line received from the shard, parsed. `kind` is lifted out for routing.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct ShardEvent {
|
pub struct ShardEvent {
|
||||||
@@ -112,16 +227,25 @@ async fn handle_connection(
|
|||||||
handle.set(Some(cmd_tx)).await;
|
handle.set(Some(cmd_tx)).await;
|
||||||
|
|
||||||
let mut reader = BufReader::new(read_half);
|
let mut reader = BufReader::new(read_half);
|
||||||
let mut line = String::new();
|
let mut lines = LineReader::default();
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
// Inbound: a line from the shard.
|
// Inbound: a line from the shard.
|
||||||
result = reader.read_line(&mut line) => {
|
result = lines.next(&mut reader) => {
|
||||||
let n = result?;
|
match result? {
|
||||||
if n == 0 {
|
Line::Eof => return Ok(()), // clean EOF: shard closed
|
||||||
return Ok(()); // clean EOF: shard closed
|
Line::TooLong(bytes) => {
|
||||||
|
// Deliberately not a disconnect. See MAX_INBOUND_LINE_BYTES: a reply lost
|
||||||
|
// this way times out on the caller's side and is re-requested, and tearing
|
||||||
|
// the link down would take the live event feed with it.
|
||||||
|
warn!(
|
||||||
|
bytes,
|
||||||
|
cap = MAX_INBOUND_LINE_BYTES,
|
||||||
|
"inbound line over the cap; discarded"
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
Line::Complete(line) => {
|
||||||
let trimmed = line.trim_end();
|
let trimmed = line.trim_end();
|
||||||
if !trimmed.is_empty() {
|
if !trimmed.is_empty() {
|
||||||
match serde_json::from_str::<Value>(trimmed) {
|
match serde_json::from_str::<Value>(trimmed) {
|
||||||
@@ -136,7 +260,8 @@ async fn handle_connection(
|
|||||||
Err(e) => warn!(error = %e, line = %trimmed, "unparseable event"),
|
Err(e) => warn!(error = %e, line = %trimmed, "unparseable event"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
line.clear();
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// Outbound: a command to write to the shard.
|
// Outbound: a command to write to the shard.
|
||||||
cmd = cmd_rx.recv() => {
|
cmd = cmd_rx.recv() => {
|
||||||
@@ -152,3 +277,108 @@ async fn handle_connection(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
/// Drives `LineReader` over a byte slice, returning every outcome up to EOF.
|
||||||
|
async fn read_all(input: &[u8]) -> Vec<Line> {
|
||||||
|
let mut reader = BufReader::with_capacity(64, input);
|
||||||
|
let mut lines = LineReader::default();
|
||||||
|
let mut out = Vec::new();
|
||||||
|
|
||||||
|
loop {
|
||||||
|
match lines.next(&mut reader).await.unwrap() {
|
||||||
|
Line::Eof => break,
|
||||||
|
other => out.push(other),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
fn complete(lines: &[Line]) -> Vec<&str> {
|
||||||
|
lines
|
||||||
|
.iter()
|
||||||
|
.filter_map(|l| match l {
|
||||||
|
Line::Complete(s) => Some(s.as_str()),
|
||||||
|
_ => None,
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn splits_on_newlines() {
|
||||||
|
let lines = read_all(b"{\"a\":1}\n{\"b\":2}\n").await;
|
||||||
|
assert_eq!(complete(&lines), vec!["{\"a\":1}", "{\"b\":2}"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The reader's buffer is 64 bytes here, so every one of these lines spans several
|
||||||
|
/// `fill_buf` chunks. Reassembly across chunks is the thing `read_line` did for us.
|
||||||
|
#[tokio::test]
|
||||||
|
async fn reassembles_across_chunks() {
|
||||||
|
let long = "x".repeat(500);
|
||||||
|
let input = format!("{}\n{}\n", long, long);
|
||||||
|
let lines = read_all(input.as_bytes()).await;
|
||||||
|
|
||||||
|
assert_eq!(complete(&lines), vec![long.as_str(), long.as_str()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The cap itself. The over-long line must be reported and thrown away, and — the part that
|
||||||
|
/// actually matters — the line *after* it must still arrive intact. A reader that lost its
|
||||||
|
/// `discarding` flag would emit the tail of the oversized line as a line of its own.
|
||||||
|
#[tokio::test]
|
||||||
|
async fn refuses_an_over_long_line_and_recovers() {
|
||||||
|
let mut input = Vec::new();
|
||||||
|
input.extend_from_slice(&b"a".repeat(MAX_INBOUND_LINE_BYTES + 10));
|
||||||
|
input.push(b'\n');
|
||||||
|
input.extend_from_slice(b"{\"kind\":\"pong\"}\n");
|
||||||
|
|
||||||
|
let lines = read_all(&input).await;
|
||||||
|
|
||||||
|
assert_eq!(lines.len(), 2);
|
||||||
|
assert!(
|
||||||
|
matches!(lines[0], Line::TooLong(n) if n >= MAX_INBOUND_LINE_BYTES),
|
||||||
|
"expected TooLong, got {:?}",
|
||||||
|
lines[0]
|
||||||
|
);
|
||||||
|
assert_eq!(complete(&lines), vec!["{\"kind\":\"pong\"}"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A line of exactly the cap is legal; one byte more is not. Checking both sides is what says
|
||||||
|
/// the comparison is `>` rather than `>=`, which would silently cost a byte of the budget.
|
||||||
|
#[tokio::test]
|
||||||
|
async fn the_cap_is_inclusive() {
|
||||||
|
let at_cap = "b".repeat(MAX_INBOUND_LINE_BYTES);
|
||||||
|
let lines = read_all(format!("{}\n", at_cap).as_bytes()).await;
|
||||||
|
assert_eq!(complete(&lines).len(), 1);
|
||||||
|
|
||||||
|
let over = "b".repeat(MAX_INBOUND_LINE_BYTES + 1);
|
||||||
|
let lines = read_all(format!("{}\n", over).as_bytes()).await;
|
||||||
|
assert!(complete(&lines).is_empty());
|
||||||
|
assert!(matches!(lines[0], Line::TooLong(_)));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An over-long line whose terminator lands in the very chunk that crosses the cap: the
|
||||||
|
/// reader must not leave itself in `discarding` and eat the next line as well.
|
||||||
|
#[tokio::test]
|
||||||
|
async fn over_long_line_terminating_in_the_crossing_chunk() {
|
||||||
|
let mut input = Vec::new();
|
||||||
|
input.extend_from_slice(&b"c".repeat(MAX_INBOUND_LINE_BYTES + 1));
|
||||||
|
input.extend_from_slice(b"\n{\"kind\":\"pong\"}\n");
|
||||||
|
|
||||||
|
let lines = read_all(&input).await;
|
||||||
|
|
||||||
|
assert!(matches!(lines[0], Line::TooLong(_)));
|
||||||
|
assert_eq!(complete(&lines), vec!["{\"kind\":\"pong\"}"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A partial line at EOF is dropped rather than delivered half-parsed. The shard reconnects
|
||||||
|
/// and re-sends; half a JSON object is not something to hand to the event fan-out.
|
||||||
|
#[tokio::test]
|
||||||
|
async fn trailing_partial_line_at_eof_is_dropped() {
|
||||||
|
let lines = read_all(b"{\"a\":1}\n{\"b\":").await;
|
||||||
|
assert_eq!(complete(&lines), vec!["{\"a\":1}"]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -72,6 +72,41 @@ pub async fn serve(addr: &str, state: AppState) -> anyhow::Result<()> {
|
|||||||
.route("/admin/ban", post(admin_ban))
|
.route("/admin/ban", post(admin_ban))
|
||||||
.route("/admin/unban", post(admin_unban))
|
.route("/admin/unban", post(admin_unban))
|
||||||
.route("/admin/broadcast", post(admin_broadcast))
|
.route("/admin/broadcast", post(admin_broadcast))
|
||||||
|
// The event plane (protocol 6, EVENTS_PLAN.md Phase 11b). Leases are a live config value
|
||||||
|
// the website holds for a bounded time; the shard restores baseline when the deadline
|
||||||
|
// passes whether or not anyone asks it to. GET lists the whole catalog with current values,
|
||||||
|
// which is the one read both `read()` and `inForce()` on the website's side are served by.
|
||||||
|
.route("/lease", get(lease_list).post(lease_apply))
|
||||||
|
.route("/lease/release", post(lease_release))
|
||||||
|
// The run-scoped participation ledger. `snapshot` is a POST despite being a read: it
|
||||||
|
// carries the caller's `idempotencyKey`, and on a well-attended run the shard walks its
|
||||||
|
// members across ticks rather than in one inbound call -- so a repeat arriving mid-walk is
|
||||||
|
// answered `bridge.busy`, and a read that can be refused as a repeat is not a GET.
|
||||||
|
.route("/participation", post(participation_open))
|
||||||
|
.route(
|
||||||
|
"/participation/:run_id/snapshot",
|
||||||
|
post(participation_snapshot),
|
||||||
|
)
|
||||||
|
.route("/participation/:run_id/close", post(participation_close))
|
||||||
|
// The world verbs (protocol 7, EVENTS_PLAN.md Phase 12a). Five things an event author
|
||||||
|
// can place -- creatures, an enhanced "boss", an oracle NPC, a temporary gate,
|
||||||
|
// decoration -- and ONE command family, because each of them ends in "an object exists
|
||||||
|
// and this run owns it". POST places, GET says what the run still owns, POST .../despawn
|
||||||
|
// gives it back. Ownership is held on the shard, so despawn cannot be pointed at a serial
|
||||||
|
// the run did not create.
|
||||||
|
.route("/world", post(world_spawn))
|
||||||
|
.route("/world/:run_id", get(world_owned))
|
||||||
|
.route("/world/:run_id/despawn", post(world_despawn))
|
||||||
|
// The one-shots (protocol 7 part b, EVENTS_PLAN.md Phase 12b). Neither owned nor
|
||||||
|
// borrowed: an item put into somebody's hands, and a world save. Both are `done is
|
||||||
|
// done`, which is why they are not in the world family -- there is nothing to give
|
||||||
|
// back and no ledger row core would come back for.
|
||||||
|
//
|
||||||
|
// `GET /items` is the shard's own grant allowlist, so the website's dropdown offers
|
||||||
|
// what this shard will actually build rather than what a module guessed.
|
||||||
|
.route("/items", get(item_catalog))
|
||||||
|
.route("/items/grant", post(item_grant))
|
||||||
|
.route("/world/save", post(world_save))
|
||||||
// Help-page (support) queue: snapshot the open queue, respond to / close a page.
|
// Help-page (support) queue: snapshot the open queue, respond to / close a page.
|
||||||
.route("/pages", get(pages_list))
|
.route("/pages", get(pages_list))
|
||||||
.route("/pages/:id/respond", post(page_respond))
|
.route("/pages/:id/respond", post(page_respond))
|
||||||
@@ -100,6 +135,12 @@ pub async fn serve(addr: &str, state: AppState) -> anyhow::Result<()> {
|
|||||||
// readability trap nobody wins. The only PAGED read the sidecar serves — a whole-world
|
// readability trap nobody wins. The only PAGED read the sidecar serves — a whole-world
|
||||||
// market does not fit in one response.
|
// market does not fit in one response.
|
||||||
.route("/market", get(market))
|
.route("/market", get(market))
|
||||||
|
// The Asset Bridge (Protocol 8). Stage 1 of the two-stage import gate: what the shard's
|
||||||
|
// UO client files currently are. RPC, never store-backed — unlike the boards above there
|
||||||
|
// is nothing here worth serving stale, because the only question this answers is "have
|
||||||
|
// the files on that host changed since the last import", and a cached answer to that is
|
||||||
|
// worse than no answer.
|
||||||
|
.route("/assets/sources", get(assets_sources))
|
||||||
.route_layer(middleware::from_fn_with_state(state.clone(), gate));
|
.route_layer(middleware::from_fn_with_state(state.clone(), gate));
|
||||||
|
|
||||||
let app = Router::new()
|
let app = Router::new()
|
||||||
@@ -246,13 +287,31 @@ fn constant_time_eq(a: &[u8], b: &[u8]) -> bool {
|
|||||||
|
|
||||||
// ---- shared reply handling ----
|
// ---- shared reply handling ----
|
||||||
|
|
||||||
|
/// Protocol 6. `bridge.busy` says a command carrying this `idempotencyKey` is already in flight on
|
||||||
|
/// the shard: nothing was run, and the caller should come back.
|
||||||
|
///
|
||||||
|
/// It maps to **425 Too Early**, which is what that status is for — a server unwilling to risk
|
||||||
|
/// processing a request that might be a replay. The obvious alternative, 409, is already the
|
||||||
|
/// protocol-version gate's answer, and those two want opposite dispositions from a client: a version
|
||||||
|
/// mismatch is a deployment fault nobody should retry, and a busy shard is a retry that should
|
||||||
|
/// succeed on its own. Sharing a status would have made the difference readable only by inspecting
|
||||||
|
/// the body, which is exactly how a retry loop ends up hiding a mismatched deployment.
|
||||||
|
///
|
||||||
|
/// It is checked BEFORE the `.error` suffix test in each responder below, and it is deliberately not
|
||||||
|
/// spelled `bridge.busy.error`: nothing is wrong. The work is happening.
|
||||||
|
const BUSY_KIND: &str = "bridge.busy";
|
||||||
|
const BUSY_STATUS: StatusCode = StatusCode::TOO_EARLY;
|
||||||
|
|
||||||
/// Turns an RPC result into an HTTP response. A `bridge.error` reply from the shard becomes a 4xx;
|
/// Turns an RPC result into an HTTP response. A `bridge.error` reply from the shard becomes a 4xx;
|
||||||
/// a real reply is returned as-is; transport failures map to 503/504.
|
/// a `bridge.busy` reply becomes a 425; a real reply is returned as-is; transport failures map to
|
||||||
|
/// 503/504.
|
||||||
fn respond(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
fn respond(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
||||||
match result {
|
match result {
|
||||||
Ok(value) => {
|
Ok(value) => {
|
||||||
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
if kind == "bridge.error" || kind.ends_with(".error") {
|
if kind == BUSY_KIND {
|
||||||
|
(BUSY_STATUS, Json(value))
|
||||||
|
} else if kind == "bridge.error" || kind.ends_with(".error") {
|
||||||
let reason = value
|
let reason = value
|
||||||
.get("reason")
|
.get("reason")
|
||||||
.and_then(|r| r.as_str())
|
.and_then(|r| r.as_str())
|
||||||
@@ -286,7 +345,9 @@ fn respond_admin(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
|||||||
match result {
|
match result {
|
||||||
Ok(value) => {
|
Ok(value) => {
|
||||||
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
if kind == "admin.error" {
|
if kind == BUSY_KIND {
|
||||||
|
(BUSY_STATUS, Json(value))
|
||||||
|
} else if kind == "admin.error" {
|
||||||
let reason = value
|
let reason = value
|
||||||
.get("reason")
|
.get("reason")
|
||||||
.and_then(|r| r.as_str())
|
.and_then(|r| r.as_str())
|
||||||
@@ -317,6 +378,70 @@ fn respond_admin(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Like `respond`, but for the event plane: leases and the participation ledger.
|
||||||
|
///
|
||||||
|
/// Two mappings are the point of it existing rather than reusing `respond`.
|
||||||
|
///
|
||||||
|
/// **`lease.drifted` is a 200.** The shard was asked to compare and set, it compared, and it
|
||||||
|
/// refused to overwrite somebody's deliberate change -- that is the mechanism working, not a
|
||||||
|
/// failure, and `cleanup.js` on the website treats `drifted` as a distinct successful outcome
|
||||||
|
/// rather than an error. It is also why this is not a 409: 409 is the protocol-version gate's, and
|
||||||
|
/// a version mismatch and a drifted lease want opposite dispositions from a caller. The same
|
||||||
|
/// argument protocol 6 made for `bridge.busy` being a 425.
|
||||||
|
///
|
||||||
|
/// **The event plane being switched off is a 403**, not the 400 the generic responder's
|
||||||
|
/// reason-sniffing would produce. `Bridge.EventsEnabled` is an operator's deliberate refusal to let
|
||||||
|
/// the website change the world on a schedule, and telling the website it sent a bad request would
|
||||||
|
/// send an administrator hunting a bug in a step that is written correctly.
|
||||||
|
fn respond_event(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
||||||
|
match result {
|
||||||
|
Ok(value) => {
|
||||||
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
|
if kind == BUSY_KIND {
|
||||||
|
(BUSY_STATUS, Json(value))
|
||||||
|
} else if kind.ends_with(".error") {
|
||||||
|
let reason = value
|
||||||
|
.get("reason")
|
||||||
|
.and_then(|r| r.as_str())
|
||||||
|
.unwrap_or("request rejected");
|
||||||
|
let code = if reason.contains("disabled") {
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
} else if reason.contains("no lease is offered")
|
||||||
|
|| reason.contains("not counting")
|
||||||
|
// Phase 12b. A grant against a run this shard has never been told to count
|
||||||
|
// is the same shape as an unknown lease key: the caller named something that
|
||||||
|
// does not exist here, which is a 404 and never a retry. It is deliberately
|
||||||
|
// NOT the same as a run whose ledger is open and empty -- that is a 200 with
|
||||||
|
// `granted: 0`, because "nobody came" is a result rather than a mistake.
|
||||||
|
|| reason.contains("no participation ledger")
|
||||||
|
{
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
} else if reason.contains("saves at most every") {
|
||||||
|
// A save refused because one just happened is the shard's rate limit, and it
|
||||||
|
// is TRANSIENT in a way nothing else on this plane is: the same request will
|
||||||
|
// succeed once the interval passes. 429 says exactly that, and keeps it out of
|
||||||
|
// the module's permanent-status set so a phase boundary is retried rather than
|
||||||
|
// abandoned.
|
||||||
|
StatusCode::TOO_MANY_REQUESTS
|
||||||
|
} else {
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
};
|
||||||
|
(code, Json(value))
|
||||||
|
} else {
|
||||||
|
(StatusCode::OK, Json(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(RpcError::NoShard) => (
|
||||||
|
StatusCode::SERVICE_UNAVAILABLE,
|
||||||
|
Json(json!({"error": "shard not connected"})),
|
||||||
|
),
|
||||||
|
Err(RpcError::Timeout) => (
|
||||||
|
StatusCode::GATEWAY_TIMEOUT,
|
||||||
|
Json(json!({"error": "shard did not reply in time"})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Like `respond`, but for the account-provisioning plane. Maps an `account.error` reply to a
|
/// Like `respond`, but for the account-provisioning plane. Maps an `account.error` reply to a
|
||||||
/// status by its reason: a name clash is a 409, the per-IP cap is a 429, a disabled/protected/
|
/// status by its reason: a name clash is a 409, the per-IP cap is a 429, a disabled/protected/
|
||||||
/// refused action is a 403, an unknown target or "not linked" is a 404, anything else a 400.
|
/// refused action is a 403, an unknown target or "not linked" is a 404, anything else a 400.
|
||||||
@@ -324,7 +449,9 @@ fn respond_account(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>)
|
|||||||
match result {
|
match result {
|
||||||
Ok(value) => {
|
Ok(value) => {
|
||||||
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
if kind == "account.error" {
|
if kind == BUSY_KIND {
|
||||||
|
(BUSY_STATUS, Json(value))
|
||||||
|
} else if kind == "account.error" {
|
||||||
let reason = value
|
let reason = value
|
||||||
.get("reason")
|
.get("reason")
|
||||||
.and_then(|r| r.as_str())
|
.and_then(|r| r.as_str())
|
||||||
@@ -454,6 +581,16 @@ async fn link_delete(
|
|||||||
/// Forwards a staff moderation command to the shard, correlated on a fresh reqId. Injects `kind`
|
/// Forwards a staff moderation command to the shard, correlated on a fresh reqId. Injects `kind`
|
||||||
/// and `reqId`, requiring the caller-supplied `actor` up front (the shard enforces it too). The
|
/// and `reqId`, requiring the caller-supplied `actor` up front (the shard enforces it too). The
|
||||||
/// body's remaining fields (account/serial/durationSec/reason/text/hue) pass straight through.
|
/// body's remaining fields (account/serial/durationSec/reason/text/hue) pass straight through.
|
||||||
|
///
|
||||||
|
/// **Protocol 6: `idempotencyKey` is one of those remaining fields**, and passing it through is the
|
||||||
|
/// whole of the sidecar's part in the guarantee. It is worth stating rather than leaving to the
|
||||||
|
/// word "remaining", because a later refactor that narrowed this to a known field list would quietly
|
||||||
|
/// turn every retried world write back into a possible duplicate, and nothing here would fail.
|
||||||
|
///
|
||||||
|
/// The key belongs to the CALLER's unit of work — the website's event step — so the sidecar neither
|
||||||
|
/// generates one nor validates it. Note also that `reqId` is regenerated on every call: a retry
|
||||||
|
/// carries the same idempotency key under a NEW correlation id, which is exactly why the shard
|
||||||
|
/// re-stamps a replayed reply rather than echoing the id the first attempt used.
|
||||||
async fn admin_call(st: &AppState, kind: &str, body: Value) -> (StatusCode, Json<Value>) {
|
async fn admin_call(st: &AppState, kind: &str, body: Value) -> (StatusCode, Json<Value>) {
|
||||||
let mut obj = match body {
|
let mut obj = match body {
|
||||||
Value::Object(m) => m,
|
Value::Object(m) => m,
|
||||||
@@ -504,6 +641,241 @@ async fn admin_broadcast(State(st): State<AppState>, Json(body): Json<Value>) ->
|
|||||||
admin_call(&st, "admin.broadcast", body).await
|
admin_call(&st, "admin.broadcast", body).await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---- event plane handlers (protocol 6, Phase 11b) ----
|
||||||
|
|
||||||
|
/// Forwards an event-plane command to the shard, correlated on a fresh reqId.
|
||||||
|
///
|
||||||
|
/// Deliberately NOT `admin_call`: that one requires an `actor`, because every verb behind it is a
|
||||||
|
/// staff member pressing a button and the shard's audit trail has to name them. An event verb's
|
||||||
|
/// author is a RUN, which the body already carries as `runId` -- and demanding an actor here would
|
||||||
|
/// have the runner inventing a human name for something no human is doing.
|
||||||
|
///
|
||||||
|
/// Everything else about it is the same, and the `idempotencyKey` passthrough matters for the same
|
||||||
|
/// reason it does there: the key is one of the body's remaining fields, and a refactor that
|
||||||
|
/// narrowed this to a known field list would silently make every retried lease a possible duplicate.
|
||||||
|
async fn event_call(st: &AppState, kind: &str, body: Value) -> (StatusCode, Json<Value>) {
|
||||||
|
let mut obj = match body {
|
||||||
|
Value::Object(m) => m,
|
||||||
|
Value::Null => serde_json::Map::new(),
|
||||||
|
_ => {
|
||||||
|
return (
|
||||||
|
StatusCode::BAD_REQUEST,
|
||||||
|
Json(json!({"error": "body must be a JSON object"})),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let req_id = st.rpc.next_req_id();
|
||||||
|
obj.insert("kind".to_string(), json!(kind));
|
||||||
|
obj.insert("reqId".to_string(), json!(req_id));
|
||||||
|
|
||||||
|
respond_event(st.rpc.call(&st.shard, Value::Object(obj), &req_id).await)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Every lease this shard offers, with what each is worth right now and what is holding it.
|
||||||
|
///
|
||||||
|
/// One read answers both questions the website asks about a lease: `read()` wants the current value
|
||||||
|
/// before it applies anything, and `inForce()` wants to know whether the shard still has a record
|
||||||
|
/// of the hold. Splitting them would be two round trips for one key.
|
||||||
|
///
|
||||||
|
/// **`held` means "the shard still has a record of this lease", not "the value is still
|
||||||
|
/// overridden".** A lease whose deadline has already fired stays listed, with `expired: true`,
|
||||||
|
/// until teardown collects its verdict -- otherwise a reconcile in that window would report it gone
|
||||||
|
/// and the website would write off a correctly-working backstop as an orphaned resource.
|
||||||
|
/// **`?key=` and `?target=` narrow it to one row, and a targeted key needs them** (protocol 7 part
|
||||||
|
/// b). `Spawner.MaxCount` is one capability over thousands of spawners, so it has no single
|
||||||
|
/// "current" and the catalog walk cannot fill one in -- while the website's `read()` needs exactly
|
||||||
|
/// one value for exactly one target before it applies anything. Naming both answers that.
|
||||||
|
///
|
||||||
|
/// The frame also carries `holds`: every lease this shard is actually holding, whatever key or
|
||||||
|
/// target it is on. A catalog walk can enumerate the KEYS but never the holds on a targeted one --
|
||||||
|
/// there is no list of spawners to walk -- so without it a reconcile after an outage would have no
|
||||||
|
/// way to ask "what are you still holding?".
|
||||||
|
async fn lease_list(State(st): State<AppState>, Query(q): Query<LeaseQuery>) -> impl IntoResponse {
|
||||||
|
let mut body = serde_json::Map::new();
|
||||||
|
if let Some(key) = q.key {
|
||||||
|
body.insert("key".to_string(), json!(key));
|
||||||
|
}
|
||||||
|
if let Some(target) = q.target {
|
||||||
|
body.insert("target".to_string(), json!(target));
|
||||||
|
}
|
||||||
|
let arg = if body.is_empty() {
|
||||||
|
Value::Null
|
||||||
|
} else {
|
||||||
|
Value::Object(body)
|
||||||
|
};
|
||||||
|
event_call(&st, "lease.list", arg).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Narrowing for `GET /lease`. Both optional: absent means the whole catalog, as before.
|
||||||
|
#[derive(Debug, Deserialize)]
|
||||||
|
struct LeaseQuery {
|
||||||
|
key: Option<String>,
|
||||||
|
target: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"key":"...","value":"...","holdMs":<ms>,"untilMs":<opt>,"runId":<opt>,"idempotencyKey":<opt>}.
|
||||||
|
///
|
||||||
|
/// **`holdMs` is authoritative and `untilMs` is carried for display.** An absolute deadline computed
|
||||||
|
/// on the website and honoured on the shard is a deadline measured against two clocks, and a shard
|
||||||
|
/// running ten minutes fast would restore a ten-minute lease the moment it took it. A duration is
|
||||||
|
/// immune to that; the absolute time is still worth sending so a console can say when the hold ends.
|
||||||
|
///
|
||||||
|
/// Values cross as TEXT whatever the lease's declared type, because JSON would otherwise decide for
|
||||||
|
/// us: `1200` and `1200.0` are one number to a parser and two strings to a compare-and-set.
|
||||||
|
async fn lease_apply(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "lease.apply", body).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"key":"...","expected":"...","baseline":"...","idempotencyKey":<opt>}.
|
||||||
|
///
|
||||||
|
/// `expected` is what the event applied and `baseline` is what to put back, both out of the
|
||||||
|
/// website's ledger rather than the shard's memory -- so a release still works after a reconnect,
|
||||||
|
/// and a shard that has forgotten the lease entirely (a restart, which reverts every lease anyway)
|
||||||
|
/// can answer honestly instead of refusing.
|
||||||
|
///
|
||||||
|
/// A mismatch comes back `lease.drifted` with a **200**: see `respond_event`.
|
||||||
|
async fn lease_release(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "lease.release", body).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"runId":"...","map":"Felucca","x":N,"y":N,"radius":N,"holdMs":<opt>}.
|
||||||
|
///
|
||||||
|
/// Declares where a run happens and starts counting who is there. The area is a map, a point and a
|
||||||
|
/// radius rather than a region name, because protocol 6's own live walk established that the most
|
||||||
|
/// specific region containing an event is routinely anonymous.
|
||||||
|
async fn participation_open(
|
||||||
|
State(st): State<AppState>,
|
||||||
|
Json(body): Json<Value>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
event_call(&st, "participation.open", body).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"idempotencyKey":<opt>}. Answers the run's tally, best-effort resolved to accounts.
|
||||||
|
///
|
||||||
|
/// A POST for a read, and the reason is worth keeping: on a well-attended run the shard walks its
|
||||||
|
/// members in chunks across Core ticks rather than handing the whole resolve to one inbound call,
|
||||||
|
/// so the handler completes after its call returned and a repeat arriving in between is answered
|
||||||
|
/// `bridge.busy`. A read that can legitimately be refused as a repeat in flight is not a GET.
|
||||||
|
async fn participation_snapshot(
|
||||||
|
State(st): State<AppState>,
|
||||||
|
Path(run_id): Path<String>,
|
||||||
|
Json(body): Json<Value>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
let mut obj = match body {
|
||||||
|
Value::Object(m) => m,
|
||||||
|
_ => serde_json::Map::new(),
|
||||||
|
};
|
||||||
|
obj.insert("runId".to_string(), json!(run_id));
|
||||||
|
event_call(&st, "participation.snapshot", Value::Object(obj)).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"idempotencyKey":<opt>}. Stops counting; the tally stays readable through the shard's
|
||||||
|
/// grace window, because closing an event and collecting its results are two steps and either can
|
||||||
|
/// be retried.
|
||||||
|
async fn participation_close(
|
||||||
|
State(st): State<AppState>,
|
||||||
|
Path(run_id): Path<String>,
|
||||||
|
Json(body): Json<Value>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
let mut obj = match body {
|
||||||
|
Value::Object(m) => m,
|
||||||
|
_ => serde_json::Map::new(),
|
||||||
|
};
|
||||||
|
obj.insert("runId".to_string(), json!(run_id));
|
||||||
|
event_call(&st, "participation.close", Value::Object(obj)).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"runId":"...","what":"creature|boss|npc|gate|decor","map":"...","x":N,"y":N,...}.
|
||||||
|
///
|
||||||
|
/// One route for five author-facing verbs. The `what` discriminator is a wire detail: the
|
||||||
|
/// differences between them -- a boss's multipliers, an oracle's lines, a gate's destination and
|
||||||
|
/// `holdMs` -- are fields on one command rather than five commands, so there is one ledger shape,
|
||||||
|
/// one teardown path and one reconcile instead of five near-identical ones in three repos.
|
||||||
|
///
|
||||||
|
/// The shard registers every serial it places against the run and PERSISTS that registry beside
|
||||||
|
/// the world save, which is what makes `world_despawn` below safe: a spawned creature survives a
|
||||||
|
/// restart, so an in-memory registry would leave the website holding serials the shard would not
|
||||||
|
/// vouch for.
|
||||||
|
async fn world_spawn(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "world.spawn", body).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// What the run still owns, and the answer the website's `reconcile()` is built on.
|
||||||
|
///
|
||||||
|
/// A GET, unlike `participation_snapshot`: it carries no idempotency key and the shard answers it
|
||||||
|
/// in one pass, pruning rows whose object the world has already lost as it walks. Anything not
|
||||||
|
/// listed is gone -- which is the shape core wants, because it takes a row out of its ledger only
|
||||||
|
/// on an explicit reply and this is that reply.
|
||||||
|
async fn world_owned(State(st): State<AppState>, Path(run_id): Path<String>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "world.owned", json!({ "runId": run_id })).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"serials":[...]} -- or no serials at all, which means everything the run owns and is the
|
||||||
|
/// call teardown actually makes.
|
||||||
|
///
|
||||||
|
/// Three answers, and the split is why the shard keeps a registry at all. `removed` was found and
|
||||||
|
/// deleted; `gone` was owned but already absent, which is what happens when a player kills an event
|
||||||
|
/// creature and is a SUCCESS; `refused` was never this run's to delete, and is the only answer here
|
||||||
|
/// that means somebody asked for something they should not have.
|
||||||
|
async fn world_despawn(
|
||||||
|
State(st): State<AppState>,
|
||||||
|
Path(run_id): Path<String>,
|
||||||
|
Json(body): Json<Value>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
let mut obj = match body {
|
||||||
|
Value::Object(m) => m,
|
||||||
|
_ => serde_json::Map::new(),
|
||||||
|
};
|
||||||
|
obj.insert("runId".to_string(), json!(run_id));
|
||||||
|
event_call(&st, "world.despawn", Value::Object(obj)).await
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- the one-shots (protocol 7 part b) ----
|
||||||
|
|
||||||
|
/// What this shard is willing to grant, and the bounds it will grant within.
|
||||||
|
///
|
||||||
|
/// A read, so the website's option source offers what this shard will actually build. The module
|
||||||
|
/// holds the same list, which is two copies of a short allowlist on purpose and exactly how the
|
||||||
|
/// lease bounds are already carried: the module's copy is what makes a bad value a refusal on a
|
||||||
|
/// form, and this one is what is true when the website is wrong.
|
||||||
|
async fn item_catalog(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "item.catalog", Value::Null).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"runId":"...","item":"gold","amount":N,"hue":<opt>,"name":<opt>,"where":<opt>,"idempotencyKey":<opt>}.
|
||||||
|
///
|
||||||
|
/// **The recipients are not in the body, and that is the design.** The shard already holds the
|
||||||
|
/// run's participation ledger (protocol 6 part b), keyed by the same character serials the
|
||||||
|
/// website's `member_key` holds, so the grant names a run and the shard resolves who was there.
|
||||||
|
/// Sending a list would mean the same list crossing the wire twice with a window in which the two
|
||||||
|
/// disagree -- and it would have needed a core surface handing a module core's own participants.
|
||||||
|
///
|
||||||
|
/// A run with no ledger open is a 404, not an empty success: "nobody came" and "you never told me
|
||||||
|
/// to count" are different facts, and only the first is a result a run should record.
|
||||||
|
///
|
||||||
|
/// **Retryable, and protocol 6 is why.** `EVENTS.md` §G called a grant un-retryable because a lost
|
||||||
|
/// acknowledgement and a grant that never applied looked the same -- exactly the argument that made
|
||||||
|
/// `uo.broadcast` answer `retry: false` in Phase 9. An `idempotencyKey` closes that: a repeat is
|
||||||
|
/// answered by the original reply, so a retried grant cannot be one winner receiving two.
|
||||||
|
async fn item_grant(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "item.grant", body).await
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Body: {"idempotencyKey":<opt>}. Starts a world save, useful as a phase boundary.
|
||||||
|
///
|
||||||
|
/// The reply says the save was STARTED and nothing more. What actually happened rides
|
||||||
|
/// `world.save.before` / `world.save.after`, which have been on the event stream since protocol 2 --
|
||||||
|
/// so this route asserts nothing it cannot know, and a caller that needs the completion watches the
|
||||||
|
/// stream it is already connected to.
|
||||||
|
///
|
||||||
|
/// **A save too soon after the last one is refused, not queued**, and the shard counts ServUO's own
|
||||||
|
/// autosave as the last one. A save stops the world; a queued one would land at a moment nobody
|
||||||
|
/// chose, in the middle of whatever the next step is doing.
|
||||||
|
async fn world_save(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
event_call(&st, "world.save", body).await
|
||||||
|
}
|
||||||
|
|
||||||
// ---- help-page queue handlers ----
|
// ---- help-page queue handlers ----
|
||||||
|
|
||||||
/// The open help-page queue, correlated on reqId. Returns a pages.list.
|
/// The open help-page queue, correlated on reqId. Returns a pages.list.
|
||||||
@@ -930,6 +1302,76 @@ async fn market(State(st): State<AppState>, Query(q): Query<PageQuery>) -> impl
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---- the Asset Bridge (Protocol 8) ----
|
||||||
|
|
||||||
|
/// Stage 1 of the import gate: the shard's UO client files as they are right now — size, mtime and
|
||||||
|
/// content hash — plus the version of the extractor that would read them, and whether this host
|
||||||
|
/// can render an image at all.
|
||||||
|
///
|
||||||
|
/// The website diffs this against what it last imported and, in the overwhelmingly common case
|
||||||
|
/// that nothing changed, stops. That is the whole reason stage 1 exists separately from the asset
|
||||||
|
/// manifest: the normal case is a restart that changed nothing, and it has to cost nothing.
|
||||||
|
///
|
||||||
|
/// Forwarded verbatim, like everything else on this link. The sidecar does not know what a cliloc
|
||||||
|
/// or an anim file is, does not cache this, and has no opinion about what the website does with
|
||||||
|
/// the answer — the same dumb-forwarder property that keeps access control on the website where it
|
||||||
|
/// belongs.
|
||||||
|
async fn assets_sources(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
let req_id = st.rpc.next_req_id();
|
||||||
|
let cmd = json!({"kind": "assets.sources", "reqId": req_id});
|
||||||
|
|
||||||
|
respond_assets(st.rpc.call(&st.shard, cmd, &req_id).await)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Maps an asset-plane reply to a status.
|
||||||
|
///
|
||||||
|
/// Two of these matter more than the rest and neither is the generic responder's answer:
|
||||||
|
///
|
||||||
|
/// **`bridge.busy` is a 425**, as everywhere else. On this plane it is not an idempotency
|
||||||
|
/// collision, it is flow control: the shard serves one asset request at a time on purpose, because
|
||||||
|
/// its outbound queue is bounded in *lines* and a queue of large replies is how the shard runs out
|
||||||
|
/// of memory. So it means "come back", it is entirely expected during an import, and a caller that
|
||||||
|
/// treated it as an error would abandon a perfectly healthy transfer.
|
||||||
|
///
|
||||||
|
/// **The plane being switched off is a 403.** `Bridge.AssetsEnabled` is an operator declining to
|
||||||
|
/// let the website read their client files off this host — a deliberate refusal, not a malformed
|
||||||
|
/// request — and answering 400 would send an administrator hunting a bug in a call that is written
|
||||||
|
/// correctly. Same argument the event plane's gate made in protocol 7.
|
||||||
|
fn respond_assets(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
||||||
|
match result {
|
||||||
|
Ok(value) => {
|
||||||
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
|
|
||||||
|
if kind == BUSY_KIND {
|
||||||
|
(BUSY_STATUS, Json(value))
|
||||||
|
} else if kind == "assets.error" {
|
||||||
|
let reason = value
|
||||||
|
.get("reason")
|
||||||
|
.and_then(|r| r.as_str())
|
||||||
|
.unwrap_or("request rejected");
|
||||||
|
|
||||||
|
let code = if reason.contains("disabled") {
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
} else {
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
};
|
||||||
|
|
||||||
|
(code, Json(value))
|
||||||
|
} else {
|
||||||
|
(StatusCode::OK, Json(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(RpcError::NoShard) => (
|
||||||
|
StatusCode::SERVICE_UNAVAILABLE,
|
||||||
|
Json(json!({"error": "shard not connected"})),
|
||||||
|
),
|
||||||
|
Err(RpcError::Timeout) => (
|
||||||
|
StatusCode::GATEWAY_TIMEOUT,
|
||||||
|
Json(json!({"error": "shard did not reply in time"})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ---- websocket ----
|
// ---- websocket ----
|
||||||
|
|
||||||
async fn ws_upgrade(ws: WebSocketUpgrade, State(state): State<AppState>) -> impl IntoResponse {
|
async fn ws_upgrade(ws: WebSocketUpgrade, State(state): State<AppState>) -> impl IntoResponse {
|
||||||
@@ -978,3 +1420,350 @@ async fn ws_client(mut socket: WebSocket, state: AppState) {
|
|||||||
|
|
||||||
info!("ws client disconnected");
|
info!("ws client disconnected");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn reply(kind: &str) -> Result<Value, RpcError> {
|
||||||
|
Ok(json!({"t": 1, "kind": kind, "reqId": "r-9"}))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Protocol 6. Every responder must recognise `bridge.busy`, because every write plane can be
|
||||||
|
/// retried: the staff plane, the account plane and the plain command plane all reach handlers
|
||||||
|
/// that a keyed retry can arrive at. A responder that missed it would return 200 with a body
|
||||||
|
/// saying nothing happened, which is the worst of the three possible answers.
|
||||||
|
#[test]
|
||||||
|
fn busy_maps_to_425_on_every_plane() {
|
||||||
|
assert_eq!(respond(reply("bridge.busy")).0, StatusCode::TOO_EARLY);
|
||||||
|
assert_eq!(respond_admin(reply("bridge.busy")).0, StatusCode::TOO_EARLY);
|
||||||
|
assert_eq!(
|
||||||
|
respond_account(reply("bridge.busy")).0,
|
||||||
|
StatusCode::TOO_EARLY
|
||||||
|
);
|
||||||
|
assert_eq!(respond_event(reply("bridge.busy")).0, StatusCode::TOO_EARLY);
|
||||||
|
|
||||||
|
// Protocol 8. On the asset plane `bridge.busy` is not a keyed retry colliding with itself
|
||||||
|
// -- it is flow control, and it is the ORDINARY answer during an import rather than a rare
|
||||||
|
// one. The shard serves one asset request at a time because its outbound queue is bounded
|
||||||
|
// in lines, not bytes, so a queue of large replies is how it runs out of memory. A
|
||||||
|
// responder that answered 200 here would tell the website an import step succeeded and
|
||||||
|
// returned nothing.
|
||||||
|
assert_eq!(
|
||||||
|
respond_assets(reply("bridge.busy")).0,
|
||||||
|
StatusCode::TOO_EARLY
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The asset plane's own gate, and it is a refusal rather than a mistake: an operator who has
|
||||||
|
/// not enabled `Bridge.AssetsEnabled` has declined to let the website read their UO client
|
||||||
|
/// files off the shard host. 403, for the same reason the event plane's switch is a 403.
|
||||||
|
#[test]
|
||||||
|
fn assets_disabled_is_a_403() {
|
||||||
|
let value = json!({
|
||||||
|
"kind": "assets.error",
|
||||||
|
"reqId": "r-9",
|
||||||
|
"reason": "asset extraction is disabled on this shard"
|
||||||
|
});
|
||||||
|
|
||||||
|
assert_eq!(respond_assets(Ok(value)).0, StatusCode::FORBIDDEN);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Anything else the shard refuses on this plane is the caller's mistake.
|
||||||
|
#[test]
|
||||||
|
fn other_asset_errors_are_400() {
|
||||||
|
let value = json!({
|
||||||
|
"kind": "assets.error",
|
||||||
|
"reason": "assets.sources requires a reqId"
|
||||||
|
});
|
||||||
|
|
||||||
|
assert_eq!(respond_assets(Ok(value)).0, StatusCode::BAD_REQUEST);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A source manifest comes back whole. Worth asserting because `respond_assets` sniffs `kind`
|
||||||
|
/// and a family whose success kind ends in `.ok` sits one character away from the `.error`
|
||||||
|
/// suffix the generic responder matches on -- which is exactly why this plane has its own
|
||||||
|
/// responder and matches `assets.error` exactly rather than by suffix.
|
||||||
|
#[test]
|
||||||
|
fn a_source_manifest_is_a_200() {
|
||||||
|
let value = json!({
|
||||||
|
"kind": "assets.sources.ok",
|
||||||
|
"reqId": "r-9",
|
||||||
|
"extractorVersion": 1,
|
||||||
|
"imaging": {"ok": true},
|
||||||
|
"files": [],
|
||||||
|
"more": false,
|
||||||
|
"cut": "end"
|
||||||
|
});
|
||||||
|
|
||||||
|
let (status, body) = respond_assets(Ok(value));
|
||||||
|
|
||||||
|
assert_eq!(status, StatusCode::OK);
|
||||||
|
assert_eq!(
|
||||||
|
body.0.get("extractorVersion").and_then(|v| v.as_i64()),
|
||||||
|
Some(1)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A shard that is not connected is a 503 and a shard that did not answer in time is a 504,
|
||||||
|
/// and the asset plane needs the second one to stay distinct more than any other plane does:
|
||||||
|
/// hashing a 195 MB anim.mul is the one thing on this link that can genuinely outlast the
|
||||||
|
/// 10 s reply timeout, and the website's response to that is to poll again rather than to
|
||||||
|
/// declare the shard down.
|
||||||
|
#[test]
|
||||||
|
fn asset_transport_failures_keep_their_own_statuses() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_assets(Err(RpcError::NoShard)).0,
|
||||||
|
StatusCode::SERVICE_UNAVAILABLE
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_assets(Err(RpcError::Timeout)).0,
|
||||||
|
StatusCode::GATEWAY_TIMEOUT
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The event plane is the FIRST place `bridge.busy` is reachable on a live shard rather than
|
||||||
|
/// only in a unit test: `participation.snapshot` walks a well-attended run's members across
|
||||||
|
/// Core ticks, so it completes after its inbound call returned and a repeat can genuinely land
|
||||||
|
/// mid-flight. 11a built the door and had nothing to walk through it.
|
||||||
|
#[test]
|
||||||
|
fn a_drifted_lease_is_a_200_not_a_409() {
|
||||||
|
let value =
|
||||||
|
json!({"kind": "lease.drifted", "key": "PlayerCaps.SkillCap", "current": "1300"});
|
||||||
|
let (status, body) = respond_event(Ok(value));
|
||||||
|
|
||||||
|
// The shard was asked to compare and set, it compared, and it declined to overwrite
|
||||||
|
// somebody's deliberate change. That is the mechanism working; the website records
|
||||||
|
// `drifted` as a distinct successful outcome rather than an error.
|
||||||
|
assert_eq!(status, StatusCode::OK);
|
||||||
|
assert_eq!(body.0.get("current").and_then(|v| v.as_str()), Some("1300"));
|
||||||
|
|
||||||
|
// And explicitly not the version gate's status, for the reason 425 is not either: a
|
||||||
|
// mismatched deployment and a moved value want opposite dispositions from a caller.
|
||||||
|
assert_ne!(status, StatusCode::CONFLICT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The event plane being switched off is an operator's refusal, not a malformed request. A 400
|
||||||
|
/// would send an administrator hunting a bug in a step that is written correctly.
|
||||||
|
#[test]
|
||||||
|
fn the_event_gate_being_off_is_a_403() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "lease.error",
|
||||||
|
"reason": "the event plane is disabled on this shard (Bridge.EventsEnabled)"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "participation.error",
|
||||||
|
"reason": "the event plane is disabled on this shard (Bridge.EventsEnabled)"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Protocol 7's world verbs go through the same responder, and this pins the two mappings
|
||||||
|
/// they depend on rather than trusting that the reason-sniffing above keeps covering a kind
|
||||||
|
/// it was written before.
|
||||||
|
///
|
||||||
|
/// A CEILING refusal is a 400 on purpose. It is permanent -- retrying "you asked for 80
|
||||||
|
/// creatures and this shard places 30" gets the same answer forever -- and it is the module's
|
||||||
|
/// `PERMANENT_STATUSES` that has to see it as such, so classifying it as anything retryable
|
||||||
|
/// would put a run in a loop against a limit that will never move.
|
||||||
|
#[test]
|
||||||
|
fn a_world_refusal_is_a_400_and_the_gate_is_still_a_403() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "world.error",
|
||||||
|
"action": "spawn",
|
||||||
|
"reason": "this shard places 1 to 30 of 'creature' at a time, and 80 was asked for"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "world.error",
|
||||||
|
"action": "spawn",
|
||||||
|
"reason": "the event plane is disabled on this shard (Bridge.EventsEnabled)"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A run the shard has no registry rows for answers with an EMPTY hand, not a 404, and the
|
||||||
|
/// distinction is load-bearing for reconcile.
|
||||||
|
///
|
||||||
|
/// "This run owns nothing" and "I have never heard of this run" are the same fact once the
|
||||||
|
/// registry is the only record of ownership, and they stay the same fact across a restart:
|
||||||
|
/// the registry is written by `EventSink.WorldSave`, so it and the objects it describes are
|
||||||
|
/// saved and lost together. A 404 here would make the website treat a run that legitimately
|
||||||
|
/// owns nothing as a shard it could not reach.
|
||||||
|
#[test]
|
||||||
|
fn a_run_owning_nothing_is_an_empty_list_not_a_404() {
|
||||||
|
let (status, body) = respond_event(Ok(json!({
|
||||||
|
"kind": "world.owned.ok",
|
||||||
|
"runId": "77",
|
||||||
|
"owned": [],
|
||||||
|
"pruned": 0
|
||||||
|
})));
|
||||||
|
|
||||||
|
assert_eq!(status, StatusCode::OK);
|
||||||
|
assert_eq!(
|
||||||
|
body.0
|
||||||
|
.get("owned")
|
||||||
|
.and_then(|v| v.as_array())
|
||||||
|
.map(|a| a.len()),
|
||||||
|
Some(0)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An unknown lease key and an unknown run are not-founds; anything else the shard refuses is a
|
||||||
|
/// bad request. The catalog is short and a typo in a step is the likely cause of both.
|
||||||
|
#[test]
|
||||||
|
fn unknown_lease_and_run_are_404s() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "lease.error",
|
||||||
|
"reason": "no lease is offered for key 'Loot.MaxProps'"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "participation.error",
|
||||||
|
"reason": "this shard is not counting run '42'"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "lease.error",
|
||||||
|
"reason": "a lease needs a positive holdMs"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A run this shard was never told to count is a 404; a run that WAS counted and had no
|
||||||
|
/// attendees is a 200. Protocol 7 part b.
|
||||||
|
#[test]
|
||||||
|
fn an_uncounted_run_is_a_404_and_an_empty_one_is_not() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "oneshot.error",
|
||||||
|
"reason": "run 42 has no participation ledger open on this shard"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
);
|
||||||
|
// The distinction the 404 exists to preserve. "Nobody came" is a RESULT -- an event
|
||||||
|
// nobody attended still happened -- and answering it as a failure would have the module
|
||||||
|
// retry a grant against a ledger that will be just as empty next time.
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "item.grant.ok",
|
||||||
|
"runId": "42",
|
||||||
|
"granted": 0,
|
||||||
|
"missed": []
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::OK
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The save rate limit is the one refusal on this plane that the same request will get past
|
||||||
|
/// by waiting, so it is a 429 rather than the 400 every other refusal is.
|
||||||
|
#[test]
|
||||||
|
fn a_save_refused_for_coming_too_soon_is_a_429() {
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "oneshot.error",
|
||||||
|
"reason": "this shard saves at most every 300 seconds, and the last save was 12 seconds ago"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::TOO_MANY_REQUESTS
|
||||||
|
);
|
||||||
|
// And an ordinary refusal on the same plane is still a 400, so the 429 is not swallowing
|
||||||
|
// the class it sits beside: a grant this shard does not offer will never succeed, however
|
||||||
|
// long the caller waits.
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "oneshot.error",
|
||||||
|
"reason": "this shard does not grant 'castle'"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
);
|
||||||
|
// The event gate being off stays a 403 on this plane too -- it is an operator's deliberate
|
||||||
|
// refusal, not a bad request.
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(Ok(json!({
|
||||||
|
"kind": "oneshot.error",
|
||||||
|
"reason": "the event plane is disabled on this shard (Bridge.EventsEnabled)"
|
||||||
|
})))
|
||||||
|
.0,
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A lease taken, a tally answered: an ordinary success carries straight through.
|
||||||
|
#[test]
|
||||||
|
fn event_successes_are_200s() {
|
||||||
|
assert_eq!(respond_event(reply("lease.ok")).0, StatusCode::OK);
|
||||||
|
assert_eq!(respond_event(reply("lease.list.ok")).0, StatusCode::OK);
|
||||||
|
assert_eq!(respond_event(reply("participation.ok")).0, StatusCode::OK);
|
||||||
|
assert_eq!(
|
||||||
|
respond_event(reply("participation.snapshot.ok")).0,
|
||||||
|
StatusCode::OK
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 425 must not collide with the protocol-version gate's 409: a mismatch is a deployment fault
|
||||||
|
/// nobody should retry, a busy shard is a retry that will succeed. Same-status would make the
|
||||||
|
/// two readable only by inspecting the body.
|
||||||
|
#[test]
|
||||||
|
fn busy_is_not_the_version_gates_status() {
|
||||||
|
assert_ne!(BUSY_STATUS, StatusCode::CONFLICT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A replayed reply is an ordinary success. The shard marks it `replayed: true` for the log, and
|
||||||
|
/// the caller must be able to treat it exactly as it would have treated the answer it lost.
|
||||||
|
#[test]
|
||||||
|
fn a_replayed_reply_is_still_a_200() {
|
||||||
|
let value = json!({"t": 1, "kind": "admin.ok", "reqId": "r-9", "replayed": true});
|
||||||
|
let (status, body) = respond_admin(Ok(value));
|
||||||
|
assert_eq!(status, StatusCode::OK);
|
||||||
|
assert_eq!(body.0.get("replayed").and_then(|v| v.as_bool()), Some(true));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The error mapping the busy arm is threaded in front of must be untouched by it.
|
||||||
|
#[test]
|
||||||
|
fn errors_still_map_as_before() {
|
||||||
|
assert_eq!(
|
||||||
|
respond(Ok(
|
||||||
|
json!({"kind": "bridge.error", "reason": "unknown account"})
|
||||||
|
))
|
||||||
|
.0,
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_admin(Ok(json!({"kind": "admin.error", "reason": "protected"}))).0,
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
respond_account(Ok(
|
||||||
|
json!({"kind": "account.error", "reason": "already exists"})
|
||||||
|
))
|
||||||
|
.0,
|
||||||
|
StatusCode::CONFLICT
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user