vimp-engine 0.38.3 → 0.39.0

package/src/devtools/contract/rules/c12-voice-hotkey.js

@@ -0,0 +1,70 @@
+import clientDefaults from '../../../config/clientDefaults.js';
+import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
+import { inspectVoiceConfig } from '../../../lib/voiceConfig.js';
+import { ERROR, skip, verdict } from '../result.js';
+
+// Клавиша связи не должна совпасть ни с режимом/командой движка или игры,
+// ни с клавишей игрового набора: ControlsModel.addKey забирает её раньше
+// всех — совпавший режим (чат, стата, escape), команда или действие игры
+// перестали бы работать. Коды движка берутся из clientDefaults, а не
+// списком: правило не отстаёт от движка.
+export default {
+  id: 'C12',
+  name: 'voiceHotkey',
+  level: ERROR,
+  title: 'the push-to-talk key collides with no other key',
+
+  check(ctx) {
+    const { config } = inspectVoiceConfig(ctx.gameConfig?.voice);
+
+    if (!config.enabled) {
+      return skip('voice is off');
+    }
+
+    const code = String(config.hotkey);
+    const violations = [];
+    const engine = clientDefaults.modules.controls;
+    const game = ctx.clientConfig?.modules?.controls;
+
+    for (const [owner, controls] of [
+      ['the engine', engine],
+      ['the game', game],
+    ]) {
+      for (const group of ['modes', 'cmds']) {
+        const name = controls?.[group]?.[code];
+
+        if (name) {
+          violations.push(
+            `voice.hotkey ${code} is bound by ${owner} (${group}: ${name})`,
+          );
+        }
+      }
+    }
+
+    // клиент отдаёт клавишу связи раньше, чем публикует код в голосование,
+    // а Vote принимает цифры 0..9: такая клавиша не выбрала бы вариант
+    if (
+      config.hotkey >= VOTE_ANSWER_KEYS[0] &&
+      config.hotkey <= VOTE_ANSWER_KEYS[1]
+    ) {
+      violations.push(`voice.hotkey ${code} is a vote answer key (digits 0-9)`);
+    }
+
+    const keySetList = game?.keySetList;
+
+    if (Array.isArray(keySetList)) {
+      keySetList.forEach((set, index) => {
+        const action = set?.[code];
+
+        if (action) {
+          violations.push(
+            `voice.hotkey ${code} is bound in keySetList[${index}] ` +
+              `("${action}")`,
+          );
+        }
+      });
+    }
+
+    return verdict(violations);
+  },
+};

package/src/devtools/contract/rules/index.js

@@ -15,6 +15,7 @@ import b7 from './b7-chat-commands.js';
 import b8 from './b8-system-messages.js';
 import b9 from './b9-vote-names.js';
 import b10 from './b10-respawns.js';
+import b11 from './b11-voice-config.js';
 import c1 from './c1-client-shape.js';
 import c2 from './c2-parts-registered.js';
 import c3 from './c3-game-sets-coverage.js';
@@ -26,6 +27,7 @@ import c8 from './c8-baked-assets.js';
 import c9 from './c9-chat-messages.js';
 import c10 from './c10-auth-schema.js';
 import c11 from './c11-stat-mode.js';
+import c12 from './c12-voice-hotkey.js';
 import d1 from './d1-snapshot-ids.js';
 import d2 from './d2-snapshot-classes.js';
 import d3 from './d3-snapshot-interp.js';
