fix: create Workers elsewhere and mock for tests (2004Scape#441)

Author: Jameskmonger

src/lostcity/engine/Login.ts

@@ -9,9 +9,10 @@ import Player from '#lostcity/entity/Player.js';
 
 import ClientSocket from '#lostcity/server/ClientSocket.js';
 import { PlayerLoading } from '#lostcity/entity/PlayerLoading.js';
+import { createWorker } from '#lostcity/util/WorkerFactory.js';
 
 class Login {
-    loginThread: Worker = new Worker('./src/lostcity/server/LoginThread.ts');
+    loginThread: Worker = createWorker('./src/lostcity/server/LoginThread.ts');
     loginRequests: Map<string, ClientSocket> = new Map();
     logoutRequests: Set<bigint> = new Set();
 

src/lostcity/engine/World.ts

@@ -56,6 +56,7 @@ import { ZoneEvent } from './zone/Zone.js';
 import LinkList from '#jagex2/datastruct/LinkList.js';
 import ClientProt from '#lostcity/server/ClientProt.js';
 import { NetworkPlayer, isNetworkPlayer } from '#lostcity/entity/NetworkPlayer.js';
+import { createWorker } from '#lostcity/util/WorkerFactory.js';
 
 class World {
     id = Environment.WORLD_ID as number;
@@ -88,7 +89,7 @@ class World {
     futureUpdates: Map<number, number[]> = new Map();
     queue: LinkList<EntityQueueState> = new LinkList();
 
-    friendThread: Worker = new Worker('./src/lostcity/server/FriendThread.ts');
+    friendThread: Worker = createWorker('./src/lostcity/server/FriendThread.ts');
 
     constructor() {
         this.players.fill(null);
@@ -1072,6 +1073,7 @@ class World {
 
     removeNpc(npc: Npc) {
         const zone = this.getZone(npc.x, npc.z, npc.level);
+        console.log('Removing npc', npc.nid, 'from zone', zone.index);
         zone.leave(npc);
 
         switch (npc.blockWalk) {

src/lostcity/util/WorkerFactory.ts

@@ -0,0 +1,5 @@
+import { Worker } from 'node:worker_threads';
+
+export function createWorker(fileName: string) {
+    return new Worker(fileName);
+}

vitest.config.ts

@@ -9,6 +9,8 @@ const Configuration = defineConfig({
         globals: true,
         // Prevent test cross-contamination when mocking implementations
         mockReset: true,
+        // Files to run before tests
+        setupFiles: [ './vitest/mock-worker.ts' ]
     },
 });
 

vitest/mock-worker.ts

@@ -0,0 +1,10 @@
+import { vi } from 'vitest';
+
+vi.mock('#lostcity/util/WorkerFactory.js', async () => {
+    return {
+        createWorker: () => ({
+            on: vi.fn(),
+            postMessage: vi.fn()
+        })
+    };
+});