1.0.6 RC8

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v1.0.6
+
+- Bidirectional
+
+## v1.0.5
+
+- Action and player count
+
 ## v1.0.3
 
 - Changed to TS

README.md

@@ -1,7 +1,7 @@
 Chat Relay
 ========================
 
-One way chat relay to Discord.
+Chat relay of Discord and Factorio, seperate channel
 
 Plugin of Clusterio
 https://github.com/clusterio/clusterio

controller.ts

@@ -1,12 +1,18 @@
 import type {ControllerPluginContext} from '@clusterio/controller';
-import {REST, Routes} from 'discord.js';
-import {ChatEvent} from './index.js';
+import {Client, GatewayIntentBits, REST, Routes} from 'discord.js';
+import type {Message} from 'discord.js';
+import {ChatEvent, ChatFromDiscordEvent} from './index.js';
 
-/* Controller-side half of the chat relay: Factorio chat -> Discord.
- * One-way only, so this talks to the REST API directly instead of opening a
- * gateway Client: no intents (and no privileged MessageContent verification),
- * no login/destroy lifecycle, no reconnect state machine.
-*/
+/* Controller-side halves of the chat relay.
+ * Outbound (Factorio -> Discord) talks to the REST API directly: no socket, no intents.
+ * Inbound (Discord -> Factorio) needs messageCreate, so it owns a real gateway Client.
+ * Both are built from the same token and rebuilt by the same enqueue chain, so a token
+ * rotation can't leave one half running on the old credential.
+ *
+ * Both directions read the single `discord_channel_mapping` field (instance name ->
+ * channel ID). The reverse lookup is built by inverting it, so the two directions can
+ * never disagree about which channel belongs to which instance.
+ */
 
 // Discord's hard limit is 2000; keep headroom for future decoration.
 const MAX_MESSAGE_LENGTH = 1950;
@@ -16,6 +22,10 @@ const MIN_WORD_BREAK_FILL = 0.5;
 
 const ERROR_UNKNOWN_CHANNEL = 10003;
 