@@ -57,6 +59,7 @@ export const rules = [
   b8,
   b9,
   b10,
+  b11,
   c1,
   c2,
   c3,
@@ -68,6 +71,7 @@ export const rules = [
   c9,
   c10,
   c11,
+  c12,
   d1,
   d2,
   d3,

package/src/host/HostGame.js

@@ -5,6 +5,7 @@ import Stat from './meta/modules/Stat.js';
 import Chat from './meta/modules/chat/index.js';
 import { registerCodes } from './meta/modules/chat/systemMessages.js';
 import Vote from './meta/modules/Vote.js';
+import Voice from './meta/modules/voice/index.js';
 import RTTManager from './meta/modules/RTTManager.js';
 import TimerManager from './meta/modules/TimerManager.js';
 import ParticipantManager from './meta/player/ParticipantManager.js';
@@ -12,6 +13,7 @@ import VoteCoordinator from './meta/core/VoteCoordinator.js';
 import RoundManager from './meta/core/RoundManager.js';
 import CommandProcessor from './meta/core/CommandProcessor.js';
 import { sanitizeMessage } from '../lib/sanitizers.js';
+import { parseFloorMessage } from '../lib/voiceMessages.js';
 import closeCodes from '../config/closeCodes.js';
 import clock from '../lib/clock.js';
 import { createResumeKey } from '../lib/resumeKey.js';
@@ -250,6 +252,20 @@ export default class HostGame {
 
     this._socketManager = socketManager;
 
+    // голосовая связь: эфир решается здесь, аудио сюда не
+    // попадает — его раздаёт ретранслятор транспортного уровня по маршрутам
+    // модуля. Эфир не выдаётся, пока матч стоит: заморозка плановой передачи,
+    // пауза эстафеты Worker'ов, ожидание старта из контрольной точки, закрытие
+    this._voice = new Voice(data.voice, {
+      participants: this._participants,
+      socketManager: this._socketManager,
+      isAvailable: () =>
+        !this._frozen &&
+        !this._handoffPaused &&
+        !this._restorePending &&
+        !this._isDestroying,
+    });
+
     this._networkSendRate = data.timers.networkSendRate;
     this._snapshotManager = new SnapshotThrottle(this._networkSendRate);
 
@@ -363,6 +379,9 @@ export default class HostGame {
     this._restoreMode = null; // 'midRound' | 'soft'
     this._restoredTimers = null;
     this._frozen = false;
+    // эстафета Worker'ов прошла границу раунда: игра стоит до terminate()
+    // этого Worker'а или resumeAfterHandoff()
+    this._handoffPaused = false;
     // точка снята на замороженном хосте: pack_body осушил тело кадра вне
     // цикла, и его события (удаления, взрывы) никому не ушли
     this._drainedWhileFrozen = false;
@@ -608,6 +627,11 @@ export default class HostGame {
       }
     });
 
+    // эфиры: таймауты, отзыв, слушатели — с частотой снапшотов; после цикла
+    // рассылки, потому что getCamera в нём исправляет watchedGameId
+    // наблюдателей
+    this._voice.tick();
+
     // граница кадра: pack_body опустошил накопители снапшота — единственный
     // момент, когда дамп ядра корректен
     this._maybeCheckpoint();
@@ -815,6 +839,7 @@ export default class HostGame {
         })),
         activeList: this._participants.getActiveList(),
       },
+      voice: this._voice.debugState(),
       core: this._game.debugJson(),
     };
   }
