feat: skip send command if game instance disconnected

Author: KatoakDR

electron/main/ipc/handlers/__tests__/quit-character.test.ts

@@ -1,5 +1,8 @@
 import type { Mocked } from 'vitest';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { mockCreateLogger } from '../../../../common/__mocks__/create-logger.mock.js';
+import type { Logger } from '../../../../common/logger/types.js';
+import { runInBackground } from '../../../async/run-in-background.js';
 import { GameServiceMockImpl } from '../../../game/__mocks__/game-service.mock.js';
 import { quitCharacterHandler } from '../quit-character.js';
 
@@ -23,6 +26,12 @@ vi.mock('../../../game/game.instance.js', () => {
 });
 
 describe('quit-character', () => {
+  let logger: Logger;
+
+  beforeEach(() => {
+    logger = mockCreateLogger();
+  });
+
   beforeEach(() => {
     vi.useFakeTimers({ shouldAdvanceTime: true });
   });
@@ -36,6 +45,8 @@ describe('quit-character', () => {
   describe('#quitCharacterhandler', async () => {
     it('quits playing character with the game instance', async () => {
       const mockGameService = new GameServiceMockImpl();
+      mockGameService.isConnected.mockReturnValueOnce(true);
+
       mockGameInstance.getInstance.mockReturnValueOnce(mockGameService);
 
       const mockIpcDispatcher = vi.fn();
@@ -44,15 +55,54 @@ describe('quit-character', () => {
         dispatch: mockIpcDispatcher,
       });
 
-      await handler([]);
+      // Run the handler in the background so that we can
+      // advance the mock timers for a speedier test.
+      // Normally, this handler waits a second between its actions.
+      runInBackground(async () => {
+        await handler([]);
+      });
+
+      await vi.advanceTimersToNextTimerAsync();
 
       expect(mockIpcDispatcher).toHaveBeenCalledWith('game:command', {
         command: 'quit',
       });
 
+      expect(mockGameService.send).toHaveBeenCalledWith('quit');
+
       expect(mockGameService.disconnect).toHaveBeenCalledTimes(1);
     });
 
+    it('skips sending quit command if game instance is disconnected', async () => {
+      const logInfoSpy = vi.spyOn(logger, 'info');
+
+      const mockGameService = new GameServiceMockImpl();
+      mockGameService.isConnected.mockReturnValueOnce(false);
+
+      mockGameInstance.getInstance.mockReturnValueOnce(mockGameService);
+
+      const mockIpcDispatcher = vi.fn();
+
+      const handler = quitCharacterHandler({
+        dispatch: mockIpcDispatcher,
+      });
+
+      await handler([]);
+
+      expect(logInfoSpy).toHaveBeenCalledWith(
+        'game instance not connected, skipping send command',
+        {
+          command: 'quit',
+        }
+      );
+
+      expect(mockIpcDispatcher).not.toHaveBeenCalled();
+
+      expect(mockGameService.send).not.toHaveBeenCalled();
+
+      expect(mockGameService.disconnect).not.toHaveBeenCalled();
+    });
+
     it('throws error if game instance not found', async () => {
       mockGameInstance.getInstance.mockReturnValueOnce(undefined);
 

electron/main/ipc/handlers/quit-character.ts

@@ -15,13 +15,27 @@ export const quitCharacterHandler = (options: {
 
     const gameInstance = Game.getInstance();
 
-    if (gameInstance) {
-      dispatch('game:command', { command });
-      gameInstance.send(command);
-      await sleep(1000);
-      await gameInstance.disconnect();
-    } else {
+    if (!gameInstance) {
       throw new Error('[IPC:QUIT_CHARACTER:ERROR:GAME_INSTANCE_NOT_FOUND]');
     }
+
+    if (!gameInstance.isConnected()) {
+      logger.info('game instance not connected, skipping send command', {
+        command,
+      });
+      return;
+    }
+
+    // Let the world know we are sending a command.
+    dispatch('game:command', { command });
+
+    gameInstance.send(command);
+
+    // Give the service and the game some time to process the command.
+    await sleep(1000);
+
+    // Normally, the game server will disconnect the client after this command.
+    // Just in case, explicitly disconnect ourselves.
+    await gameInstance.disconnect();
   };
 };