Making inbound packets hot-reloadable

Author: TheBlackParade

src/game-server.ts

@@ -27,6 +27,7 @@ import { setNpcInitPlugins } from '@server/world/actor/npc/npc';
 import { setQuestPlugins } from '@server/world/config/quests';
 import { setPlayerPlugins } from '@server/world/actor/player/action/player-action';
 import { loadPackets } from '@server/net/inbound-packets';
+import { watchForChanges } from '@server/util/files';
 
 
 export let serverConfig: ServerConfig;
@@ -141,14 +142,6 @@ export async function runGameServer(): Promise<void> {
 
     openServer();
 
-    const watcher = watch('dist/plugins/');
-    watcher.on('ready', () => {
-        watcher.on('all', () => {
-            Object.keys(require.cache).forEach((id) => {
-                if(/[\/\\]plugins[\/\\]/.test(id)) {
-                    delete require.cache[id];
-                }
-            });
-        });
-    });
+    watchForChanges('dist/plugins/', /[\/\\]plugins[\/\\]/);
+    watchForChanges('dist/net/inbound-packets/', /[\/\\]inbound-packets[\/\\]/);
 }

src/plugins/commands/reload-plugins.ts

@@ -0,0 +1,56 @@
+import { ActionType, RunePlugin } from '@server/plugins/plugin';
+import { commandAction } from '@server/world/actor/player/action/input-command-action';
+import { injectPlugins } from '@server/game-server';
+import { loadPackets } from '@server/net/inbound-packets';
+
+const action: commandAction = (details) => {
+    const { player } = details;
+
+    player.sendLogMessage('Reloading content...', details.isConsole);
+
+    // Delete node cache for all the old JS plugins
+    for(const path in require.cache) {
+        if(!path.endsWith('.js')) {
+            continue;
+        }
+
+        const mustContain = [
+            '/plugins/',
+            '/inbound-packets/'
+        ];
+
+        if(path.indexOf('node_modules') !== -1) {
+            continue;
+        }
+
+        let found = false;
+        for(const s of mustContain) {
+            if(path.indexOf(s) !== -1) {
+                found = true;
+                break;
+            }
+        }
+
+        if(!found) {
+            continue;
+        }
+
+        const blacklist = [ 'plugin-loader.js', 'plugin.js', 'rune.js' ];
+        const invalid = blacklist.some(component => path.endsWith(component) || path.endsWith('.map'));
+
+        if(invalid) {
+            continue;
+        }
+
+        delete require.cache[path];
+    }
+
+    injectPlugins()
+        .then(() => player.sendLogMessage('Content reloaded.', details.isConsole))
+        .catch(() => player.sendLogMessage('Error reloading content.', details.isConsole));
+    loadPackets();
+};
+
+export default new RunePlugin({ type: ActionType.COMMAND, commands: [
+    'plugins', 'reload', 'content', 'hotload', 'refresh', 'restart', 'clear', 'r'
+], action });

src/plugins/commands/reload.ts

@@ -1,5 +1,6 @@
 import util from 'util';
 import fs from 'fs';
+import { watch } from 'chokidar';
 
 const readdir = util.promisify(fs.readdir);
 const stat = util.promisify(fs.stat);
@@ -26,3 +27,16 @@ export async function* getFiles(directory: string, blacklist: string[]): AsyncGe
         }
     }
 }
+
+export function watchForChanges(dir: string, regex: RegExp): void {
+    const watcher = watch(dir);
+    watcher.on('ready', () => {
+        watcher.on('all', () => {
+            Object.keys(require.cache).forEach((id) => {
+                if(regex.test(id)) {
+                    delete require.cache[id];
+                }
+            });
+        });
+    });
+}