@@ -840,6 +865,8 @@ export default class HostGame {
    */
   async destroy() {
     this._isDestroying = true;
+    // комната закрывается, сообщать некому
+    this._voice.reset({ notify: false });
 
     if (this._resumeWait) {
       clock.clearTimeout(this._resumeWait.timer);
@@ -882,6 +909,11 @@ export default class HostGame {
     this._roundManager.requestHandoff(() => {
       this._timerManager.stopGameTimers();
       this._timerManager.stopIdleCheckTimer();
+      // без тиков эфир не закончился бы сам, а новый Worker начинает без
+      // эфиров: говорящие получают END, слушатели — STOP; до terminate()
+      // или resumeAfterHandoff() запрос получает UNAVAILABLE
+      this._handoffPaused = true;
+      this._voice.reset();
       this._flushBeforeHandoff().then(() => cb(this._collectHandoff()));
     });
   }
@@ -928,6 +960,7 @@ export default class HostGame {
   // отказ от эстафеты (новый Worker не поднялся): вернуть таймеры и
   // продолжить жить на старой версии кода
   resumeAfterHandoff() {
+    this._handoffPaused = false;
     this._roundManager.cancelHandoff();
     this._timerManager.startIdleCheckTimer();
     this._timerManager.resumeGameTimers(this._timerManager.getMapTimeLeft());
@@ -1072,6 +1105,15 @@ export default class HostGame {
     this._healthSink = typeof sink === 'function' ? sink : null;
   }
 
+  /**
+   * Приёмник маршрутов голосовых эфиров для ретранслятора:
+   * ({ speakerSocketId, route }) => void, route === null — маршрут снят.
+   * @param {Function|null} sink
+   */
+  setVoiceRouteSink(sink) {
+    this._voice.setRouteSink(sink);
+  }
+
   // RTT — только удалённые люди: хост-игрок на loopback связь хоста не мерит
   _onLoopStats(stats) {
     if (!this._healthSink) {
@@ -1543,6 +1585,9 @@ export default class HostGame {
 
     this._frozen = true;
     this._timerManager.pause();
+    // без тиков эфир не закончился бы сам: говорящие получают END,
+    // слушатели — STOP
+    this._voice.reset();
   }
 
   // разморозка (передача сорвалась): отсчёты продолжаются с остатков.
@@ -1672,6 +1717,7 @@ export default class HostGame {
     this._stat.removeUser(gameId, teamId);
     this._chat.removeUser(gameId);
     this._vote.removeUser(gameId);
+    this._voice.removeUser(gameId);
     this._panel.removeUser(gameId);
 
     // финальная синхронизация профиля перед уходом участника (Этап B4):
@@ -1702,6 +1748,18 @@ export default class HostGame {
     }
   }
 
+  // управление эфиром: [1] — запрос, [0, talkId] — отпускание. В рекордер не
+  // пишется: на симуляцию не влияет
+  voiceFloor(gameId, data) {
+    const message = parseFloorMessage(data);
+
+    if (message?.op === 'request') {
+      this._voice.request(gameId);
+    } else if (message?.op === 'release') {
+      this._voice.release(gameId, message.talkId);
+    }
+  }
+
   // обновляет команды (формат wire: 'seq:action:name', указатель —
   // 'seq:aim:x:y:flags')
   updateKeys(gameId, keyStr) {

package/src/host/PortMachine.js

@@ -25,8 +25,10 @@ const PC_PONG = wsports.client.PONG;
 const PC_RESUME_REQUEST = wsports.client.RESUME_REQUEST;
 const PC_LEAVE = wsports.client.LEAVE;
 const PC_TOKEN_REFRESH = wsports.client.TOKEN_REFRESH;
+const PC_VOICE_FLOOR = wsports.client.VOICE_FLOOR;
 
-const PORT_COUNT = 12;
+// VOICE_AUDIO (13) бинарный и порт-машиной не разбирается
+const PORT_COUNT = 13;
 
 // версии формата RESUME_REQUEST, которые понимает хост
 const RESUME_VERSION = 1;
@@ -41,6 +43,7 @@ const IN_GAME_PORTS = [
   PC_PONG,
   PC_LEAVE,
   PC_TOKEN_REFRESH,
+  PC_VOICE_FLOOR,
 ];
 
 export default class PortMachine {
@@ -244,8 +247,18 @@ export default class PortMachine {
       return;
     }
 
-    if (msg && state.enabled[msg[0]]) {
-      state.methods[msg[0]](msg[1]);
+    const port = Array.isArray(msg) ? msg[0] : null;
+
+    // номер порта — только целое из диапазона: строковый ключ вроде
+    // '__proto__' или 'constructor' прошёл бы проверку `enabled[...]` по
+    // прототипу массива и вызвал бы не обработчик
+    if (
+      Number.isInteger(port) &&
+      port >= 0 &&
+      port < PORT_COUNT &&
+      state.enabled[port]
+    ) {
+      state.methods[port](msg[1]);
     }
   }
 
@@ -603,6 +616,9 @@ export default class PortMachine {
 
       // 11: token refresh
       data => this._refreshToken(socketId, state, data),
+
+      // 12: управление эфиром ([1] / [0, talkId]); разбор — HostGame.voiceFloor
+      data => host.voiceFloor(state.gameId, data),
     ];
   }
 }

package/src/host/host.worker.js

@@ -135,6 +135,8 @@ async function onInit(room, handoff = null, checkpointBytes = null, seqFloor) {
   // общая с headless-runner'ом сборка (lib/createHostRuntime.js) — чтобы
   // отладочный прогон крутил ровно тот код, что и прод
   const runtime = await createHostRuntime(room, {
+    // ретранслятор голоса — в главном потоке (HostController)
+    voiceRelay: true,
     hostOptions: {
       // map_changed остаётся для главного потока до host-migration этапа 2
       onMapChange: mapName =>
@@ -151,6 +153,11 @@ async function onInit(room, handoff = null, checkpointBytes = null, seqFloor) {
   // здоровье хоста (host-migration этап 9a): главный поток решает, не пора
   // ли отдать роль
   host.setHealthSink(health => self.postMessage({ type: 'health', health }));
+  // голосовая связь: маршруты эфиров — ретранслятору главного потока
+  // (VoiceRelay). Сам голос Worker не видит никогда
+  host.setVoiceRouteSink(({ speakerSocketId, route }) =>
+    self.postMessage({ type: 'voice_route', speakerSocketId, route }),
+  );
 
   // сбой кода игры, пойманный хостом (чат-команда): в журнал клиентских
   // ошибок тем же сообщением, что и необработанный reject

package/src/host/meta/SocketManager.js

@@ -41,6 +41,7 @@ export default class SocketManager {
     this._PORT_ACCOLADES_DATA = ports.ACCOLADES_DATA;
     this._PORT_SESSION_DATA = ports.SESSION_DATA;
     this._PORT_RESUME_RESULT = ports.RESUME_RESULT;
+    this._PORT_VOICE_DATA = ports.VOICE_DATA;
 
     this._soundCues = soundCues;
     this._initialVote = initialVote;
@@ -349,6 +350,11 @@ export default class SocketManager {
     this._send(socketId, this._PORT_ACCOLADES_DATA, data);
   }
 
+  // голосовая связь: управление эфиром (lib/voiceMessages.js), персонально
+  sendVoice(socketId, data) {
+    this._send(socketId, this._PORT_VOICE_DATA, data);
+  }
+
   /**
    * Отправка сообщения чата.
    * @param {string} socketId