@rithien/discord_bridge 0.3.3 → 0.3.5

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v0.3.5 - rithien fork
+
+- **Fixed lost JOIN/LEAVE (and other actions) after a transient controller disconnect.** `onControllerConnectionEvent` flushed the offline `messageQueue` only on `connect`, but clusterio emits `resume` after a brief link drop (`connect` only happens on a new session, e.g. controller restart). Actions buffered during the drop window stayed stuck in the queue until the next full `connect` — symptom: missing `joined`/`left` messages on Discord, especially after chat inactivity (an idle host↔controller link drops unnoticed and resumes). Now flushes on `connect` **or** `resume` (same fix already shipped in comfy_adapter as FIX31 #2). This was the discord-bridge analog of #2 that was never ported.
+- **Added Discord gateway lifecycle handlers** (`error`, `shardError`, `shardDisconnect`, `shardReconnecting`, `shardResume`, `invalidated`). Previously none were attached, so client/shard errors were swallowed (no log trace) and an `invalidated` session left the bot dead until a controller restart. `invalidated` now re-logs in via `connect()` (guarded against a reconnect loop); the rest add observability for diagnosing gateway drops. (discord.js v14 already auto-reconnects shards and `channel.send` goes over REST, so this is mainly recovery + visibility, not the primary fix.)
+- **Wrapped `channel.send` in `handleInstanceAction` in try/catch** — a transient REST/permission/rate-limit error no longer silently drops the action or throws an unhandled rejection out of the event handler (consistent with the existing `.catch` in `onHostConnectionEvent`/`onInstanceStatusChanged`). Losses are now logged.
+
+## v0.3.4 - rithien fork
+
+- `discordMessage` no longer assumes `message.member` is present (it can be `null` in discord.js v14 — author left the guild, partial/cache miss, gateway didn't deliver the member); falls back to the always-present `message.author`, so Discord→Factorio chat is no longer silently dropped with a `TypeError` (FIX31 #31).
+- `fetchChannels` handles channel errors per-channel (log + continue) instead of re-throwing any `code !== 10003`; a single inaccessible channel (Missing Access/Permissions, network) no longer aborts plugin `init()` and leaves the bridge half-built (FIX31 #32).
+- Added `allowedMentions: { parse: [] }` to instance status (`onInstanceStatusChanged`) and host connection (`onHostConnectionEvent`) notifications — previously only player-action messages set it. An instance/host name containing `@everyone`/`@here`/a role mention no longer triggers a real ping (FIX31 #33).
+- Bounded the offline `messageQueue` (cap 1000, FIFO drop-oldest with a one-time warn) so a long controller disconnect during active play cannot grow it without limit nor flood Discord with the whole backlog on reconnect (FIX31 #30).
+
+## v0.3.3 - rithien fork
+
+- Added `allowedMentions: { parse: [] }` to player-action `channel.send` calls so chat relayed from Factorio containing `@everyone`/`@here`/role mentions does not actually ping on Discord (security fix K3).
+
 ## v0.3.2 - rithien fork
 
 - Switched `handleDiscordChatEvent` from `/sc game.print('${text}')` to `/fp ${text}` (custom command exposed by the `factorio-polska` scenario in `commands/fp.lua`). Avoids the persistent "Cheats have been enabled" flag set by `/silent-command`, which permanently disables achievements on the save. Pair with `@rithien/factorio-polska` scenario v0.1.0+ (defines `/fp`). Without that scenario, the chat bridge will fail silently (RCON returns "Unknown command: fp"). To keep working on a vanilla scenario, pin to v0.3.1.

package/controller.js

@@ -12,6 +12,7 @@ class ControllerPlugin extends BaseControllerPlugin {
 		this.channelByInstance = new Map();
 		this.instancesByChannel = new Map();
 		this.fallbackChannel = null;
+		this.reconnecting = false; // guard przed pętlą reloginu po evencie "invalidated"
 
 		this.controller.handle(InstanceActionEvent, this.handleInstanceAction.bind(this));
 		await this.connect();
@@ -44,6 +45,39 @@ class ControllerPlugin extends BaseControllerPlugin {
 			this.discordMessage(message).catch(err => { this.logger.error(`Unexpected error:\n${err.stack}`); });
 		});
 
+		// Handlery cyklu życia gatewaya. Wcześniej żaden nie był podpięty — błędy klienta/shardu
+		// były połykane (brak śladu w logach), a "invalidated" zostawiał bota martwego do restartu
+		// kontrolera. discord.js v14 sam rekonektuje shardy (channel.send i tak idzie przez REST,
+		// odporny na blipy gatewaya) — te handlery służą głównie OBSERWOWALNOŚCI + recovery z invalidated.
+		this.client.on("error", (err) => {
+			this.logger.error(`Discord client error:\n${err?.stack ?? err}`);
+		});
+		this.client.on("shardError", (err) => {
+			this.logger.error(`Discord shard websocket error:\n${err?.stack ?? err}`);
+		});
+		this.client.on("shardDisconnect", (event, shardId) => {
+			this.logger.warn(`Discord shard ${shardId} disconnected (code ${event?.code}) — discord.js spróbuje reconnect`);
+		});
+		this.client.on("shardReconnecting", (shardId) => {
+			this.logger.info(`Discord shard ${shardId} reconnecting`);
+		});
+		this.client.on("shardResume", (shardId) => {
+			this.logger.info(`Discord shard ${shardId} resumed`);
+		});
+		this.client.on("invalidated", () => {
+			// Sesja nieodwracalnie unieważniona — discord.js zatrzymuje klienta i NIE wznawia sam.
+			// Bez reloginu bot zostaje martwy do restartu kontrolera. connect() robi destroy + nowy
+			// login; flaga reconnecting blokuje pętlę gdyby invalidated przyszło wielokrotnie.
+			this.logger.error("Discord session invalidated — ponowne logowanie");
+			if (this.reconnecting) {
+				return;
+			}
+			this.reconnecting = true;
+			this.connect()
+				.catch(err => { this.logger.error(`Relogin po invalidated nie powiódł się:\n${err?.stack ?? err}`); })
+				.finally(() => { this.reconnecting = false; });
+		});
+
 		this.logger.info("Logging in to Discord");
 		try {
 			await this.client.login(token);
@@ -98,10 +132,15 @@ class ControllerPlugin extends BaseControllerPlugin {
 					this.logger.error(`Channel ID ${id} was not found`);
 				}
 			} catch (err) {
-				if (err.code !== 10003) { // Unknown channel
-					throw err;
+				// FIX31 #32: odporność per-kanał. Re-throw wywracał fetchChannels() poza connect()/init()
+				// (fetchChannels jest wołane poza try/catch logowania), zostawiając most w stanie
+				// częściowo zbudowanym. Błędy inne niż 10003 to m.in. 50001 (Missing Access),
+				// 50013 (Missing Permissions) i sieciowe — logujemy i kontynuujemy pętlę.
+				if (err.code === 10003) { // Unknown channel
+					this.logger.error(`Channel ID ${id} was not found`);
+				} else {
+					this.logger.error(`Failed to fetch channel ID ${id}, skipping:\n${err.stack}`);
 				}
-				this.logger.error(`Channel ID ${id} was not found`);
 			}
 		}
 
@@ -157,10 +196,15 @@ class ControllerPlugin extends BaseControllerPlugin {
 			return;
 		}
 
+		// FIX31 #31: message.member bywa null (autor nie jest już członkiem gildii, partial/cache
+		// miss, gateway nie dostarczył member) — sięgamy po zawsze obecny message.author.
+		const displayName = message.member?.displayName ?? message.author.displayName ?? message.author.username;
+		const tag = message.author.tag ?? message.author.username;
+
 		const template = this.controller.config.get("discord_bridge.discord_template");
 		const content = template.replace(/(__display_name__|__username__|__content__)/g, (sub) => ({
-			"__display_name__": message.member.displayName,
-			"__username__": message.member.user.tag,
+			"__display_name__": displayName,
+			"__username__": tag,
 			"__content__": message.cleanContent,
 		}[sub]));
 
@@ -204,7 +248,12 @@ class ControllerPlugin extends BaseControllerPlugin {
 			return;
 		}
 
-		await channel.send(this.formatMessage(template, hostName, instanceName, ""));
+		// allowedMentions: nazwa instancji/hosta trafia do szablonu — bez tego @everyone/@here w nazwie
+		// realnie pinguje (FIX31 #33, spójnie z akcjami graczy).
+		await channel.send({
+			content: this.formatMessage(template, hostName, instanceName, ""),
+			allowedMentions: { parse: [] },
+		});
 	}
 
 	onHostConnectionEvent(hostConnection, event) {
@@ -218,7 +267,8 @@ class ControllerPlugin extends BaseControllerPlugin {
 			return;
 		}
 		const message = this.formatMessage(template, hostName, "", "");
-		this.fallbackChannel.send(message).catch(
+		// allowedMentions: nazwa hosta trafia do szablonu — blokujemy ping z @everyone/@here (FIX31 #33).
+		this.fallbackChannel.send({ content: message, allowedMentions: { parse: [] } }).catch(
 			err => { this.logger.error(`Unexpected error:\n${err.stack}`); }
 		);
 	}
@@ -261,7 +311,14 @@ class ControllerPlugin extends BaseControllerPlugin {
 		}
 		const hostName = this.getHostName(instance.config.get("instance.assigned_host"));
 		const message = this.formatMessage(template, hostName, instanceName, content);
-		await channel.send({ content: message, allowedMentions: { parse: [] } });
+		// try/catch: przejściowy błąd REST/permission/rate-limit nie może cicho zgubić akcji ani
+		// rzucić unhandled rejection z handlera eventu (spójnie z .catch w onHostConnectionEvent /
+		// onInstanceStatusChanged). Strata jest teraz widoczna w logach.
+		try {
+			await channel.send({ content: message, allowedMentions: { parse: [] } });
+		} catch (err) {
+			this.logger.error(`Failed to send ${action} to Discord:\n${err?.stack ?? err}`);
+		}
 	}
 }
 

package/dist/web/manifest.json

@@ -1,6 +1,6 @@
 {
   "main.js": "static/main.42d03a9854919d3e8189.js",
-  "discord_bridge.js": "static/discord_bridge.eb399a233189cc9de727.js",
+  "discord_bridge.js": "static/discord_bridge.19d9629215eba402e78a.js",
   "static/info_js.js": "static/info_js.131defcd9652f0e24d4a.js",
-  "static/package_json.js": "static/package_json.eb40f2bb2cb67c86f9d0.js"
+  "static/package_json.js": "static/package_json.84f9beada3e5dfdb2a77.js"
 }

package/dist/web/static/{discord_bridge.eb399a233189cc9de727.js → discord_bridge.19d9629215eba402e78a.js}

@@ -123,7 +123,7 @@ __webpack_require__.d(exports, {
 /******/ 		// This function allow to reference async chunks
 /******/ 		__webpack_require__.u = (chunkId) => {
 /******/ 			// return url for filenames based on template
-/******/ 			return "static/" + chunkId + "." + {"info_js":"131defcd9652f0e24d4a","package_json":"eb40f2bb2cb67c86f9d0"}[chunkId] + ".js";
+/******/ 			return "static/" + chunkId + "." + {"info_js":"131defcd9652f0e24d4a","package_json":"84f9beada3e5dfdb2a77"}[chunkId] + ".js";
 /******/ 		};
 /******/ 	})();
 /******/ 	

package/dist/web/static/{package_json.eb40f2bb2cb67c86f9d0.js → package_json.84f9beada3e5dfdb2a77.js}

@@ -15,7 +15,7 @@
   \**********************/
 (module) {
 
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@rithien/discord_bridge","version":"0.3.3","description":"Clusterio plugin bridging chat between instances and Discord, with per-instance channel routing","main":"info.js","scripts":{"test":"echo \\"Error: no test specified\\" && exit 1","prepare":"webpack-cli --env production"},"keywords":["clusterio","clusterio-plugin","factorio","discord"],"author":"rithien <jacek@zaluzje.bialystok.pl>","license":"MIT","peerDependencies":{"@clusterio/lib":"^2.0.0-alpha.14"},"devDependencies":{"@clusterio/lib":"^2.0.0-alpha.14","@clusterio/web_ui":"^2.0.0-alpha.14","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-merge":"^5.9.0"},"dependencies":{"discord.js":"^14.14.1"},"publishConfig":{"access":"public"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@rithien/discord_bridge","version":"0.3.5","description":"Clusterio plugin bridging chat between instances and Discord, with per-instance channel routing","main":"info.js","scripts":{"test":"echo \\"Error: no test specified\\" && exit 1","prepare":"webpack-cli --env production"},"keywords":["clusterio","clusterio-plugin","factorio","discord"],"author":"rithien <jacek@zaluzje.bialystok.pl>","license":"MIT","peerDependencies":{"@clusterio/lib":"^2.0.0-alpha.14"},"devDependencies":{"@clusterio/lib":"^2.0.0-alpha.14","@clusterio/web_ui":"^2.0.0-alpha.14","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-merge":"^5.9.0"},"dependencies":{"discord.js":"^14.14.1"},"publishConfig":{"access":"public"}}');
 
 /***/ }
 

package/instance.js

@@ -3,6 +3,11 @@ const { BaseInstancePlugin } = require("@clusterio/host");
 
 const { InstanceActionEvent, DiscordChatEvent } = require("./info.js");
 
+// Twardy limit bufora akcji na czas rozłączenia z kontrolerem (FIX31 #30). Przy długim rozłączeniu
+// i aktywnej rozgrywce (join/leave/chat) kolejka rosłaby bez ograniczeń (OOM hosta), a po reconnekcie
+// cała zaległość zalałaby kanał Discord naraz. FIFO: po przekroczeniu odrzucamy najstarsze.
+const MAX_MESSAGE_QUEUE = 1000;
+
 
 /**
  * Removes gps and train tags from messags
@@ -14,15 +19,22 @@ function removeTags(content) {
 class InstancePlugin extends BaseInstancePlugin {
 	async init() {
 		this.messageQueue = [];
+		this.queueOverflowWarned = false;
 		this.instance.handle(DiscordChatEvent, this.handleDiscordChatEvent.bind(this));
 	}
 
 	onControllerConnectionEvent(event) {
-		if (event === "connect") {
+		// clusterio emituje connect/drop/resume/close. Po krótkim lagu sieci leci "resume"
+		// (wznowienie sesji), NIE "connect" (ten tylko przy nowej sesji, np. restart kontrolera).
+		// Bez wariantu "resume" akcje z okna dropu (JOIN/LEAVE/CHAT) zostawały uwięzione w kolejce
+		// aż do następnego pełnego connect — objaw: gubione join/leave, zwłaszcza po bezczynności
+		// (ciche łącze pada niezauważone). Analog naprawionego FIX31 #2 w comfy_adapter.
+		if ((event === "connect" || event === "resume") && this.messageQueue.length > 0) {
 			for (let [action, content] of this.messageQueue) {
 				this.sendChat(action, content);
 			}
 			this.messageQueue = [];
+			this.queueOverflowWarned = false;
 		}
 	}
 
@@ -53,6 +65,13 @@ class InstancePlugin extends BaseInstancePlugin {
 			this.sendChat(output.action, output.message);
 		} else {
 			this.messageQueue.push([output.action, output.message]);
+			if (this.messageQueue.length > MAX_MESSAGE_QUEUE) {
+				this.messageQueue.shift(); // odrzuć najstarsze (FIX31 #30)
+				if (!this.queueOverflowWarned) {
+					this.logger.warn(`discord_bridge: messageQueue przekroczyła ${MAX_MESSAGE_QUEUE} akcji (kontroler rozłączony) — odrzucam najstarsze`);
+					this.queueOverflowWarned = true;
+				}
+			}
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rithien/discord_bridge",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Clusterio plugin bridging chat between instances and Discord, with per-instance channel routing",
   "main": "info.js",
   "scripts": {