Rename replay → initChannelState
All checks were successful
check / check (push) Successful in 2m20s

Rename the query parameter, function, and all related comments
from 'replay' to 'initChannelState' to better reflect the
semantics: the server initializes channel state for the
reconnecting client rather than replaying past events.
This commit is contained in:
2026-03-09 17:00:52 -07:00
committed by user
parent 096fb2b207
commit 78d657111b
5 changed files with 23 additions and 21 deletions

View File

@@ -1036,7 +1036,7 @@ Return the current user's session state.
| Parameter | Type | Default | Description | | Parameter | Type | Default | Description |
|-----------|--------|---------|-------------| |-----------|--------|---------|-------------|
| `replay` | string | (none) | When set to `1`, enqueues synthetic JOIN + TOPIC + NAMES messages for every channel the session belongs to into the calling client's queue. Used by the SPA on reconnect to restore channel tabs without re-sending JOIN commands. | | `initChannelState` | string | (none) | When set to `1`, enqueues synthetic JOIN + TOPIC + NAMES messages for every channel the session belongs to into the calling client's queue. Used by the SPA on reconnect to restore channel tabs without re-sending JOIN commands. |
**Response:** `200 OK` **Response:** `200 OK`
```json ```json
@@ -1070,9 +1070,9 @@ curl -s http://localhost:8080/api/v1/state \
-H "Authorization: Bearer $TOKEN" | jq . -H "Authorization: Bearer $TOKEN" | jq .
``` ```
**Reconnect with channel replay:** **Reconnect with channel state initialization:**
```bash ```bash
curl -s "http://localhost:8080/api/v1/state?replay=1" \ curl -s "http://localhost:8080/api/v1/state?initChannelState=1" \
-H "Authorization: Bearer $TOKEN" | jq . -H "Authorization: Bearer $TOKEN" | jq .
``` ```

View File

@@ -444,10 +444,11 @@ func (hdlr *Handlers) enqueueNumeric(
} }
// HandleState returns the current session's info and // HandleState returns the current session's info and
// channels. When called with ?replay=1, it also enqueues // channels. When called with ?initChannelState=1, it also
// synthetic JOIN + TOPIC + NAMES messages for every channel // enqueues synthetic JOIN + TOPIC + NAMES messages for
// the session belongs to so that a reconnecting client can // every channel the session belongs to so that a
// rebuild its channel tabs from the message stream. // reconnecting client can rebuild its channel tabs from
// the message stream.
func (hdlr *Handlers) HandleState() http.HandlerFunc { func (hdlr *Handlers) HandleState() http.HandlerFunc {
return func( return func(
writer http.ResponseWriter, writer http.ResponseWriter,
@@ -475,8 +476,8 @@ func (hdlr *Handlers) HandleState() http.HandlerFunc {
return return
} }
if request.URL.Query().Get("replay") == "1" { if request.URL.Query().Get("initChannelState") == "1" {
hdlr.replayChannelState( hdlr.initChannelState(
request, clientID, sessionID, nick, request, clientID, sessionID, nick,
) )
} }
@@ -489,12 +490,12 @@ func (hdlr *Handlers) HandleState() http.HandlerFunc {
} }
} }
// replayChannelState enqueues synthetic JOIN messages and // initChannelState enqueues synthetic JOIN messages and
// join-numerics (TOPIC, NAMES) for every channel the // join-numerics (TOPIC, NAMES) for every channel the
// session belongs to. Messages are enqueued only to the // session belongs to. Messages are enqueued only to the
// specified client so other clients/sessions are not // specified client so other clients/sessions are not
// affected. // affected.
func (hdlr *Handlers) replayChannelState( func (hdlr *Handlers) initChannelState(
request *http.Request, request *http.Request,
clientID, sessionID int64, clientID, sessionID int64,
nick string, nick string,
@@ -516,7 +517,7 @@ func (hdlr *Handlers) replayChannelState(
) )
if insErr != nil { if insErr != nil {
hdlr.log.Error( hdlr.log.Error(
"replay: insert JOIN", "initChannelState: insert JOIN",
"error", insErr, "error", insErr,
) )

View File

@@ -182,9 +182,9 @@ func (hdlr *Handlers) handleLogin(
request, clientID, sessionID, payload.Nick, request, clientID, sessionID, payload.Nick,
) )
// Replay channel state so the new client knows which // Initialize channel state so the new client knows
// channels the session already belongs to. // which channels the session already belongs to.
hdlr.replayChannelState( hdlr.initChannelState(
request, clientID, sessionID, payload.Nick, request, clientID, sessionID, payload.Nick,
) )

2
web/dist/app.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -70,7 +70,7 @@ function LoginScreen({ onLogin }) {
.catch(() => {}); .catch(() => {});
const saved = localStorage.getItem("neoirc_token"); const saved = localStorage.getItem("neoirc_token");
if (saved) { if (saved) {
api("/state?replay=1") api("/state?initChannelState=1")
.then((u) => onLogin(u.nick, true)) .then((u) => onLogin(u.nick, true))
.catch(() => localStorage.removeItem("neoirc_token")); .catch(() => localStorage.removeItem("neoirc_token"));
} }
@@ -335,7 +335,7 @@ function App() {
if (msg.to) addMessage(msg.to, { ...base, text, system: true }); if (msg.to) addMessage(msg.to, { ...base, text, system: true });
if (msg.to && msg.to.startsWith("#")) { if (msg.to && msg.to.startsWith("#")) {
// Create a tab when the current user joins a channel // Create a tab when the current user joins a channel
// (including replayed JOINs on reconnect). // (including JOINs from initChannelState on reconnect).
if (msg.from === nickRef.current) { if (msg.from === nickRef.current) {
setTabs((prev) => { setTabs((prev) => {
if ( if (
@@ -656,9 +656,10 @@ function App() {
if (isResumed) { if (isResumed) {
// Request MOTD on resumed sessions (new sessions // Request MOTD on resumed sessions (new sessions
// get it automatically from the server during // get it automatically from the server during
// creation). Channel state is replayed by the // creation). Channel state is initialized by the
// server via the message queue (?replay=1), so we // server via the message queue
// do not need to re-JOIN channels here. // (?initChannelState=1), so we do not need to
// re-JOIN channels here.
try { try {
await api("/messages", { await api("/messages", {
method: "POST", method: "POST",