feat: add isConnected method

Author: KatoakDR

electron/main/game/__mocks__/game-service.mock.ts

@@ -8,6 +8,8 @@ export class GameServiceMockImpl implements GameService {
     this.constructorSpy(args);
   }
 
+  isConnected = vi.fn<[], boolean>();
+
   connect = vi.fn<
     Parameters<GameService['connect']>,
     ReturnType<GameService['connect']>

electron/main/game/__tests__/game-instance.test.ts

@@ -6,6 +6,8 @@ import type { GameService } from '../types.js';
 
 const { mockGameService } = vi.hoisted(() => {
   const mockGameService = {
+    isConnected: vi.fn<[], boolean>(),
+
     connect: vi.fn<
       Parameters<GameService['connect']>,
       ReturnType<GameService['connect']>
@@ -29,6 +31,10 @@ const { mockGameService } = vi.hoisted(() => {
 
 vi.mock('../game.service.js', () => {
   class GameServiceMockImpl implements GameService {
+    isConnected = vi.fn<[], boolean>().mockImplementation(() => {
+      return mockGameService.isConnected();
+    });
+
     connect = vi
       .fn<
         Parameters<GameService['connect']>,

electron/main/game/__tests__/game-service.test.ts

@@ -15,6 +15,7 @@ const { mockParser, mockSocket, mockWriteStream, mockWaitUntil } = vi.hoisted(
 
     // For mocking the game socket module.
     const mockSocket: Mocked<GameSocket> = {
+      isConnected: vi.fn(),
       connect: vi.fn(),
       disconnect: vi.fn(),
       send: vi.fn(),
@@ -74,6 +75,10 @@ vi.mock('../game.socket.js', () => {
       this.onDisconnect = options.onDisconnect;
     }
 
+    isConnected = vi.fn().mockImplementation(() => {
+      return mockSocket.isConnected();
+    });
+
     connect = vi
       .fn()
       .mockImplementation(async (): Promise<rxjs.Observable<string>> => {
@@ -170,6 +175,8 @@ describe('game-service', () => {
 
       const gameEvent = await rxjs.firstValueFrom(gameEvents$);
       expect(gameEvent).toEqual(mockEvent);
+
+      expect(gameService.isConnected()).toBe(true);
     });
 
     it('disconnects previous connection', async () => {
@@ -227,6 +234,8 @@ describe('game-service', () => {
 
       expect(mockSocket.connect).toHaveBeenCalledTimes(1);
       expect(mockSocket.disconnect).toHaveBeenCalledTimes(1);
+
+      expect(gameService.isConnected()).toBe(false);
     });
 
     it('does not disconnect if already destroyed', async () => {

electron/main/game/__tests__/game-socket.test.ts

@@ -88,10 +88,17 @@ describe('game-socket', () => {
       // Connect to socket and begin listening for data.
       const socketDataPromise = socket.connect();
 
+      // Not connected yet because the socket has not received the data
+      // that indicates that the game connection is established.
+      expect(socket.isConnected()).toBe(false);
+
       // At this point the socket is listening for data from the game server.
       // Emit data from the game server signaling that the connection is ready.
       mockSocket.emitData('<mode id="GAME"/>\n');
 
+      // Now the socket is connected because it received the expected data.
+      expect(socket.isConnected()).toBe(true);
+
       // Run timer so that the delayed newlines sent on connect are seen.
       await vi.runAllTimersAsync();
 
@@ -125,6 +132,8 @@ describe('game-socket', () => {
 
       await socket.disconnect();
 
+      expect(socket.isConnected()).toBe(false);
+
       // First subscriber receives all buffered and new events.
       expect(subscriber1NextSpy).toHaveBeenCalledTimes(2);
       expect(subscriber1NextSpy).toHaveBeenNthCalledWith(

electron/main/game/game.service.ts

@@ -22,8 +22,8 @@ export class GameServiceImpl implements GameService {
    * There is a brief delay after sending credentials before the game server
    * is ready to receive commands. Sending commands too early will fail.
    */
-  private isConnected = false;
-  private isDestroyed = false;
+  private _isConnected = false;
+  private _isDestroyed = false;
 
   /**
    * Socket to communicate with the game server.
@@ -41,18 +41,22 @@ export class GameServiceImpl implements GameService {
     this.socket = new GameSocketImpl({
       credentials,
       onConnect: () => {
-        this.isConnected = true;
-        this.isDestroyed = false;
+        this._isConnected = true;
+        this._isDestroyed = false;
       },
       onDisconnect: () => {
-        this.isConnected = false;
-        this.isDestroyed = true;
+        this._isConnected = false;
+        this._isDestroyed = true;
       },
     });
   }
 
+  public isConnected(): boolean {
+    return this._isConnected;
+  }
+
   public async connect(): Promise<rxjs.Observable<GameEvent>> {
-    if (this.isConnected) {
+    if (this._isConnected) {
       await this.disconnect();
     }
 
@@ -72,15 +76,15 @@ export class GameServiceImpl implements GameService {
   }
 
   public async disconnect(): Promise<void> {
-    if (!this.isDestroyed) {
+    if (!this._isDestroyed) {
       logger.info('disconnecting');
       await this.socket.disconnect();
       await this.waitUntilDestroyed();
     }
   }
 
   public send(command: string): void {
-    if (this.isConnected) {
+    if (this._isConnected) {
       logger.debug('sending command', { command });
       this.socket.send(command);
     }
@@ -91,7 +95,7 @@ export class GameServiceImpl implements GameService {
     const timeout = 5000;
 
     const result = await waitUntil({
-      condition: () => this.isDestroyed,
+      condition: () => this._isDestroyed,
       interval,
       timeout,
     });

electron/main/game/game.socket.ts

@@ -37,8 +37,8 @@ export class GameSocketImpl implements GameSocket {
    * There is a brief delay after sending credentials before the game server
    * is ready to receive commands. Sending commands too early will fail.
    */
-  private isConnected = false;
-  private isDestroyed = false;
+  private _isConnected = false;
+  private _isDestroyed = false;
 
   /**
    * Socket to communicate with the game server.
@@ -78,8 +78,12 @@ export class GameSocketImpl implements GameSocket {
     this.onDisconnectCallback = options.onDisconnect ?? (() => {});
   }
 
+  public isConnected(): boolean {
+    return this._isConnected;
+  }
+
   public async connect(): Promise<rxjs.Observable<string>> {
-    if (this.isConnected) {
+    if (this._isConnected) {
       await this.disconnect();
     }
 
@@ -102,7 +106,7 @@ export class GameSocketImpl implements GameSocket {
     // If we don't check both conditions then this would wait forever.
     await this.waitUntilConnectedOrDestroyed();
 
-    if (this.isDestroyed) {
+    if (this._isDestroyed) {
       throw new Error(
         `[GAME:SOCKET:STATUS:DESTROYED] failed to connect to game server`
       );
@@ -149,7 +153,7 @@ export class GameSocketImpl implements GameSocket {
     const timeout = 5000;
 
     const result = await waitUntil({
-      condition: () => this.isConnected,
+      condition: () => this._isConnected,
       interval,
       timeout,
     });
@@ -164,7 +168,7 @@ export class GameSocketImpl implements GameSocket {
     const timeout = 5000;
 
     const result = await waitUntil({
-      condition: () => this.isDestroyed,
+      condition: () => this._isDestroyed,
       interval,
       timeout,
     });
@@ -181,13 +185,13 @@ export class GameSocketImpl implements GameSocket {
 
     logger.debug('creating game socket', { host, port });
 
-    this.isConnected = false;
-    this.isDestroyed = false;
+    this._isConnected = false;
+    this._isDestroyed = false;
 
     const onGameConnect = (): void => {
-      if (!this.isConnected) {
-        this.isConnected = true;
-        this.isDestroyed = false;
+      if (!this._isConnected) {
+        this._isConnected = true;
+        this._isDestroyed = false;
       }
       try {
         this.onConnectCallback();
@@ -205,7 +209,7 @@ export class GameSocketImpl implements GameSocket {
       } catch (error) {
         logger.warn('error in disconnect callback', { event, error });
       }
-      if (!this.isDestroyed) {
+      if (!this._isDestroyed) {
         this.destroyGameSocket(socket);
       }
     };
@@ -222,7 +226,7 @@ export class GameSocketImpl implements GameSocket {
       if (buffer.endsWith('\n')) {
         const message = buffer;
         logger.trace('socket received message', { message });
-        if (!this.isConnected && message.startsWith('<mode id="GAME"/>')) {
+        if (!this._isConnected && message.startsWith('<mode id="GAME"/>')) {
           onGameConnect();
         }
         this.socketDataSubject$?.next(message);
@@ -280,8 +284,8 @@ export class GameSocketImpl implements GameSocket {
   protected destroyGameSocket(socket: net.Socket): void {
     logger.debug('destroying game socket');
 
-    this.isConnected = false;
-    this.isDestroyed = true;
+    this._isConnected = false;
+    this._isDestroyed = true;
 
     socket.pause(); // stop receiving data
     socket.destroySoon(); // flush writes then end socket connection

electron/main/game/types.ts

@@ -2,6 +2,11 @@ import type * as rxjs from 'rxjs';
 import type { GameEvent } from '../../common/game/types.js';
 
 export interface GameService {
+  /**
+   * Returns true if connected to the game server.
+   */
+  isConnected(): boolean;
+
   /**
    * Connect to the game server.
    * Returns an observable that emits game events parsed from raw output.
@@ -24,6 +29,11 @@ export interface GameService {
 }
 
 export interface GameSocket {
+  /**
+   * Returns true if connected to the game server.
+   */
+  isConnected(): boolean;
+
   /**
    * Connect to the game server.
    * Returns an observable that emits game server output.