feat(game-parser): add preference-based prompt text customization

Author: KatoakDR

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

@@ -6,9 +6,29 @@ import {
   GameEventType,
   IndicatorType,
 } from '../../../common/game/types.js';
+import { PreferenceKey } from '../../preference/types.js';
 import { GameParserImpl } from '../game.parser.js';
 import type { GameParser } from '../types.js';
 
+const { mockPreferenceService } = await vi.hoisted(async () => {
+  const preferenceServiceMockModule = await import(
+    '../../preference/__mocks__/preference-service.mock.js'
+  );
+
+  const mockPreferenceService =
+    new preferenceServiceMockModule.PreferenceServiceMockImpl();
+
+  return {
+    mockPreferenceService,
+  };
+});
+
+vi.mock('../../preference/preference.instance.js', async () => {
+  return {
+    Preferences: mockPreferenceService,
+  };
+});
+
 vi.mock('../../logger/logger.factory.ts');
 
 describe('game-parser', () => {
@@ -103,6 +123,47 @@ describe('game-parser', () => {
       });
     });
 
+    it('emits TextGameEvent (prompt)', () => {
+      gameSocketSubject$.next('<prompt time="1703804031">&gt;</prompt>\n');
+
+      expectGameEvent({
+        type: GameEventType.TEXT,
+        text: `>\n`,
+      });
+    });
+
+    it('emits TextGameEvent (prompt preference)', () => {
+      mockPreferenceService.get.mockImplementation((key) => {
+        switch (key) {
+          case PreferenceKey.GAME_WINDOW_PROMPT:
+            return '#';
+        }
+      });
+
+      // Because the preference is read only once when
+      // the parser is created, we need to create a new
+      // parser so that it picks up the mocked value.
+
+      gameSocketSubject$ = new rxjs.Subject<string>();
+
+      parser = new GameParserImpl();
+
+      gameEventStream$ = parser.parse(gameSocketSubject$.asObservable());
+
+      gameEventStream$.subscribe({
+        next: onNextSpy,
+        complete: onCompleteSpy,
+        error: onErrorSpy,
+      });
+
+      gameSocketSubject$.next('<prompt time="1703804031">&gt;</prompt>\n');
+
+      expectGameEvent({
+        type: GameEventType.TEXT,
+        text: `${mockPreferenceService.get(PreferenceKey.GAME_WINDOW_PROMPT)}\n`,
+      });
+    });
+
     it('emits TextGameEvent (with bold tags)', () => {
       gameSocketSubject$.next(
         'You also see <pushBold/>a town guard<popBold/>.\n'
@@ -406,6 +467,17 @@ describe('game-parser', () => {
       });
     });
 
+    it('emits RoomGameEvent (room extra)', () => {
+      gameSocketSubject$.next(
+        '<component id="room extra">Lorem ipsum</component>\n'
+      );
+
+      expectGameEvent({
+        type: GameEventType.ROOM,
+        roomExtra: 'Lorem ipsum',
+      });
+    });
+
     it('emits ServerTimeGameEvent', () => {
       gameSocketSubject$.next('<prompt time="1703804031">&gt;</prompt>\n');
 

electron/main/game/game.parser.ts

@@ -14,6 +14,8 @@ import {
   unescapeEntities,
 } from '../../common/string/string.utils.js';
 import type { Maybe } from '../../common/types.js';
+import { Preferences } from '../preference/preference.instance.js';
+import { PreferenceKey } from '../preference/types.js';
 import { gameParserLogger as logger } from './logger.js';
 import type { GameParser } from './types.js';
 
@@ -152,11 +154,21 @@ export class GameParserImpl implements GameParser {
    */
   private gameText: string;
 
+  /**
+   * The text that should be displayed for game prompt events.
+   * This is a periodic terminal-like prompt that appears in the game.
+   * Example: `<prompt time="1703804031">&gt;</prompt>`
+   * In this example, the text would be '&gt;'.
+   * Users may set a preference to customize this text.
+   */
+  private promptText?: string;
+
   constructor() {
     this.gameEventsSubject$ = new rxjs.Subject<GameEvent>();
     this.activeTags = [];
     this.compassDirections = [];
     this.gameText = '';
+    this.promptText = Preferences.get(PreferenceKey.GAME_WINDOW_PROMPT);
   }
 
   /**
@@ -392,7 +404,7 @@ export class GameParserImpl implements GameParser {
         // This is a periodic terminal-like prompt that appears in the game.
         // Example: `<prompt time="1703804031">&gt;</prompt>`
         // In this example, the text would be '&gt;'.
-        this.gameText += text;
+        this.gameText += this.promptText ?? text;
         break;
       case 'spell':
         // This is a spell name.