onelobby 0.6.0 → 0.7.0

package/dist/onelobby.d.ts

@@ -8,7 +8,7 @@ import { type RelayConnect } from "./nostr/relays.js";
 import { type Blueprint } from "./blueprint.js";
 import { type BrowserHostOptions } from "./direct/browser-host.js";
 export declare const LIB_NAME = "onelobby";
-export declare const LIB_VERSION = "0.6.0";
+export declare const LIB_VERSION = "0.7.0";
 /** Where `rememberSeat` keeps the resume token: the subset of the Web Storage API it uses. */
 export interface SeatStorage {
     getItem(key: string): string | null;

package/dist/onelobby.global.js

@@ -1,4 +1,4 @@
-/*! onelobby 0.6.0 | MIT license */
+/*! onelobby 0.7.0 | MIT license */
 "use strict";
 var OneLobby = (() => {
   var __defProp = Object.defineProperty;
@@ -29,8 +29,6 @@ var OneLobby = (() => {
     DEFAULT_NOSTR_STUN: () => DEFAULT_NOSTR_STUN,
     DEFAULT_READY_TIMEOUT_MS: () => DEFAULT_READY_TIMEOUT_MS,
     ErrorCodes: () => ErrorCodes,
-    Keepalive: () => Keepalive,
-    KeepaliveError: () => KeepaliveError,
     LIB_NAME: () => LIB_NAME,
     LIB_VERSION: () => LIB_VERSION,
     LOBBY_TAG: () => LOBBY_TAG,
@@ -2185,14 +2183,9 @@ var OneLobby = (() => {
     get connectedPeers() {
       return this.connectedPeerIds();
     }
-    /**
-     * Joiner: the link to the host as a WebSocket-shaped object (text by default), so WebSocket client code runs
-     * unchanged. It opens when `ready` resolves and closes when the session ends (`host_left` gives code 1001).
-     */
     asWebSocket(opts) {
       return joinerSocket(this, opts);
     }
-    /** Host: `handler(conn)` once per joiner (a WebSocket-shaped connection), the server-side mirror of asWebSocket(). */
     onConnection(handler, opts) {
       return hostConnections(this, handler, opts);
     }
@@ -2223,6 +2216,16 @@ var OneLobby = (() => {
       this.setPhase("in_game");
       if (this.mode === "lockstep") this.lockstep.hostStart();
     }
+    /**
+     * Changes your display name mid-session. The hub sanitises it (as at hello, at most 24 characters) and every member,
+     * you included, gets `peerRenamed`. Names need not be unique. At most one rename per second; a refusal
+     * (`bad_request` for an empty name, `rate_limited`) arrives on the kit's `error` event. Throws `unsupported` when
+     * the hub is too old to rename.
+     */
+    async rename(name) {
+      if (!(this.cfg.features ?? []).includes("set_name")) throw new OneLobbyError("unsupported", "this lobby's hub cannot rename players (update it)");
+      this.signaling.send({ t: "set_name", name: String(name ?? "") });
+    }
     async setMeta(meta) {
       if (!this.isHost) throw new Error("only the host can set metadata");
       this.meta = { ...meta };
@@ -2354,7 +2357,9 @@ var OneLobby = (() => {
       }, budget);
     }
     giveUpConnecting() {
-      const err = new OneLobbyError("ice_failed", `could not open a connection to the host${this.relayRetry ? " (direct or relayed)" : ""}`);
+      const hostLink = this.links.get(this.hostPeerId);
+      const diagnostics = hostLink ? hostLink.diagnostics?.() : this.lastHostLinkEnd ?? "no offer from the host ever arrived";
+      const err = new OneLobbyError("ice_failed", `could not open a connection to the host${this.relayRetry ? " (direct or relayed)" : ""}`, diagnostics ? { diagnostics } : void 0);
       this.failReady(err);
       this.reportError(err);
       if (this.ended) return;
@@ -2403,8 +2408,11 @@ var OneLobby = (() => {
       this.emit("peerReady", this.roster.get(link.remoteId) ?? { peerId: link.remoteId, name: "" });
       this.flush(link.remoteId);
     }
+    /** Why and how the joiner's last link to the host ended (shown when the join gives up). */
+    lastHostLinkEnd = null;
     onLinkClosed(peerId, link, _reason) {
       if (this.links.get(peerId) !== link) return;
+      if (!this.isHost && peerId === this.hostPeerId) this.lastHostLinkEnd = `link ended (${_reason}): ${link.diagnostics?.() ?? ""}`;
       this.links.delete(peerId);
       this.hiSentTo.delete(link);
       if (this.ended) return;
@@ -2671,7 +2679,12 @@ var OneLobby = (() => {
             this.resumeToken = st.resumeToken;
             this.seatSink?.(this.resumeToken);
           }
+          const before = this.roster;
           this.roster = new Map(st.peers.map((p) => [p.peerId, seatName(p)]));
+          for (const [id, p] of this.roster) {
+            const old = before.get(id);
+            if (old && old.name !== p.name) this.emit("peerRenamed", p, old.name);
+          }
           if (st.hostId !== this.hostPeerId && !this.isHost) this.setHost(st.hostId);
           this.setPhase(st.phase);
           break;
@@ -3067,6 +3080,8 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
     opened = 0;
     early = [];
     extra;
+    born = Date.now();
+    trace = [];
     /** `rtc`: the RTCPeerConnection class to use (default the global one; in Node, node-datachannel's polyfill). */
     constructor(opts, rtc = globalThis.RTCPeerConnection) {
       this.remoteId = opts.remoteId;
@@ -3082,16 +3097,28 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
       }
       this.pc = new rtc(config);
       this.pc.onicecandidate = (e) => {
-        if (e.candidate) this.onSignal?.({ ice: e.candidate.toJSON() });
+        if (e.candidate) {
+          this.note(`out ice ${e.candidate.candidate}`);
+          this.onSignal?.({ ice: e.candidate.toJSON() });
+        }
       };
       this.pc.onconnectionstatechange = () => {
         const s = this.pc.connectionState;
+        this.note(`connection ${s}`);
         if (s === "failed" || s === "closed" || s === "disconnected") {
           if (s === "disconnected") setTimeout(() => this.pc.connectionState === "disconnected" && this.fail("disconnected"), 4e3);
           else this.fail(s);
         }
       };
     }
+    note(what) {
+      if (this.trace.length < 40) this.trace.push(`+${Date.now() - this.born}ms ${what}`);
+    }
+    /** What a "could not connect" report adds: the peer connection's states and the signals seen so far. */
+    diagnostics() {
+      const pc = this.pc;
+      return `connection=${pc.connectionState} ice=${pc.iceConnectionState} gathering=${pc.iceGatheringState} signaling=${pc.signalingState} haveRemote=${this.haveRemote} pendingIce=${this.pendingIce.length}; ${this.trace.join("; ")}`;
+    }
     /**
      * The offerer creates the channels just before its offer, the answerer once the remote offer is set. Creating them
      * any earlier makes libdatachannel (node-datachannel) start an offer of its own on the answering side, which then
@@ -3110,7 +3137,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
             void this.reportPath();
           }
         };
-        ch.onclose = () => this.fail(`channel ${name} closed`);
+        if (name === "reliable") ch.onclose = () => this.fail(`channel ${name} closed`);
         ch.onmessage = (e) => {
           const d = e.data;
           const data = d instanceof ArrayBuffer ? new Uint8Array(d) : ArrayBuffer.isView(d) ? new Uint8Array(d.buffer, d.byteOffset, d.byteLength) : new Uint8Array(d);
@@ -3129,6 +3156,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
           this.openChannels();
           const offer = await this.pc.createOffer();
           await this.pc.setLocalDescription(offer);
+          this.note("out offer");
           this.onSignal?.({ sdp: { type: "offer", sdp: offer.sdp ?? "" } });
         } catch (e) {
           this.fail(`offer failed: ${String(e)}`);
@@ -3136,6 +3164,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
       })();
     }
     async handleSignal(s) {
+      this.note(`in ${s.sdp ? s.sdp.type : `ice ${s.ice?.candidate}`}`);
       try {
         if (s.sdp) {
           await this.pc.setRemoteDescription({ type: s.sdp.type, sdp: s.sdp.sdp });
@@ -3149,6 +3178,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
             this.openChannels();
             const answer = await this.pc.createAnswer();
             await this.pc.setLocalDescription(answer);
+            this.note("out answer");
             this.onSignal?.({ sdp: { type: "answer", sdp: answer.sdp ?? "" } });
           }
         }
@@ -3304,6 +3334,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
   var JOINER_FIRST_RELAY_MS = 1e4;
   var RELAY_REST_WAIT_MS = 1500;
   var RELAY_REST_POLL_MS = 50;
+  var DEAD_RELAY_DIALS = 4;
 
   // src/nostr/link.ts
   var utf8 = new TextEncoder();
@@ -3672,7 +3703,7 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
   var RelayPool = class {
     constructor(o) {
       this.o = o;
-      this.relays = o.urls.map((url) => ({ url, ws: null, open: false, attempted: false, skipped: false, backoff: 1e3, cancelRetry: null }));
+      this.relays = o.urls.map((url) => ({ url, ws: null, open: false, attempted: false, skipped: false, everOpen: false, fails: 0, backoff: 1e3, cancelRetry: null }));
     }
     o;
     relays;
@@ -3749,6 +3780,8 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
         if (r.ws !== ws) return;
         r.open = true;
         r.attempted = true;
+        r.everOpen = true;
+        r.fails = 0;
         r.backoff = 1e3;
         const since = Math.floor(this.o.wall() / 1e3) - SINCE_SLACK_S;
         this.trySend(r, JSON.stringify(["REQ", this.sub, { kinds: [NOSTR_KIND], "#t": [this.o.topic], since }]));
@@ -3783,6 +3816,11 @@ registerProcessor('onelobby-capture', OneLobbyCapture);
     }
     retryLater(r) {
       if (this.closed || r.skipped || r.cancelRetry) return;
+      if (!r.everOpen) r.fails++;
+      if (!r.everOpen && r.fails >= DEAD_RELAY_DIALS && this.connected > 0) {
+        this.skip(r);
+        return;
+      }
       const wait = r.backoff;
       r.backoff = Math.min(3e4, r.backoff * 2);
       r.cancelRetry = this.o.clock.setTimeout(() => {
@@ -4871,6 +4909,7 @@ ${name} ${g.read()}
     detachedAt = 0;
     token = "";
     ip = "";
+    renames = null;
   };
   var HubLobby = class {
     code = "";
@@ -4900,7 +4939,7 @@ ${name} ${g.read()}
       return this.members.find((m) => m.peerId === peerId);
     }
   };
-  var KNOWN_TYPES = /* @__PURE__ */ new Set(["hello", "create", "join", "list", "leave", "signal", "meta", "phase", "kick", "approve", "ping", "host_changed", "path"]);
+  var KNOWN_TYPES = /* @__PURE__ */ new Set(["hello", "create", "join", "list", "leave", "signal", "meta", "phase", "kick", "approve", "ping", "host_changed", "path", "set_name"]);
   var str2 = (o, k) => typeof o[k] === "string" ? o[k] : null;
   var int2 = (o, k) => {
     const v = o[k];
@@ -5102,6 +5141,8 @@ ${name} ${g.read()}
           return this.claimHost(s, msg);
         case "path":
           return this.pathReport(s, msg);
+        case "set_name":
+          return this.setName(s, msg);
         default:
           return;
       }
@@ -5148,7 +5189,8 @@ ${name} ${g.read()}
         t: "welcome",
         ice: this.iceList(s),
         serverTime: this.now(),
-        limits: { maxMsg: this.o.maxMessageBytes, maxPlayers: this.o.hardMaxPlayers }
+        limits: { maxMsg: this.o.maxMessageBytes, maxPlayers: this.o.hardMaxPlayers },
+        features: ["set_name"]
       };
       if (resumed) w.peerId = resumed.peerId;
       this.send(s, w);
@@ -5413,6 +5455,18 @@ ${name} ${g.read()}
       lobby.meta = meta.meta;
       this.broadcastLobby(lobby);
     }
+    setName(s, m) {
+      if (!s.lobby || !s.member) return this.error(s, "bad_request", "not in a lobby");
+      const name = typeof m.name === "string" ? sanitize(m.name, NAME_MAX) : "";
+      if (!name) return this.error(s, "bad_request", "name must be a non-empty string", field("name"));
+      if (name === s.member.name) return;
+      const now = this.now();
+      const rate = s.member.renames ??= new RateWindow(this.scale, 1e3);
+      if (!rate.tryHit(now)) return this.rateLimited(s, "set_name", rate.retryAfterMs(now), null);
+      s.member.name = name;
+      s.name = name;
+      this.broadcastLobby(s.lobby);
+    }
     hostPhase(s, m) {
       const lobby = this.requireHost(s);
       if (!lobby) return;
@@ -5742,7 +5796,7 @@ ${name} ${g.read()}
 
   // src/onelobby.ts
   var LIB_NAME = "onelobby";
-  var LIB_VERSION = "0.6.0";
+  var LIB_VERSION = "0.7.0";
   var DEFAULT_READY_TIMEOUT_MS = 15e3;
   function hasMic() {
     return typeof navigator !== "undefined" && !!navigator.mediaDevices?.getUserMedia && typeof AudioWorkletNode !== "undefined";
@@ -5952,6 +6006,7 @@ ${name} ${g.read()}
         signaling: sig,
         state,
         ice: welcome.ice ?? [],
+        features: welcome.features ?? [],
         links: direct?.links ?? this.linkFactory,
         direct: !!direct,
         clock: this.clock,
@@ -6180,6 +6235,13 @@ ${name} ${g.read()}
     return out;
   }
   function guardLobby(lobby, bp) {
+    const rename = lobby.rename.bind(lobby);
+    lobby.rename = async (name) => {
+      if (bp.players.identity === "anonymous") throw new OneLobbyError("identity_anonymous", "this game uses anonymous players: no display names");
+      if (String(name ?? "").trim().length > bp.players.maxNameLength)
+        throw new BlueprintError("displayName", "length", `must be at most ${bp.players.maxNameLength} characters`);
+      return rename(name);
+    };
     lobby.voice.mode = bp.chat.voiceMode;
     if (!bp.chat.voice) {
       const voice = lobby.voice;
@@ -6225,6 +6287,7 @@ ${name} ${g.read()}
     DirectUnreachable: "direct_unreachable",
     BadAddress: "bad_address",
     PortInUse: "port_in_use",
+    Unsupported: "unsupported",
     ConnectFailed: "connect_failed",
     Closed: "closed",
     ServerLost: "server_lost",
@@ -6265,6 +6328,7 @@ ${name} ${g.read()}
     ice_failed: { message: "Couldn't connect to the other players.", hint: "Some networks (school, work, public Wi-Fi) block game connections. Try another network or a phone hotspot." },
     no_server: { message: "This game has no lobby server address yet.", hint: "Enter one in the multiplayer settings, or host from your own computer with a join code." },
     timeout: { message: "The connection took too long.", hint: "Check your internet connection, then try again." },
+    unsupported: { message: "The host's game is too old for that.", hint: "Ask the host to update the game." },
     voice_disabled: { message: "Voice chat is turned off in this game." },
     chat_disabled: { message: "Text chat is turned off in this game." },
     pause_disabled: { message: "Pausing is turned off in this game." },
@@ -6353,10 +6417,6 @@ ${name} ${g.read()}
     return v ? normalizeCode(v) : null;
   }
 
-  // src/deprecated.ts
-  var Keepalive = OneLobby;
-  var KeepaliveError = OneLobbyError;
-
   // src/ui/controller.ts
   var enc4 = new TextEncoder();
   var dec3 = new TextDecoder();