vimp-engine 0.7.2 → 0.9.0

package/src/client/views/gameShell.js

@@ -0,0 +1,190 @@
+// DOM-каркас игрового интерфейса в коде (Этап 2 плана standalone-sdk).
+// В прод-сборке движка разметку даёт pug (./includes/*.pug), но standalone
+// SDK встраивается в чужую страницу репозитория игры, где никакого pug нет —
+// а движковые модули (Auth, Chat, Panel, Stat, информеры) ищут элементы по
+// фиксированным id. Поэтому каркас должен уметь собираться и без сборщика.
+//
+// Функция идемпотентна: существующие элементы не трогает и не переносит,
+// поэтому в lobby-режиме (разметка уже в документе) не делает ничего.
+// Второй источник разметки обязан совпадать с pug — расхождение ловит
+// тест паритета (tests/client/gameShell.test.js).
+//
+// Здесь нет #vote (его создаёт в рантайме components/view/Vote.js) и нет
+// канвасов: их размеры приходят в CONFIG_DATA — см. ensureCanvas().
+
+const SHELL = [
+  {
+    tag: 'div',
+    id: 'panel',
+    children: [{ tag: 'h1', id: 'logo', text: 'VIMP' }],
+  },
+  {
+    tag: 'div',
+    id: 'chat',
+    children: [
+      { tag: 'div', id: 'chat-box' },
+      // maxlength — UX-подсказка; авторитетный лимит на хосте (chatMaxLength)
+      {
+        tag: 'input',
+        id: 'cmd',
+        attrs: { type: 'text', maxlength: '60', autocomplete: 'off' },
+      },
+    ],
+  },
+  { tag: 'div', id: 'stat' },
+  {
+    tag: 'div',
+    id: 'auth',
+    children: [
+      {
+        tag: 'div',
+        id: 'auth-form',
+        attrs: { class: 'card' },
+        children: [
+          // заголовок и help-секции заполняет AuthView из authSchema.texts
+          { tag: 'h2', id: 'auth-title' },
+          { tag: 'div', id: 'auth-error' },
+          { tag: 'div', id: 'auth-fields' },
+          {
+            tag: 'input',
+            id: 'auth-enter',
+            attrs: { type: 'button', autofocus: '', value: 'Start' },
+          },
+          { tag: 'div', id: 'auth-informs' },
+          {
+            tag: 'div',
+            id: 'auth-link',
+            children: [
+              {
+                tag: 'p',
+                children: [
+                  {
+                    tag: 'a',
+                    attrs: { href: 'https://github.com/lgick/vimp' },
+                    text: 'GitHub',
+                  },
+                ],
+              },
+              { tag: 'p', text: `© ${new Date().getFullYear()} VIMP` },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+  { tag: 'div', id: 'game-informer' },
+  { tag: 'div', id: 'tech-informer' },
+];
+
+// класс-маркер: правило `.vimp-shell > *` в style.css держит экраны скрытыми
+// до того, как их покажет свой модуль. В прод-сборке контейнер — body, и
+// правило совпадает с прежним `body > *`; в SDK это чужой div
+export const SHELL_CLASS = 'vimp-shell';
+
+/**
+ * Достраивает недостающие контейнеры игрового интерфейса.
+ *
+ * Контейнер обязан быть полноэкранным и позиционированным
+ * (`position: relative`): #panel, #stat и создаваемый в рантайме #vote —
+ * `position: absolute`, и их containing block — ближайший позиционированный
+ * предок.
+ * @param {HTMLElement} [container] - Точка монтирования (по умолчанию body).
+ * @returns {HTMLElement} Контейнер.
+ */
+export function ensureGameShell(container = document.body) {
+  container.classList.add(SHELL_CLASS);
+  buildNodes(SHELL, container, false);
+
+  return container;
+}
+
+/**
+ * Полотно игры по id из конфига канвасов (CONFIG_DATA). Уже размещённый в
+ * документе элемент переиспользуется как есть — если игра положила
+ * <canvas id="vimp"> в свою разметку, движок его не переносит.
+ * @param {string} canvasId
+ * @param {Object} size - { width, height } из конфига канвасов.
+ * @param {HTMLElement} [container] - Точка монтирования (по умолчанию body).
+ * @returns {HTMLCanvasElement}
+ */
+export function ensureCanvas(canvasId, size, container = document.body) {
+  const canvas =
+    document.getElementById(canvasId) ?? document.createElement('canvas');
+
+  if (!canvas.parentNode) {
+    canvas.setAttribute('id', canvasId);
+    canvas.width = size.width;
+    canvas.height = size.height;
+    container.appendChild(canvas);
+  }
+
+  return canvas;
+}
+
+/**
+ * Набор id, которые собирает каркас. Нужен тесту паритета с pug.
+ * @returns {Set<string>}
+ */
+export function shellIds() {
+  const ids = new Set();
+  const walk = nodes => {
+    for (const node of nodes) {
+      if (node.id) {
+        ids.add(node.id);
+      }
+
+      walk(node.children ?? []);
+    }
+  };
+
+  walk(SHELL);
+
+  return ids;
+}
+
+// рекурсивно достраивает узлы: элемент с таким id уже есть — берём его и
+// спускаемся внутрь (каркас мог быть собран частично), иначе создаём.
+// Безымянные узлы (декоративные p/a внутри #auth-link) достраиваются только
+// вместе со своим родителем: по ним нельзя проверить, есть ли они уже, и в
+// готовой разметке они бы удвоились
+function buildNodes(nodes, parent, parentCreated) {
+  for (const node of nodes) {
+    if (!node.id) {
+      if (parentCreated) {
+        const elem = createNode(node);
+
+        parent.appendChild(elem);
+        buildNodes(node.children ?? [], elem, true);
+      }
+
+      continue;
+    }
+
+    const existing = document.getElementById(node.id);
+    const elem = existing ?? createNode(node);
+
+    if (!existing) {
+      parent.appendChild(elem);
+    }
+
+    buildNodes(node.children ?? [], elem, !existing);
+  }
+}
+
+function createNode({ tag, id, attrs, text }) {
+  const elem = document.createElement(tag);
+
+  if (id) {
+    elem.setAttribute('id', id);
+  }
+
+  for (const [name, value] of Object.entries(attrs ?? {})) {
+    elem.setAttribute(name, value);
+  }
+
+  if (text !== undefined) {
+    elem.textContent = text;
+  }
+
+  return elem;
+}

package/src/client/views/includes/auth.pug

@@ -0,0 +1,20 @@
+//- нейтральный каркас формы авторизации: заголовок и help-секции
+//- заполняет AuthView из authSchema.texts игры (AUTH_DATA, порт 1)
+div#auth
+
+  div#auth-form.card
+
+    h2#auth-title
+
+    div#auth-error
+
+    div#auth-fields
+
+    input#auth-enter(type='button', autofocus, value='Start')
+
+    div#auth-informs
+
+    div#auth-link
+      p
+        a(href='https://github.com/lgick/vimp') GitHub
+      p © #{new Date().getFullYear()} VIMP

package/src/client/views/includes/chat.pug

@@ -0,0 +1,5 @@
+div#chat
+  div#chat-box
+  //- maxlength — лишь UX-подсказка; авторитетный лимит на сервере
+  //- (chatMaxLength в src/config/hostDefaults.js). Значения держать синхронными.
+  input#cmd(type='text', maxlength='60' autocomplete="off")

package/src/client/views/includes/informer.pug

@@ -0,0 +1,2 @@
+div#game-informer
+div#tech-informer

package/src/client/views/includes/lobby.pug

@@ -0,0 +1,48 @@
+//- скрыт по умолчанию: открывается из main.js только после успешного логина
+//- в #lobby-auth (Этап B2, LobbyAuthCtrl 'authenticated')
+div#lobby(style='display:none')
+  div.lobby-grid
+    //- левая панель: профиль + форма создания комнаты (lobby-page-plan)
+    div#lobby-setup-panel.card
+      h2= 'VIMP'
+      //- бейдж входа (Этап B2): управляется LobbyAuthView, показывается
+      //- вместе с #lobby после успешной авторизации
+      div#lobby-user
+        div
+          span= 'Signed in as '
+          b#lobby-user-nick
+        input#lobby-user-logout(type='button', value='Sign out')
+      hr.lobby-divider
+      h3.lobby-section-title= 'HOST A GAME'
+      div#lobby-create
+        //- селектор игры (lobby-page-plan): рабочий с первой же игрой в
+        //- каталоге мастера, а не только когда их несколько
+        div.form-row
+          label.form-label(for='lobby-game')= 'Select Game'
+          select#lobby-game.field-select
+        div.form-row
+          label.form-label(for='lobby-name')= 'Server name'
+          input#lobby-name.field-text(type='text', maxlength='30')
+        //- поля настроек комнаты генерируются по явной схеме roomForm
+        //- манифеста активной игры (docs/en/plugin-api.md "Form schema")
+        div#lobby-fields
+        input#lobby-host(type='button', value='Create server')
+    //- правая панель: вкладки Active Servers / Leaderboard (lobby-page-plan)
+    div#lobby-browser-panel.card
+      //- абсолютный слой: высоту .card задаёт форма слева (stretch), а
+      //- список внутри скроллится, не раздувая карточку (lobby-page-plan)
+      div.lobby-browser-inner
+        div.lobby-tabs-header
+          input#btn-show-servers.lobby-tab-btn.active(type='button', value='Active Servers')
+          input#btn-show-leaderboard.lobby-tab-btn(type='button', value='Leaderboard')
+        div#lobby-servers-content
+          input#lobby-search.field-text(type='text', placeholder='Search servers…')
+          ul#lobby-list
+          p#lobby-empty= 'No servers available'
+          input#lobby-more(type='button', value='Load more')
+        div#lobby-leaderboard-content(style='display:none')
+          div.lobby-leaderboard-header
+            span#leaderboard-title
+            span#leaderboard-total
+          ol#lobby-leaderboard-list
+          p#lobby-my-placement

package/src/client/views/includes/lobbyAuth.pug

@@ -0,0 +1,19 @@
+//- логин-гейт лобби (Этап B2): показывается до #lobby, пока клиент не
+//- авторизован через central auth-сервис (packages/auth). Кнопки провайдеров
+//- фильтруются JS по authClient.providers; неактивные скрыты
+div#lobby-auth
+
+  div#lobby-auth-login.card
+    h2= 'VIMP'
+    p= 'Sign in to play'
+    div#lobby-auth-login-buttons
+      input.lobby-auth-provider#lobby-auth-login-github(type='button', data-provider='github', value='Sign in with GitHub')
+      input.lobby-auth-provider#lobby-auth-login-google(type='button', data-provider='google', value='Sign in with Google')
+      input.lobby-auth-provider#lobby-auth-login-apple(type='button', data-provider='apple', value='Sign in with Apple')
+    div#lobby-auth-login-error
+
+  div#lobby-auth-nick.card(style='display:none')
+    h2= 'Choose your nick'
+    input#lobby-auth-nick-input.field-text(type='text', maxlength='14', placeholder='YourNick')
+    div#lobby-auth-nick-error
+    input#lobby-auth-nick-submit(type='button', value='Continue')

package/src/client/views/includes/panel.pug

@@ -0,0 +1,3 @@
+//- Каркас панели: ячейки генерирует PanelView по схеме игры (CONFIG_DATA)
+div#panel
+  h1#logo= 'VIMP'

package/src/client/views/includes/stat.pug

@@ -0,0 +1,2 @@
+//- Каркас scoreboard: шапку и таблицы генерирует StatView по схеме игры
+div#stat

package/src/client/views/index.pug

@@ -0,0 +1,8 @@
+//- Канвасы генерирует main.js из конфига канвасов игры (CONFIG_DATA)
+include includes/panel
+include includes/chat
+include includes/stat
+include includes/lobbyAuth
+include includes/lobby
+include includes/auth
+include includes/informer

package/src/config/closeCodes.js

@@ -0,0 +1,18 @@
+// коды закрытия транспорта — общий контракт серверных контуров (мастер,
+// dedicated, Worker-хост) и клиента, тот же приём, что в gameCodes.js:
+// значение не должно расходиться между ними молча. Отказы политики — те, что
+// клиент не лечит перезагрузкой, — перечислены в
+// `client/network/policyClose.js`, и тест там требует явного решения по
+// каждому коду из этой карты
+export default {
+  staleHost: 4000, // master/SignalingServer.js — сигнальный WS хоста протух
+  invalidOrigin: 4001, // master/SignalingServer.js, dedicated/main.js
+  blocked: 4002, // master/SignalingServer.js — хостер заблокирован рейтингом
+  kickForMaxLatency: 4003, // host/HostGame.js
+  kickForMissedPings: 4004, // host/HostGame.js
+  kickIdle: 4005, // host/HostGame.js
+  roomFull: 4006, // host/PortMachine.js
+  // 4007 свободен
+  handshakeTimeout: 4008, // dedicated/main.js
+  tooManyConnections: 4009, // dedicated/main.js
+};

package/src/config/env.js

@@ -0,0 +1,61 @@
+// Env-переопределения серверного конфига (Этап 4 плана standalone-sdk).
+// Раньше этот блок жил в master/main.js под условием NODE_ENV=production:
+// лобби-мастер в dev работает на дефолтах конфига. Dedicated-серверу так
+// нельзя — игру, порт и настройки комнаты он получает только из окружения,
+// в том числе локально, — поэтому чтение вынесено сюда и применяется каждым
+// входом по своим правилам.
+
+/**
+ * Применяет env-переопределения к конфигу мастера.
+ * @param {Object} config - Синглтон lib/config.js.
+ * @param {Object} [env] - Окружение (по умолчанию process.env).
+ */
+export function applyMasterEnv(config, env = process.env) {
+  if (env.VIMP_DOMAIN) {
+    config.set('master:domain', env.VIMP_DOMAIN);
+  }
+
+  // порт серверного процесса
+  if (env.VIMP_MASTER_PORT) {
+    config.set('master:port', Number(env.VIMP_MASTER_PORT));
+  }
+
+  // домен central auth-сервиса (Этап B2) — попадает в CSP connect-src, т.к.
+  // лобби делает туда прямой fetch (POST /nick)
+  if (env.VIMP_AUTH_SERVICE_URL) {
+    config.set('master:security:authServiceUrl', env.VIMP_AUTH_SERVICE_URL);
+  }
+
+  // список игр-плагинов мастера (Этап A2), по образцу остальных *_MATRIX
+  // env-переопределений — JSON-массив {id, package, version}
+  if (env.GAMES_MATRIX) {
+    config.set('master:games', JSON.parse(env.GAMES_MATRIX));
+  }
+}
+
+/**
+ * Настройки комнаты dedicated-сервера: VIMP_DEDICATED_ROOM — JSON-объект
+ * (map, maxPlayers, roundTime, mapTime, friendlyFire, seed). Мусор в
+ * переменной не должен ронять процесс молча — отказ именованный.
+ * @param {Object} [env] - Окружение (по умолчанию process.env).
+ * @returns {Object} Переопределения комнаты.
+ */
+export function readDedicatedRoom(env = process.env) {
+  if (!env.VIMP_DEDICATED_ROOM) {
+    return {};
+  }
+
+  let room;
+
+  try {
+    room = JSON.parse(env.VIMP_DEDICATED_ROOM);
+  } catch (e) {
+    throw new Error(`VIMP_DEDICATED_ROOM: invalid JSON — ${e.message}`);
+  }
+
+  if (!room || typeof room !== 'object' || Array.isArray(room)) {
+    throw new Error('VIMP_DEDICATED_ROOM: expected a JSON object');
+  }
+
+  return room;
+}

package/src/devtools/ScenarioRunner.js

@@ -1,4 +1,5 @@
 import { createHostRuntime } from '../lib/createHostRuntime.js';
+import { offlinePlayerData } from '../lib/offlinePlayerData.js';
 import VirtualClock, { flushMicrotasks } from './VirtualClock.js';
 import RecordingSocketManager from './RecordingSocketManager.js';
 import VirtualClient from './VirtualClient.js';
@@ -32,14 +33,8 @@ const RECORDED_PORTS = {
 };
 
 // В headless-контуре нет ни мастера, ни auth-сервиса — участник стартует с
-// пустым профилем. Это не заглушка ради тишины: пустой профиль и есть
-// корректное состояние прогона, а настоящий fetch по относительному URL в
-// Node просто не разрешается.
-const emptyProfileFetch = async () => ({
-  ok: true,
-  status: 200,
-  json: async () => ({ rank: 0, state: null }),
-});
+// пустым профилем (lib/offlinePlayerData.js, общее со standalone/dedicated).
+const emptyProfileFetch = offlinePlayerData();
 
 /**
  * Приводит сценарий к полной форме и проверяет обязательные поля.

package/src/devtools/pluginLoader.js

@@ -1,10 +1,7 @@
-import { access, readFile } from 'node:fs/promises';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import {
-  assertEngineApiCompatible,
-  assertGameConfigShape,
-} from '../lib/gamePlugin.js';
+import { assertGameConfigShape } from '../lib/gamePlugin.js';
+import { loadGamePackage } from '../lib/loadGamePackage.js';
 
 // Поиск игры для headless-прогона. В браузере плагин грузится по URL из
 // GameManifest мастера; в Node URL-ов нет, поэтому источников три, по
@@ -56,64 +53,15 @@ export async function loadGameForSim({ game = null, core = null } = {}) {
   return plugin;
 }
 
+// путь --game указывает либо на пакет игры, либо прямо на манифест; сама
+// загрузка общая с dedicated-сервером (lib/loadGamePackage.js)
 async function loadFromManifest(game, core) {
-  const manifestPath = game.endsWith('.json')
+  const target = game.endsWith('.json')
     ? path.resolve(game)
-    : path.resolve(game, 'dist/manifest.json');
-  const manifest = JSON.parse(await readFile(manifestPath, 'utf8'));
+    : path.resolve(game, 'dist');
+  const pkg = await loadGamePackage(target, { core });
 
-  assertEngineApiCompatible(manifest);
-
-  const baseDir = path.dirname(manifestPath);
-  const { assetsBase } = manifest;
-  const hostPlugin = await importDefault(
-    baseDir,
-    manifest.entries.host,
-    assetsBase,
-  );
-  const clientPlugin = await importDefault(
-    baseDir,
-    manifest.entries.client,
-    assetsBase,
-  );
-
-  assertPluginMatchesManifest(manifest, {
-    host: hostPlugin,
-    client: clientPlugin,
-  });
-
-  const nodeCore = core ?? manifest.entries.wasmNode ?? null;
-
-  if (!nodeCore) {
-    throw new Error(
-      `${manifestPath}: no node build of the core — add entries.wasmNode ` +
-        `to the manifest (core/pkg-node) or pass --core <path>`,
-    );
-  }
-
-  const corePath = path.resolve(baseDir, nodeCore);
-
-  // манифест объявляет поле, но опубликованный пакет мог не довезти файл
-  // (ignore-правила срезают каталог внутри files) — без этой проверки отказ
-  // приходит сырым ERR_MODULE_NOT_FOUND из резолвера
-  try {
-    await access(corePath);
-  } catch {
-    throw new Error(
-      `${manifestPath}: entries.wasmNode points at '${nodeCore}', but ` +
-        `${corePath} does not exist — the game package was published ` +
-        `without its node core (npm run core:build:node) or pass --core <path>`,
-    );
-  }
-
-  return {
-    id: manifest.id,
-    manifest,
-    hostPlugin,
-    clientPlugin,
-    wasmUrl: pathToFileURL(path.resolve(baseDir, nodeCore)).href,
-    source: manifestPath,
-  };
+  return { ...pkg, source: pkg.manifestPath };
 }
 
 // фикстура даёт рабочий контур сразу, ещё до того как игра соберёт pkg-node:
@@ -133,36 +81,3 @@ async function loadFixture(core) {
     source: FIXTURE_SOURCE,
   };
 }
-
-// зеркало lib/gamePlugin.js:loadClientPlugin — манифест мог быть пересобран
-// без dist/: прогон на старом плагине даёт зелёный вердикт о том, чего в
-// сборке уже нет
-function assertPluginMatchesManifest(manifest, plugins) {
-  for (const [half, plugin] of Object.entries(plugins)) {
-    if (plugin.engineApi !== manifest.engineApi) {
-      throw new Error(
-        `game "${manifest.id}": ${half} plugin engineApi ` +
-          `v${plugin.engineApi} does not match manifest engineApi ` +
-          `v${manifest.engineApi} — stale dist/`,
-      );
-    }
-  }
-}
-
-function importDefault(baseDir, entry, assetsBase) {
-  const file = path.resolve(baseDir, stripBase(entry, assetsBase));
-
-  return import(pathToFileURL(file).href).then(module => module.default);
-}
-
-// entries.host/client — URL-ы, какими их видит браузер (`assetsBase` + путь
-// внутри пакета). На диске этой базе соответствует каталог манифеста,
-// поэтому абсолютный URL сначала обрезается до пути внутри пакета — иначе
-// path.resolve увёл бы в корень файловой системы.
-function stripBase(entry, assetsBase) {
-  if (assetsBase && entry.startsWith(assetsBase)) {
-    return entry.slice(assetsBase.length);
-  }
-
-  return entry.replace(/^\/+/, '');
-}

package/src/host/HostGame.js

@@ -11,6 +11,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 closeCodes from '../config/closeCodes.js';
 import clock from '../lib/clock.js';
 import GameCoreAdapter from './GameCoreAdapter.js';
 import DebugRecorder from './DebugRecorder.js';
@@ -279,7 +280,11 @@ export default class HostGame {
 
     if (user && !this._isHostPlayer(user)) {
       console.warn(`[RTT] Kick ${user.name} — pong latency exceeded`);
-      this._socketManager.close(user.socketId, 4003, 'kickForMaxLatency');
+      this._socketManager.close(
+        user.socketId,
+        closeCodes.kickForMaxLatency,
+        'kickForMaxLatency',
+      );
       this.removeUser(gameId);
     }
   }
@@ -290,7 +295,11 @@ export default class HostGame {
 
     if (user && !this._isHostPlayer(user)) {
       console.warn(`[RTT] Kick ${user.name} — no response to pings`);
-      this._socketManager.close(user.socketId, 4004, 'kickForMissedPings');
+      this._socketManager.close(
+        user.socketId,
+        closeCodes.kickForMissedPings,
+        'kickForMissedPings',
+      );
       this.removeUser(gameId);
     }
   }
@@ -439,7 +448,7 @@ export default class HostGame {
     }
 
     usersToKick.forEach(user => {
-      this._socketManager.close(user.socketId, 4005, 'kickIdle');
+      this._socketManager.close(user.socketId, closeCodes.kickIdle, 'kickIdle');
       this.removeUser(user.gameId);
     });
   }
@@ -599,6 +608,35 @@ export default class HostGame {
     }
   }
 
+  /**
+   * Публичный teardown матча: останов таймеров, финальная синхронизация
+   * профилей и снятие всех участников. Во вкладке матч умирает вместе с
+   * Worker'ом, а долгоживущему процессу (dedicated-сервер) нужен graceful
+   * shutdown — иначе таймеры держат процесс, а rank/state теряются.
+   * @returns {Promise} Завершение финальной синхронизации профилей.
+   */
+  async destroy() {
+    this._timerManager.stopGameTimers();
+    this._timerManager.stopIdleCheckTimer();
+    this._timerManager.stopAllVoteTimers();
+    this._timerManager.stopAllBlockedVoteTimers();
+
+    // flushAll до снятия участников: removeUser чистит запись PlayerDataSync,
+    // и после него синхронизировать было бы уже нечего. Ждём здесь же —
+    // иначе removeUser стартует второй flush с той же накопленной дельтой
+    // (двойной зачёт рейтинга), а destroy разрешился бы раньше, чем эти
+    // запросы уйдут
+    await this._playerDataSync.flushAll();
+
+    // getAll() отдаёт копию — снятие внутри цикла реестр не ломает
+    for (const user of this._participants.getAll()) {
+      // запись уже синхронизирована — финальный flush внутри removeUser
+      // не нужен и был бы повтором
+      this._playerDataSync.removeUser(user.gameId);
+      this.removeUser(user.gameId);
+    }
+  }
+
   // ***** эстафета Worker'ов (Этап 5.2) ***** //
 
   // запрашивает перенос: на ближайшей границе раунда игра останавливается