net: auto-reload on server version mismatch and announce connected version on welcome
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
// Maintainer-controlled web client version.
|
||||
// Format: YYYY.MM.DD Rn (example: 2026.02.20 R2)
|
||||
window.CHGRID_WEB_VERSION = "2026.02.22 R164";
|
||||
window.CHGRID_WEB_VERSION = "2026.02.22 R165";
|
||||
// Optional display timezone for timestamps. Falls back to America/Detroit if unset/invalid.
|
||||
window.CHGRID_TIME_ZONE = "America/Detroit";
|
||||
|
||||
@@ -201,6 +201,7 @@ let heartbeatNextPingId = -1;
|
||||
let heartbeatAwaitingPong = false;
|
||||
let reconnectInFlight = false;
|
||||
let activeServerInstanceId: string | null = null;
|
||||
let reloadScheduledForVersionMismatch = false;
|
||||
let audioLayers: AudioLayerState = {
|
||||
voice: true,
|
||||
item: true,
|
||||
@@ -508,6 +509,9 @@ function toggleAudioLayer(layer: keyof AudioLayerState): void {
|
||||
|
||||
/** Routes signaling transport status messages through chat buffer + status output. */
|
||||
function handleSignalingStatus(message: string): void {
|
||||
if (message === 'Connected.') {
|
||||
return;
|
||||
}
|
||||
pushChatMessage(message);
|
||||
}
|
||||
|
||||
@@ -1221,16 +1225,35 @@ async function onSignalingMessage(message: IncomingMessage): Promise<void> {
|
||||
return;
|
||||
}
|
||||
let restartAnnouncement: string | null = null;
|
||||
let connectedAnnouncement: string | null = null;
|
||||
if (message.type === 'welcome') {
|
||||
const incomingInstanceId = String(message.serverInfo?.instanceId ?? '').trim() || null;
|
||||
const incomingVersion = String(message.serverInfo?.version ?? '').trim() || 'unknown';
|
||||
connectedAnnouncement = `Connected. Version ${incomingVersion}.`;
|
||||
if (
|
||||
!reloadScheduledForVersionMismatch &&
|
||||
APP_VERSION &&
|
||||
incomingVersion &&
|
||||
incomingVersion !== 'unknown' &&
|
||||
incomingVersion !== APP_VERSION
|
||||
) {
|
||||
reloadScheduledForVersionMismatch = true;
|
||||
pushChatMessage(`Server version ${incomingVersion} detected. Reloading client...`);
|
||||
window.setTimeout(() => {
|
||||
window.location.reload();
|
||||
}, 50);
|
||||
return;
|
||||
}
|
||||
if (activeServerInstanceId && incomingInstanceId && activeServerInstanceId !== incomingInstanceId) {
|
||||
restartAnnouncement = `Server restarted, version ${incomingVersion}.`;
|
||||
restartAnnouncement = 'Server restarted.';
|
||||
}
|
||||
activeServerInstanceId = incomingInstanceId;
|
||||
startHeartbeat();
|
||||
}
|
||||
await onAppMessage(message);
|
||||
if (connectedAnnouncement) {
|
||||
pushChatMessage(connectedAnnouncement);
|
||||
}
|
||||
if (restartAnnouncement) {
|
||||
pushChatMessage(restartAnnouncement);
|
||||
audio.sfxUiConfirm();
|
||||
|
||||
@@ -62,5 +62,6 @@ This is a behavior guide for packet semantics beyond raw schemas.
|
||||
- Client sends automatic heartbeat `ping` packets every 10 seconds while connected.
|
||||
- Heartbeat pings use negative `clientSentAt` ids and are internal (not user-visible ping status).
|
||||
- If a heartbeat `pong` is missed for one interval (10 seconds), client force-disconnects and reconnects.
|
||||
- After reconnect, if `welcome.serverInfo.instanceId` changed, client announces:
|
||||
`Server restarted, version <version>.`
|
||||
- After reconnect, if `welcome.serverInfo.instanceId` changed, client announces `Server restarted.`
|
||||
- Client emits `Connected. Version <version>.` after each `welcome`.
|
||||
- If `welcome.serverInfo.version` differs from running client version, client auto-reloads.
|
||||
|
||||
@@ -9,6 +9,7 @@
|
||||
5. Client:
|
||||
- applies `welcome.worldConfig.gridSize` for authoritative grid bounds/rendering
|
||||
- records `welcome.serverInfo` (`instanceId`, `version`) for restart detection
|
||||
- if `welcome.serverInfo.version` differs from running client version, auto-reloads the page
|
||||
- applies `welcome.uiDefinitions` for item menus/properties/options
|
||||
- sends initial `update_position`
|
||||
- sends initial `update_nickname`
|
||||
@@ -48,7 +49,8 @@ Core incoming message effects:
|
||||
|
||||
- While running, client sends heartbeat `ping` every 10 seconds.
|
||||
- If one heartbeat `pong` is missed (10-second interval), client auto-reconnects.
|
||||
- If reconnect lands on a different `welcome.serverInfo.instanceId`, client announces server restart/version.
|
||||
- If reconnect lands on a different `welcome.serverInfo.instanceId`, client announces server restart.
|
||||
- Connect/reconnect status message is emitted from `welcome` and includes server version.
|
||||
|
||||
## Disconnect/Cleanup
|
||||
|
||||
|
||||
Reference in New Issue
Block a user