+// Factorio chat scroll is a shared, scarce resource; be stricter than Discord is.
+const INBOUND_BUCKET_SIZE = 5;
+const INBOUND_REFILL_PER_SEC = 0.5;
+
 interface DiscordError {
     code?: number;
     status?: number;
@@ -32,7 +42,7 @@ function splitMessage(text: string, limit: number): string[] {
         return text.length === 0 ? [] : [text];
     }
 
-    // Array.from, not slice, so we never cut an emoji's surrogate pair in half.
+    // Array.from, not slice, so we never cut a surrogate pair in half.
     const chars = Array.from(text);
     const chunks: string[] = [];
     let offset = 0;
@@ -74,16 +84,30 @@ function splitMessage(text: string, limit: number): string[] {
     return chunks.filter(chunk => chunk.length > 0);
 }
 
+interface Bucket {
+    tokens: number;
+    updated: number;
+    warned: boolean;
+}
+
 export default async function(context: ControllerPluginContext) {
     const {controller, logger, plugin} = context;
 
     let rest: REST | null = null;
+    let client: Client | null = null;
     let shuttingDown = false;
 
     // Log-once guards. A channel that is unmapped or unusable gets hit once per chat
     // line, which is how a typo in the config turns into a 10k-line log file.
     const warnedNoMapping = new Set<string>();
     const warnedBadChannel = new Set<string>();
+    const warnedAmbiguous = new Set<string>();
+    const warnedNoInstance = new Set<string>();
+    const warnedSendFail = new Set<string>();
+
+    // Inverted view of discord_channel_mapping, rebuilt rather than mutated in place.
+    let channelToInstances = new Map<string, string[]>();
+    const buckets = new Map<string, Bucket>();
 
     // Serialise reconnects so two quick config changes can't interleave and have
     // the older attempt null out the newer client.
@@ -94,37 +118,22 @@ export default async function(context: ControllerPluginContext) {
         return run;
     };
 
-    const connect = async () => {
-        rest = null;
+    const getToken = () => controller.config.get('chat_relay.discord_bot_token') as string | undefined;
 
-        const token = controller.config.get('chat_relay.discord_bot_token') as string | undefined;
-        if (!token) {
-            logger.error('[Chat Relay] Discord bot token not configured.');
-            return;
-        }
-
-        const client = new REST({version: '10'}).setToken(token);
-
-        try {
-            // Fails fast at startup instead of silently on the first chat line.
-            const me = await client.get(Routes.user('@me')) as {id: string, username: string};
-            logger.info(`[Chat Relay] Authenticated with Discord as ${me.username} (${me.id}).`);
-        } catch (err) {
-            logger.error(`[Chat Relay] Discord token rejected:\n${stackOf(err)}`);
-            return;
-        }
-
-        rest = client;
-    };
+    // --------------------------------------------------------------- outbound
 
     const getChannelId = (instanceName: string): string | null => {
-        const mapping = controller.config.get('chat_relay.discord_channel_mapping') as Record<string, string> | undefined;
+        const mapping = controller.config.get('chat_relay.discord_channel_mapping') as
+            Record<string, string> | undefined;
         const channelId = mapping?.[instanceName];
 
         if (!channelId) {
             if (!warnedNoMapping.has(instanceName)) {
                 warnedNoMapping.add(instanceName);
-                logger.warn(`[Chat Relay] No Discord channel mapped for instance ${instanceName}; dropping its messages.`);
+                logger.warn(
+                    `[Chat Relay] No Discord channel mapped for instance ${instanceName};`
+                    + ' dropping its messages.',
+                );
             }
 
             return null;
@@ -137,7 +146,7 @@ export default async function(context: ControllerPluginContext) {
         if (shuttingDown) return;
 
         const discord = rest;
-        // Not configured, or the token was rejected. connect() already logged.
+        // Not configured, or the token was rejected. connect() already logged it.
         if (!discord) return;
 
         const channelId = getChannelId(instanceName);
@@ -178,6 +187,228 @@ export default async function(context: ControllerPluginContext) {
         }
     };
 
+    // ---------------------------------------------------------------- inbound
+
+    const rebuildInboundMap = () => {
+        const mapping = controller.config.get('chat_relay.discord_channel_mapping') as
+            Record<string, string> | undefined;
+
+        const next = new Map<string, string[]>();
+
+        for (const [instanceName, channelId] of Object.entries(mapping ?? {})) {
+            // A blank value would otherwise map the literal channel ''.
+            if (!channelId) continue;
+
+            const names = next.get(channelId) ?? [];
+            names.push(instanceName);
+            next.set(channelId, names);
+        }
+
+        for (const [channelId, names] of next) {
+            if (names.length > 1 && !warnedAmbiguous.has(channelId)) {
+                warnedAmbiguous.add(channelId);
+                logger.warn(
+                    `[Chat Relay] Discord channel ${channelId} is mapped by ${names.length} instances`
+                    + ` (${names.join(', ')}); its messages are printed in all of them.`,
+                );
+            }
+        }
+
+        channelToInstances = next;
+    };
+
+    const hasInboundMapping = () => channelToInstances.size > 0;
+
+    /** Token bucket per channel: Discord is far chattier than Factorio chat ever is. */
+    const takeToken = (channelId: string): boolean => {
+        const now = Date.now();
+        let bucket = buckets.get(channelId);
+
+        if (!bucket) {
+            bucket = {tokens: INBOUND_BUCKET_SIZE, updated: now, warned: false};
+            buckets.set(channelId, bucket);
+        }
+
+        bucket.tokens = Math.min(
+            INBOUND_BUCKET_SIZE,
+            bucket.tokens + ((now - bucket.updated) / 1000) * INBOUND_REFILL_PER_SEC,
+        );
+        bucket.updated = now;
+
+        // Re-arm the warning once the channel has calmed down.
+        if (bucket.tokens >= INBOUND_BUCKET_SIZE) bucket.warned = false;
+
+        if (bucket.tokens < 1) {
+            if (!bucket.warned) {
+                bucket.warned = true;
+                logger.warn(`[Chat Relay] Rate limiting inbound chat from channel ${channelId}; dropping.`);
+            }
+
+            return false;
+        }
+
+        bucket.tokens -= 1;
+        return true;
+    };
+
+    /** Config is keyed by instance name; sendTo wants the controller's numeric ID. */
+    const findInstanceId = (instanceName: string): number | null => {
+        for (const instance of controller.instances.values()) {
+            if (instance.config.get('instance.name') === instanceName) return instance.id;
+        }
+
+        return null;
+    };
+
+    const onDiscordMessage = async (message: Message) => {
+        if (shuttingDown) return;
+
+        // The loop guard. Our own outbound posts are authored by the bot, as are
+        // webhooks and other bots, so Factorio -> Discord -> Factorio dies here.
+        if (message.author.bot) return;
+
+        // DMs, group DMs and other unmapped guilds have no instance behind them.
+        if (!message.inGuild()) return;
+
+        const instanceNames = channelToInstances.get(message.channelId);
+        if (!instanceNames) return;
+
+        if (!message.content) return;
+        if (!takeToken(message.channelId)) return;
+
+        const datetime = message.createdAt.toISOString();
+        const authorName = message.member?.displayName ?? message.author.username;
+
+
+        for (const instanceName of instanceNames) {
+            const instanceId = findInstanceId(instanceName);
+
+            if (instanceId === null) {
+                if (!warnedNoInstance.has(instanceName)) {
+                    warnedNoInstance.add(instanceName);
+                    logger.warn(
+                        `[Chat Relay] Instance ${instanceName} is mapped for chat but does not exist;`
+                        + ' dropping Discord messages for it.',
+                    );
+                }
+
+                continue;
+            }
+
+            try {
+                await controller.sendTo({instanceId: instanceId}, new ChatFromDiscordEvent(
+                    authorName,
+                    message.channelId,
+                    datetime,
+                    message.content,
+                ));
+            } catch (err) {
+                // A stopped instance on a busy channel would otherwise be a log flood.
+                if (!warnedSendFail.has(instanceName)) {
+                    warnedSendFail.add(instanceName);
+                    logger.error(
+                        `[Chat Relay] Failed to relay Discord chat to ${instanceName}:\n${stackOf(err)}`,
+                    );
+                }
+            }
+        }
+    };
+
+    // ----------------------------------------------------------------- client
+
+    const closeGateway = async () => {
+        const old = client;
+        client = null;
+
+        if (old) {
+            try {
+                await old.destroy();
+            } catch (err) {
+                logger.error(`[Chat Relay] Discord gateway shutdown error:\n${stackOf(err)}`);
+            }
+        }
+    };
+
+    /** Requires an authenticated `rest`; only ever called from connect()/syncGateway(). */
+    const openGateway = async () => {
+        const token = getToken();
+        if (!token || !rest || client) return;
+
+        const newClient = new Client({intents: [
+            GatewayIntentBits.Guilds,
+            GatewayIntentBits.GuildMessages,
+            GatewayIntentBits.MessageContent,
+        ]});
+
+        newClient.on('messageCreate', message => {
+            onDiscordMessage(message).catch(err => {
+                logger.error(`[Chat Relay] Inbound handler failed:\n${stackOf(err)}`);
+            });
+        });
+
+        newClient.on('error', err => logger.error(`[Chat Relay] Discord gateway error:\n${stackOf(err)}`));
+        newClient.on('shardDisconnect', () => logger.warn('[Chat Relay] Discord gateway disconnected.'));
+
+        try {
+            await newClient.login(token);
+        } catch (err) {
+            // Outbound still works off `rest`; only inbound is down.
+            logger.error(`[Chat Relay] Discord gateway login failed (inbound disabled):\n${stackOf(err)}`);
+            await newClient.destroy().catch(() => {});
+            return;
+        }
+
+        if (shuttingDown) {
+            await newClient.destroy().catch(() => {});
+            return;
+        }
+
+        client = newClient;
+        logger.info('[Chat Relay] Discord gateway connected; inbound chat enabled.');
+    };
+
+    const syncGateway = async () => {
+        if (!hasInboundMapping()) {
+            await closeGateway();
+            return;
+        }
+
+        await openGateway();
+    };
+
+    const connect = async () => {
+        // Drop both halves first: the old REST client holds the previous token, and
+        // the old gateway is logged in with it.
+        rest = null;
+        await closeGateway();
+
+        const token = getToken();
+        if (!token) {
+            logger.error('[Chat Relay] Discord bot token not configured.');
+            return;
+        }
+
+        const newRest = new REST({version: '10'}).setToken(token);
+
+        try {
+            // Fail fast at startup instead of silently on the first chat line.
+            const me = await newRest.get(Routes.user('@me')) as {id: string, username: string};
+            logger.info(`[Chat Relay] Authenticated with Discord as ${me.username} (${me.id}).`);
+        } catch (err) {
+            logger.error(`[Chat Relay] Discord token rejected:\n${stackOf(err)}`);
+            return;
+        }
+
+        if (shuttingDown) return;
+
+        rest = newRest;
+        await syncGateway();
+    };
+
+    // ----------------------------------------------------------------- wiring
+
+    rebuildInboundMap();
+
     controller.handle(ChatEvent, async (request: ChatEvent) => {
         await sendMessage(request.instance_name, request.datetime, request.message);
     });
@@ -190,13 +421,22 @@ export default async function(context: ControllerPluginContext) {
         } else if (field === 'chat_relay.discord_channel_mapping') {
             warnedNoMapping.clear();
             warnedBadChannel.clear();
+            warnedAmbiguous.clear();
+            warnedNoInstance.clear();
+            warnedSendFail.clear();
+            buckets.clear();
+            rebuildInboundMap();
+            enqueue(syncGateway).catch(err => {
+                logger.error(`[Chat Relay] Discord gateway sync failed:\n${stackOf(err)}`);
+            });
         }
     });
 
     controller.hooks.shutdown.attach(plugin.name, async () => {
-        // Nothing to tear down without a gateway; just stop accepting new sends.
-        // In-flight REST calls aren't cancellable and will finish or time out.
+        // Nothing to tear down on the REST side; in-flight calls aren't cancellable
+        // and will finish or time out. The gateway does need an explicit destroy.
         shuttingDown = true;
+        await closeGateway();
     });
 
     await connect();

index.ts

@@ -1,70 +1,136 @@
 import type * as lib from '@clusterio/lib';
-import type {Instance, InstancePluginContext} from '@clusterio/host';
-import {Type, Static} from '@sinclair/typebox';
+import {Type} from '@sinclair/typebox';
+import type {Static} from '@sinclair/typebox';
+
+/* Shared declarations for the chat relay plugin.
+ * `sanitiseForFactorio` is used by both processes: the controller cleans text
+ * before it leaves, and the instance cleans it again before it reaches game.print.
+ */
+
+export const chatFromDiscord = Type.Object({
+    author_name: Type.String(),
+    channel_id: Type.String(),
+    datetime: Type.String(),
+    message: Type.String(),
+});
+
+export type ChatFromDiscord = Static<typeof chatFromDiscord>;
+
+export class ChatFromDiscordEvent {
+    declare ['constructor']: typeof ChatFromDiscordEvent;
+    static type = 'event' as const;
+    static src = 'controller' as const;
+    static dst = 'instance' as const;
+    static plugin = 'chat_relay' as const;
+    static permission = null;
+
+    constructor(
+        public author_name: string,
+        public channel_id: string,
+        public datetime: string,
+        public message: string,
+    ) {}
+
+    static jsonSchema = chatFromDiscord;
+
+    static fromJSON(json: Static<typeof ChatFromDiscordEvent.jsonSchema>) {
+        return new this(json.author_name, json.channel_id, json.datetime, json.message);
+    }
+}
+
+export const MAX_INBOUND_LENGTH = 400;
+
+// Factorio renders these, so a Discord user could spoof a colour, an item link,
+// or a fake speaker line. Whitelist the real tags rather than matching \[.*\],
+// which would also eat innocent text like "array[0]" or "[lol]".
+const RICH_TEXT_RE = new RegExp(
+    String.raw`\[/?(?:color|font|item|entity|technology|recipe|fluid|tile|virtual-signal`
+    + String.raw`|gps|img|specialisation|achievement|train|planet|space-location|quality)(?:=[^\]]*)?\]`,
+    'gi',
+);
+
+/** Make arbitrary text safe to print in-game. Shared by both processes. */
+export function sanitiseForFactorio(text: string, limit = MAX_INBOUND_LENGTH): string {
+    let clean = text
+        .replace(RICH_TEXT_RE, '')
+        .replace(/[\u0000-\u001f\u007f]/g, '')   // control chars, including newlines
+        .replace(/\s+/g, ' ')
+        .trim();
+
+    // Code points, not UTF-16 units: emoji paste from Discord is real here, and a
+    // lone surrogate in a Lua string sent over stdin is not something I'd trust.
+    const chars = Array.from(clean);
+    if (chars.length > limit) {
+        clean = `${chars.slice(0, limit - 3).join('').trimEnd()}...`;
+    }
+
+    return clean;
+}
 
 export class ChatEvent {
-	declare ['constructor']: typeof ChatEvent;
-	static type = 'event' as const;
-	static src = 'instance' as const;
-	static dst = 'controller' as const;
-	static plugin = 'chat_relay' as const;
-	static permission = null;
+    declare ['constructor']: typeof ChatEvent;
+    static type = 'event' as const;
+    static src = 'instance' as const;
+    static dst = 'controller' as const;
+    static plugin = 'chat_relay' as const;
+    static permission = null;
 
-	constructor(
-		public instance_name: string,
-		public datetime: string,
-		public message: string,
-	) {}
+    constructor(
+        public instance_name: string,
+        public datetime: string,
+        public message: string,
+    ) {}
 
-	static jsonSchema = Type.Object({
-		'instance_name': Type.String(),
-		'datetime': Type.String(),
-		'message': Type.String(),
-	});
+    static jsonSchema = Type.Object({
+        'instance_name': Type.String(),
+        'datetime': Type.String(),
+        'message': Type.String(),
+    });
 
-	static fromJSON(json: Static<typeof ChatEvent.jsonSchema>) {
-		return new this(json.instance_name, json.datetime, json.message);
-	}
+    static fromJSON(json: Static<typeof ChatEvent.jsonSchema>) {
+        return new this(json.instance_name, json.datetime, json.message);
+    }
 }
 
 declare module '@clusterio/lib' {
     interface ControllerConfigFields {
         'chat_relay.discord_bot_token': string;
         'chat_relay.datetime_on_message': boolean;
-		'chat_relay.discord_channel_mapping': Record<string, string>;
-	}
+        'chat_relay.discord_channel_mapping': Record<string, string>;
+    }
 }
 
 export const plugin: lib.PluginDeclaration = {
-	name: 'chat_relay',
-	title: 'Chat Relay',
-	description: 'One way chat relay to Discord.',
-	webEntrypoint: './web',
-	instanceEntrypoint: 'dist/node/instance.js',
-	controllerEntrypoint: 'dist/node/controller.js',
-	controllerConfigFields: {
-		'chat_relay.discord_bot_token': {
-			title: 'Discord Bot Token',	
-			description: 'API Token',
-			type: 'string',
-			credential: ['controller']
-		},
-		'chat_relay.datetime_on_message': {
-			title: 'Message Datetime',
-			description: 'Append datetime in front',
-			type: 'boolean',
-			initialValue: true
-		},
-		'chat_relay.discord_channel_mapping': {
-			title: 'Discord Channels',
-			description: 'Instance and Discord channel ID relations',
-			type: 'object',
-			initialValue: {
-				'S1': '123'
-			},
-		},
-	},
-	messages: [
-		ChatEvent,
-	],
+    name: 'chat_relay',
+    title: 'Chat Relay',
+    description: 'Bidirectional chat relay between Factorio and Discord.',
+    webEntrypoint: './web',
+    instanceEntrypoint: 'dist/node/instance.js',
+    controllerEntrypoint: 'dist/node/controller.js',
+    controllerConfigFields: {
+        'chat_relay.discord_bot_token': {
+            title: 'Discord Bot Token',
+            description: 'API Token',
+            type: 'string',
+            credential: ['controller'],
+        },
+        'chat_relay.datetime_on_message': {
+            title: 'Message Datetime',
+            description: 'Append datetime in front',
+            type: 'boolean',
+            initialValue: true,
+        },
+        'chat_relay.discord_channel_mapping': {
+            title: 'Discord Channels',
+            description: 'Instance and Discord channel ID relations, used in both directions',
+            type: 'object',
+            initialValue: {
+                'S1': '123',
+            },
+        },
+    },
+    messages: [
+        ChatEvent,
+        ChatFromDiscordEvent,
+    ],
 };

instance.ts

@@ -1,9 +1,9 @@
 import type {InstancePluginContext} from '@clusterio/host';
-import {ChatEvent} from './index.js';
+import {ChatEvent, ChatFromDiscordEvent, sanitiseForFactorio} from './index.js';
 
 interface ChatMessage {
     datetime: string;
-	message: string;
+    message: string;
 }
 
 function datetime(): string {
@@ -25,16 +25,27 @@ function parse_save(line: string): number | null {
     return slot ? Number(slot[1]) : null;
 }
 
+/** Escape a JS string for embedding in a double-quoted Lua literal. */
+function luaString(text: string): string {
+    return `"${text.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
+}
+
 export default async function(context: InstancePluginContext) {
     const {instance, host, plugin, logger} = context;
     const queue: ChatMessage[] = [];
     let flushing = false;
 
+    // Log-once guard: a busy channel plus a stopped instance or dead RCON would
+    // otherwise write one error per message. Re-armed on controller connect.
+    const warnedPrintFail = new Set<string>();
+
     const flush = async () => {
         if (flushing || queue.length === 0 || !host.connector.connected) {
             return;
         }
+
         flushing = true;
+
         try {
             while (queue.length > 0 && host.connector.connected) {
                 try {
@@ -52,6 +63,7 @@ export default async function(context: InstancePluginContext) {
 
     instance.hooks.controllerConnectionEvent.attach(plugin.name, async (event) => {
         if (event === 'connect') {
+            warnedPrintFail.clear();
             await flush();
         }
     });
@@ -80,7 +92,7 @@ export default async function(context: InstancePluginContext) {
 
             await flush();
         } else if (output.type === 'log') {
-            let message = output.message.trim();
+            const message = output.message.trim();
             const save_slot = parse_save(message);
 
             if (!save_slot) {
@@ -92,4 +104,26 @@ export default async function(context: InstancePluginContext) {
             await flush();
         }
     });
+
+    instance.handle(ChatFromDiscordEvent, async (event: ChatFromDiscordEvent) => {
+        // Re-sanitise here too: any producer can publish this event, and this is
+        // the process that actually calls game.print.
+        const author = sanitiseForFactorio(event.author_name, 40);
+        const message = sanitiseForFactorio(event.message);
+        if (!message) return;
+
+        const line = `[DC] ${author}: ${message}`;
+
+        try {
+            // game.print reaches every player and does NOT fire on_console_chat,
+            // so this cannot echo back out through the outbound half.
+            await instance.sendRcon(`/sc game.print(${luaString(line)})`);
+            logger.info(`[Chat Relay] ${line}`);
+        } catch (err) {
+            if (!warnedPrintFail.has(instance.name)) {
+                warnedPrintFail.add(instance.name);
+                logger.error(`[Chat Relay] Failed to print Discord message in game:\n${(err as Error).stack}`);
+            }
+        }
+    });
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@phidias0303/chat_relay",
-  "version": "1.0.5",
-  "description": "One way chat relay to Discord",
+  "version": "1.0.6",
+  "description": "Chat relay of Discord and Factorio, seperate channel",
   "author": "PHIDIAS <phidias@aperx.org>",
   "license": "MIT",
   "homepage": "https://github.com/PHIDIAS0303/chat_relay#readme",