Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| eabbc08896 | |||
| 6920f93b41 | |||
| ec3802ade6 | |||
| 66c6f34cd3 | |||
| 3858beb28e | |||
| 1b91eacb5b | |||
| 11c2588e45 | |||
| bc2fa7de22 | |||
| 44588e8789 | |||
| 167c45ba8d |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -60,3 +60,8 @@ dist-server/*
|
||||
|
||||
AGENTS.md
|
||||
doc/**
|
||||
|
||||
metoyou.sqlite*
|
||||
metoyou.sqlite
|
||||
|
||||
vitest/
|
||||
|
||||
165
README.md
165
README.md
@@ -1,119 +1,88 @@
|
||||
<img src="./images/icon.png" width="100" height="100">
|
||||
|
||||
# MetoYou / Toju
|
||||
|
||||
# Toju / Zoracord
|
||||
MetoYou is a desktop-first chat stack managed as an npm monorepo. The repository contains the Angular 21 product client, the Electron desktop shell, the Node/TypeScript signaling server, the Playwright E2E suite, and the Angular 19 marketing website.
|
||||
|
||||
Desktop chat app with four parts:
|
||||
## Packages
|
||||
|
||||
- `src/` Angular client
|
||||
- `electron/` desktop shell, IPC, and local database
|
||||
- `server/` directory server, join request API, and websocket events
|
||||
- `website/` Toju website served at toju.app
|
||||
| Path | Purpose | Docs |
|
||||
| --- | --- | --- |
|
||||
| `toju-app/` | Angular 21 product client | [toju-app/README.md](toju-app/README.md) |
|
||||
| `electron/` | Electron main process, preload bridge, IPC, and desktop integrations | [electron/README.md](electron/README.md) |
|
||||
| `server/` | Signaling server, server-directory API, and websocket runtime | [server/README.md](server/README.md) |
|
||||
| `e2e/` | Playwright end-to-end coverage for the product client | [e2e/README.md](e2e/README.md) |
|
||||
| `website/` | Angular 19 marketing site served separately from the product client | [website/README.md](website/README.md) |
|
||||
|
||||
## Install
|
||||
|
||||
1. Run `npm install`
|
||||
2. Run `cd server && npm install`
|
||||
3. Copy `.env.example` to `.env`
|
||||
1. Run `npm install` from the repository root.
|
||||
2. Run `cd server && npm install` for the server package.
|
||||
3. If you need to work on the marketing site, run `cd website && npm install`.
|
||||
4. Copy `.env.example` to `.env`.
|
||||
|
||||
## Config
|
||||
## Configuration
|
||||
|
||||
Root `.env`:
|
||||
- Root `.env` controls local SSL with `SSL=true|false`.
|
||||
- The server also honors an optional `PORT` environment override at runtime.
|
||||
- When `SSL=true`, run `./generate-cert.sh` once or let `./dev.sh` generate local certificates on first launch.
|
||||
- `server/data/variables.json` stores `klipyApiKey`, `releaseManifestUrl`, `serverPort`, `serverProtocol`, `serverHost`, and `linkPreview`. The server normalizes this file on startup.
|
||||
- When `serverProtocol` is `https`, the certificates in `.certs/` must exist and match the configured host or IP.
|
||||
|
||||
- `SSL=true` uses HTTPS for Angular, the server, and Electron dev mode
|
||||
- `PORT=3001` changes the server port in local development and overrides the server app setting
|
||||
## Main Commands
|
||||
|
||||
If `SSL=true`, run `./generate-cert.sh` once.
|
||||
- `npm run dev` starts the full desktop stack: server, product client, and Electron.
|
||||
- `npm run start` starts only the Angular product client in `toju-app/`.
|
||||
- `npm run electron:dev` starts the Angular product client and Electron together.
|
||||
- `npm run server:dev` starts only the server with reload.
|
||||
- `npm run build` builds the Angular product client to `dist/client`.
|
||||
- `npm run build:electron` builds the Electron code to `dist/electron`.
|
||||
- `npm run build:all` builds the product client, Electron, and server.
|
||||
- `npm run test` runs the product-client Vitest suite.
|
||||
- `npm run lint` runs ESLint across the repo.
|
||||
- `npm run lint:fix` formats Angular templates, sorts template properties, and applies ESLint fixes.
|
||||
- `npm run test:e2e`, `npm run test:e2e:ui`, `npm run test:e2e:debug`, and `npm run test:e2e:report` run the Playwright suite and report tooling.
|
||||
|
||||
Server files:
|
||||
|
||||
- `server/data/variables.json` holds `klipyApiKey`
|
||||
- `server/data/variables.json` also holds `releaseManifestUrl` for desktop auto updates
|
||||
- `server/data/variables.json` can now also hold optional `serverHost` (an IP address or hostname to bind to)
|
||||
- `server/data/variables.json` can now also hold `serverProtocol` (`http` or `https`)
|
||||
- `server/data/variables.json` can now also hold `serverPort` (1-65535)
|
||||
- When `serverProtocol` is `https`, the certificate must match the configured `serverHost` or IP
|
||||
|
||||
## Main commands
|
||||
|
||||
- `npm run dev` starts Angular, the server, and Electron
|
||||
- `npm run electron:dev` starts Angular and Electron
|
||||
- `npm run server:dev` starts only the server
|
||||
- `npm run build` builds the Angular client
|
||||
- `npm run build:electron` builds the Electron code
|
||||
- `npm run build:all` builds client, Electron, and server
|
||||
- `npm run lint` runs ESLint
|
||||
- `npm run lint:fix` formats templates, sorts template props, and fixes lint issues
|
||||
- `npm run test` runs Angular tests
|
||||
|
||||
## Server project
|
||||
|
||||
The code in `server/` is a small Node and TypeScript service.
|
||||
It handles the public server directory, join requests, websocket updates, and Klipy routes.
|
||||
|
||||
Inside `server/`:
|
||||
|
||||
- `npm run dev` starts the server with reload
|
||||
- `npm run build` compiles to `dist/`
|
||||
- `npm run start` runs the compiled server
|
||||
|
||||
# Images
|
||||
<img src="./website/src/images/screenshots/gif.png" width="700" height="400">
|
||||
<img src="./website/src/images/screenshots/screenshare_gaming.png" width="700" height="400">
|
||||
|
||||
## Main Toju app Structure
|
||||
## Repository Map
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `src/app/` | Main application root |
|
||||
| `src/app/core/` | Core utilities, services, models |
|
||||
| `src/app/domains/` | Domain-driven modules |
|
||||
| `src/app/features/` | UI feature modules |
|
||||
| `src/app/infrastructure/` | Low-level infrastructure (DB, realtime, etc.) |
|
||||
| `src/app/shared/` | Shared UI components |
|
||||
| `src/app/shared-kernel/` | Shared domain contracts & models |
|
||||
| `src/app/store/` | Global state management |
|
||||
| `src/assets/` | Static assets |
|
||||
| `src/environments/` | Environment configs |
|
||||
| --- | --- |
|
||||
| `toju-app/src/app/domains/` | Product-client bounded contexts and domain facades |
|
||||
| `toju-app/src/app/infrastructure/` | Shared client-side technical runtime such as persistence and realtime |
|
||||
| `toju-app/src/app/shared-kernel/` | Cross-domain contracts shared inside the product client |
|
||||
| `electron/` | Electron bootstrap, preload surface, IPC handlers, CQRS, and desktop adapters |
|
||||
| `server/src/` | Express app, websocket runtime, config, CQRS, and persistence layers |
|
||||
| `e2e/` | Playwright tests, helpers, fixtures, and page objects |
|
||||
| `website/src/` | Marketing-site pages, assets, and SSR entry points |
|
||||
| `tools/` | Build, release, formatting, and packaging scripts |
|
||||
|
||||
---
|
||||
## Product Client Docs
|
||||
|
||||
### Domains
|
||||
| Area | Docs |
|
||||
| --- | --- |
|
||||
| Domains index | [toju-app/src/app/domains/README.md](toju-app/src/app/domains/README.md) |
|
||||
| Access Control | [toju-app/src/app/domains/access-control/README.md](toju-app/src/app/domains/access-control/README.md) |
|
||||
| Attachment | [toju-app/src/app/domains/attachment/README.md](toju-app/src/app/domains/attachment/README.md) |
|
||||
| Authentication | [toju-app/src/app/domains/authentication/README.md](toju-app/src/app/domains/authentication/README.md) |
|
||||
| Chat | [toju-app/src/app/domains/chat/README.md](toju-app/src/app/domains/chat/README.md) |
|
||||
| Notifications | [toju-app/src/app/domains/notifications/README.md](toju-app/src/app/domains/notifications/README.md) |
|
||||
| Profile Avatar | [toju-app/src/app/domains/profile-avatar/README.md](toju-app/src/app/domains/profile-avatar/README.md) |
|
||||
| Screen Share | [toju-app/src/app/domains/screen-share/README.md](toju-app/src/app/domains/screen-share/README.md) |
|
||||
| Server Directory | [toju-app/src/app/domains/server-directory/README.md](toju-app/src/app/domains/server-directory/README.md) |
|
||||
| Theme | [toju-app/src/app/domains/theme/README.md](toju-app/src/app/domains/theme/README.md) |
|
||||
| Voice Connection | [toju-app/src/app/domains/voice-connection/README.md](toju-app/src/app/domains/voice-connection/README.md) |
|
||||
| Voice Session | [toju-app/src/app/domains/voice-session/README.md](toju-app/src/app/domains/voice-session/README.md) |
|
||||
| Persistence | [toju-app/src/app/infrastructure/persistence/README.md](toju-app/src/app/infrastructure/persistence/README.md) |
|
||||
| Realtime | [toju-app/src/app/infrastructure/realtime/README.md](toju-app/src/app/infrastructure/realtime/README.md) |
|
||||
| Shared Kernel | [toju-app/src/app/shared-kernel/README.md](toju-app/src/app/shared-kernel/README.md) |
|
||||
|
||||
| Path | Link |
|
||||
|------|------|
|
||||
| Attachment | [app/domains/attachment/README.md](src/app/domains/attachment/README.md) |
|
||||
| Auth | [app/domains/auth/README.md](src/app/domains/auth/README.md) |
|
||||
| Chat | [app/domains/chat/README.md](src/app/domains/chat/README.md) |
|
||||
| Screen Share | [app/domains/screen-share/README.md](src/app/domains/screen-share/README.md) |
|
||||
| Server Directory | [app/domains/server-directory/README.md](src/app/domains/server-directory/README.md) |
|
||||
| Voice Connection | [app/domains/voice-connection/README.md](src/app/domains/voice-connection/README.md) |
|
||||
| Voice Session | [app/domains/voice-session/README.md](src/app/domains/voice-session/README.md) |
|
||||
| Domains Root | [app/domains/README.md](src/app/domains/README.md) |
|
||||
## Supporting Docs
|
||||
|
||||
---
|
||||
- [doc/monorepo.md](doc/monorepo.md)
|
||||
- [doc/typescript.md](doc/typescript.md)
|
||||
- [docs/architecture.md](docs/architecture.md)
|
||||
|
||||
### Infrastructure
|
||||
## Screenshots
|
||||
|
||||
| Path | Link |
|
||||
|------|------|
|
||||
| Persistence | [src/app/infrastructure/persistence/README.md](src/app/infrastructure/persistence/README.md) |
|
||||
| Realtime | [src/app/infrastructure/realtime/README.md](src/app/infrastructure/realtime/README.md) |
|
||||
|
||||
---
|
||||
|
||||
### Shared Kernel
|
||||
|
||||
| Path | Link |
|
||||
|------|------|
|
||||
| Shared Kernel | [src/app/shared-kernel/README.md](src/app/shared-kernel/README.md) |
|
||||
|
||||
---
|
||||
|
||||
### Entry Points
|
||||
|
||||
| File | Link |
|
||||
|------|------|
|
||||
| Main | [main.ts](src/main.ts) |
|
||||
| Index HTML | [index.html](src/index.html) |
|
||||
| App Root | [app/app.ts](src/app/app.ts) |
|
||||
<img src="./website/src/images/screenshots/gif.png" width="700" height="400">
|
||||
<img src="./website/src/images/screenshots/screenshare_gaming.png" width="700" height="400">
|
||||
|
||||
36
e2e/README.md
Normal file
36
e2e/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# End-to-End Tests
|
||||
|
||||
Playwright suite for the MetoYou / Toju product client. The tests exercise browser flows such as authentication, chat, voice, screen sharing, and settings with reusable page objects and helpers.
|
||||
|
||||
## Commands
|
||||
|
||||
Run these from the repository root:
|
||||
|
||||
- `npm run test:e2e` runs the full Playwright suite.
|
||||
- `npm run test:e2e:ui` opens Playwright UI mode.
|
||||
- `npm run test:e2e:debug` runs the suite in debug mode.
|
||||
- `npm run test:e2e:report` opens the HTML report in `test-results/html-report`.
|
||||
|
||||
You can also run `npx playwright test` from `e2e/` directly.
|
||||
|
||||
## Runtime
|
||||
|
||||
- `playwright.config.ts` starts `cd ../toju-app && npx ng serve` as the test web server.
|
||||
- The suite targets `http://localhost:4200`.
|
||||
- Tests currently run with a single Chromium worker.
|
||||
- The browser launches with fake media-device flags and grants microphone/camera permissions.
|
||||
- Artifacts are written to `../test-results/artifacts`, and the HTML report is written to `../test-results/html-report`.
|
||||
|
||||
## Structure
|
||||
|
||||
| Path | Description |
|
||||
| --- | --- |
|
||||
| `tests/` | Test specs grouped by feature area such as `auth/`, `chat/`, `voice/`, `screen-share/`, and `settings/` |
|
||||
| `pages/` | Reusable Playwright page objects |
|
||||
| `helpers/` | Test helpers, fake-server utilities, and WebRTC helpers |
|
||||
| `fixtures/` | Shared test fixtures |
|
||||
|
||||
## Notes
|
||||
|
||||
- The suite is product-client focused; it does not currently spin up the marketing website.
|
||||
- Keep reusable browser flows in `pages/` and cross-test utilities in `helpers/`.
|
||||
@@ -5,23 +5,15 @@ import {
|
||||
type BrowserContext,
|
||||
type Browser
|
||||
} from '@playwright/test';
|
||||
import { spawn, type ChildProcess } from 'node:child_process';
|
||||
import { once } from 'node:events';
|
||||
import { createServer } from 'node:net';
|
||||
import { join } from 'node:path';
|
||||
import { installTestServerEndpoint } from '../helpers/seed-test-endpoint';
|
||||
import { startTestServer, type TestServerHandle } from '../helpers/test-server';
|
||||
|
||||
export interface Client {
|
||||
page: Page;
|
||||
context: BrowserContext;
|
||||
}
|
||||
|
||||
interface TestServerHandle {
|
||||
port: number;
|
||||
url: string;
|
||||
stop: () => Promise<void>;
|
||||
}
|
||||
|
||||
interface MultiClientFixture {
|
||||
createClient: () => Promise<Client>;
|
||||
testServer: TestServerHandle;
|
||||
@@ -31,10 +23,9 @@ const FAKE_AUDIO_FILE = join(__dirname, 'test-tone.wav');
|
||||
const CHROMIUM_FAKE_MEDIA_ARGS = [
|
||||
'--use-fake-device-for-media-stream',
|
||||
'--use-fake-ui-for-media-stream',
|
||||
`--use-file-for-fake-audio-capture=${FAKE_AUDIO_FILE}`
|
||||
`--use-file-for-fake-audio-capture=${FAKE_AUDIO_FILE}`,
|
||||
'--autoplay-policy=no-user-gesture-required'
|
||||
];
|
||||
const E2E_DIR = join(__dirname, '..');
|
||||
const START_SERVER_SCRIPT = join(E2E_DIR, 'helpers', 'start-test-server.js');
|
||||
|
||||
export const test = base.extend<MultiClientFixture>({
|
||||
testServer: async ({ playwright: _playwright }, use: (testServer: TestServerHandle) => Promise<void>) => {
|
||||
@@ -81,122 +72,3 @@ export const test = base.extend<MultiClientFixture>({
|
||||
});
|
||||
|
||||
export { expect } from '@playwright/test';
|
||||
|
||||
async function startTestServer(retries = 3): Promise<TestServerHandle> {
|
||||
for (let attempt = 1; attempt <= retries; attempt++) {
|
||||
const port = await allocatePort();
|
||||
const child = spawn(process.execPath, [START_SERVER_SCRIPT], {
|
||||
cwd: E2E_DIR,
|
||||
env: {
|
||||
...process.env,
|
||||
TEST_SERVER_PORT: String(port)
|
||||
},
|
||||
stdio: 'pipe'
|
||||
});
|
||||
|
||||
child.stdout?.on('data', (chunk: Buffer | string) => {
|
||||
process.stdout.write(chunk.toString());
|
||||
});
|
||||
|
||||
child.stderr?.on('data', (chunk: Buffer | string) => {
|
||||
process.stderr.write(chunk.toString());
|
||||
});
|
||||
|
||||
try {
|
||||
await waitForServerReady(port, child);
|
||||
} catch (error) {
|
||||
await stopServer(child);
|
||||
|
||||
if (attempt < retries) {
|
||||
console.log(`[E2E Server] Attempt ${attempt} failed, retrying...`);
|
||||
continue;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
return {
|
||||
port,
|
||||
url: `http://localhost:${port}`,
|
||||
stop: async () => {
|
||||
await stopServer(child);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error('startTestServer: unreachable');
|
||||
}
|
||||
|
||||
async function allocatePort(): Promise<number> {
|
||||
return new Promise<number>((resolve, reject) => {
|
||||
const probe = createServer();
|
||||
|
||||
probe.once('error', reject);
|
||||
probe.listen(0, '127.0.0.1', () => {
|
||||
const address = probe.address();
|
||||
|
||||
if (!address || typeof address === 'string') {
|
||||
probe.close();
|
||||
reject(new Error('Failed to resolve an ephemeral test server port'));
|
||||
return;
|
||||
}
|
||||
|
||||
const { port } = address;
|
||||
|
||||
probe.close((error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
|
||||
resolve(port);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async function waitForServerReady(port: number, child: ChildProcess, timeoutMs = 30_000): Promise<void> {
|
||||
const readyUrl = `http://127.0.0.1:${port}/api/servers?limit=1`;
|
||||
const deadline = Date.now() + timeoutMs;
|
||||
|
||||
while (Date.now() < deadline) {
|
||||
if (child.exitCode !== null) {
|
||||
throw new Error(`Test server exited before becoming ready (exit code ${child.exitCode})`);
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(readyUrl);
|
||||
|
||||
if (response.ok) {
|
||||
return;
|
||||
}
|
||||
} catch {
|
||||
// Server still starting.
|
||||
}
|
||||
|
||||
await wait(250);
|
||||
}
|
||||
|
||||
throw new Error(`Timed out waiting for test server on port ${port}`);
|
||||
}
|
||||
|
||||
async function stopServer(child: ChildProcess): Promise<void> {
|
||||
if (child.exitCode !== null) {
|
||||
return;
|
||||
}
|
||||
|
||||
child.kill('SIGTERM');
|
||||
|
||||
const exited = await Promise.race([once(child, 'exit').then(() => true), wait(3_000).then(() => false)]);
|
||||
|
||||
if (!exited && child.exitCode === null) {
|
||||
child.kill('SIGKILL');
|
||||
await once(child, 'exit');
|
||||
}
|
||||
}
|
||||
|
||||
function wait(durationMs: number): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
setTimeout(resolve, durationMs);
|
||||
});
|
||||
}
|
||||
|
||||
3
e2e/fixtures/plugins/api-test-plugin/README.md
Normal file
3
e2e/fixtures/plugins/api-test-plugin/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# E2E Plugin API Fixture
|
||||
|
||||
This plugin is intentionally tiny. Tests use its manifest to exercise plugin discovery, server support metadata, server data, and plugin event relay APIs without executing plugin code.
|
||||
6
e2e/fixtures/plugins/api-test-plugin/dist/main.js
vendored
Normal file
6
e2e/fixtures/plugins/api-test-plugin/dist/main.js
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
export default {
|
||||
id: 'e2e.plugin-api',
|
||||
activate(api) {
|
||||
api?.logger?.info?.('E2E Plugin API Fixture activated');
|
||||
}
|
||||
};
|
||||
49
e2e/fixtures/plugins/api-test-plugin/toju-plugin.json
Normal file
49
e2e/fixtures/plugins/api-test-plugin/toju-plugin.json
Normal file
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"apiVersion": "1.0.0",
|
||||
"capabilities": [
|
||||
"storage.serverData.read",
|
||||
"storage.serverData.write",
|
||||
"events.server.publish",
|
||||
"events.server.subscribe",
|
||||
"events.p2p.publish",
|
||||
"events.p2p.subscribe"
|
||||
],
|
||||
"compatibility": {
|
||||
"minimumTojuVersion": "1.0.0",
|
||||
"verifiedTojuVersion": "1.0.0"
|
||||
},
|
||||
"data": [
|
||||
{
|
||||
"key": "settings",
|
||||
"scope": "server",
|
||||
"storage": "serverData"
|
||||
},
|
||||
{
|
||||
"key": "presence",
|
||||
"scope": "user",
|
||||
"storage": "serverData"
|
||||
}
|
||||
],
|
||||
"description": "Fixture plugin used by automated tests for plugin support APIs.",
|
||||
"entrypoint": "./dist/main.js",
|
||||
"events": [
|
||||
{
|
||||
"direction": "serverRelay",
|
||||
"eventName": "e2e:relay",
|
||||
"maxPayloadBytes": 2048,
|
||||
"scope": "server"
|
||||
},
|
||||
{
|
||||
"direction": "p2pHint",
|
||||
"eventName": "e2e:p2p",
|
||||
"maxPayloadBytes": 512,
|
||||
"scope": "user"
|
||||
}
|
||||
],
|
||||
"id": "e2e.plugin-api",
|
||||
"kind": "client",
|
||||
"readme": "./README.md",
|
||||
"schemaVersion": 1,
|
||||
"title": "E2E Plugin API Fixture",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
42
e2e/helpers/plugin-api-test-fixture.ts
Normal file
42
e2e/helpers/plugin-api-test-fixture.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
|
||||
export const TEST_PLUGIN_FIXTURE_DIR = join(__dirname, '..', 'fixtures', 'plugins', 'api-test-plugin');
|
||||
export const TEST_PLUGIN_ID = 'e2e.plugin-api';
|
||||
export const TEST_PLUGIN_RELAY_EVENT = 'e2e:relay';
|
||||
export const TEST_PLUGIN_P2P_EVENT = 'e2e:p2p';
|
||||
|
||||
export interface PluginApiTestManifestEvent {
|
||||
direction: 'clientToServer' | 'serverRelay' | 'p2pHint';
|
||||
eventName: string;
|
||||
maxPayloadBytes?: number;
|
||||
scope: 'server' | 'channel' | 'user' | 'plugin';
|
||||
}
|
||||
|
||||
export interface PluginApiTestManifest {
|
||||
description: string;
|
||||
events: PluginApiTestManifestEvent[];
|
||||
id: string;
|
||||
title: string;
|
||||
version: string;
|
||||
}
|
||||
|
||||
export async function readPluginApiTestManifest(): Promise<PluginApiTestManifest> {
|
||||
const manifestPath = join(TEST_PLUGIN_FIXTURE_DIR, 'toju-plugin.json');
|
||||
const manifestText = await readFile(manifestPath, 'utf8');
|
||||
|
||||
return JSON.parse(manifestText) as PluginApiTestManifest;
|
||||
}
|
||||
|
||||
export function getPluginApiTestEvent(
|
||||
manifest: PluginApiTestManifest,
|
||||
eventName: string
|
||||
): PluginApiTestManifestEvent {
|
||||
const eventDefinition = manifest.events.find((event) => event.eventName === eventName);
|
||||
|
||||
if (!eventDefinition) {
|
||||
throw new Error(`Expected fixture plugin to define ${eventName}`);
|
||||
}
|
||||
|
||||
return eventDefinition;
|
||||
}
|
||||
@@ -3,6 +3,15 @@ import { type BrowserContext, type Page } from '@playwright/test';
|
||||
const SERVER_ENDPOINTS_STORAGE_KEY = 'metoyou_server_endpoints';
|
||||
const REMOVED_DEFAULT_KEYS_STORAGE_KEY = 'metoyou_removed_default_server_keys';
|
||||
|
||||
export interface SeededEndpointInput {
|
||||
id: string;
|
||||
name: string;
|
||||
url: string;
|
||||
isActive?: boolean;
|
||||
isDefault?: boolean;
|
||||
status?: string;
|
||||
}
|
||||
|
||||
interface SeededEndpointStorageState {
|
||||
key: string;
|
||||
removedKey: string;
|
||||
@@ -17,27 +26,42 @@ interface SeededEndpointStorageState {
|
||||
}
|
||||
|
||||
function buildSeededEndpointStorageState(
|
||||
port: number = Number(process.env.TEST_SERVER_PORT) || 3099
|
||||
endpointsOrPort: readonly SeededEndpointInput[] | number = Number(process.env.TEST_SERVER_PORT) || 3099
|
||||
): SeededEndpointStorageState {
|
||||
const endpoint = {
|
||||
id: 'e2e-test-server',
|
||||
name: 'E2E Test Server',
|
||||
url: `http://localhost:${port}`,
|
||||
isActive: true,
|
||||
isDefault: false,
|
||||
status: 'unknown'
|
||||
};
|
||||
const endpoints = Array.isArray(endpointsOrPort)
|
||||
? endpointsOrPort.map((endpoint) => ({
|
||||
id: endpoint.id,
|
||||
name: endpoint.name,
|
||||
url: endpoint.url,
|
||||
isActive: endpoint.isActive ?? true,
|
||||
isDefault: endpoint.isDefault ?? false,
|
||||
status: endpoint.status ?? 'unknown'
|
||||
}))
|
||||
: [
|
||||
{
|
||||
id: 'e2e-test-server',
|
||||
name: 'E2E Test Server',
|
||||
url: `http://localhost:${endpointsOrPort}`,
|
||||
isActive: true,
|
||||
isDefault: false,
|
||||
status: 'unknown'
|
||||
}
|
||||
];
|
||||
|
||||
return {
|
||||
key: SERVER_ENDPOINTS_STORAGE_KEY,
|
||||
removedKey: REMOVED_DEFAULT_KEYS_STORAGE_KEY,
|
||||
endpoints: [endpoint]
|
||||
endpoints
|
||||
};
|
||||
}
|
||||
|
||||
function applySeededEndpointStorageState(storageState: SeededEndpointStorageState): void {
|
||||
try {
|
||||
const storage = window.localStorage;
|
||||
const currentUserId = storage.getItem('metoyou_currentUserId')?.trim() || null;
|
||||
const generalSettings = JSON.stringify({
|
||||
reopenLastViewedChat: false
|
||||
});
|
||||
|
||||
storage.setItem(storageState.key, JSON.stringify(storageState.endpoints));
|
||||
storage.setItem(storageState.removedKey, JSON.stringify([
|
||||
@@ -45,11 +69,56 @@ function applySeededEndpointStorageState(storageState: SeededEndpointStorageStat
|
||||
'toju-primary',
|
||||
'toju-sweden'
|
||||
]));
|
||||
storage.setItem('metoyou_general_settings', generalSettings);
|
||||
|
||||
if (currentUserId) {
|
||||
storage.setItem(`metoyou_general_settings__${encodeURIComponent(currentUserId)}`, generalSettings);
|
||||
}
|
||||
|
||||
const keysToRemove: string[] = [];
|
||||
|
||||
for (let index = 0; index < storage.length; index += 1) {
|
||||
const key = storage.key(index);
|
||||
|
||||
if (key === 'metoyou_lastViewedChat' || key?.startsWith('metoyou_lastViewedChat__')) {
|
||||
keysToRemove.push(key);
|
||||
}
|
||||
}
|
||||
|
||||
for (const key of keysToRemove) {
|
||||
storage.removeItem(key);
|
||||
}
|
||||
} catch {
|
||||
// about:blank and some Playwright UI pages deny localStorage access.
|
||||
}
|
||||
}
|
||||
|
||||
export async function disableLastViewedChatResume(page: Page): Promise<void> {
|
||||
await page.evaluate(() => {
|
||||
const currentUserId = localStorage.getItem('metoyou_currentUserId')?.trim() || null;
|
||||
const generalSettings = JSON.stringify({ reopenLastViewedChat: false });
|
||||
const keysToRemove: string[] = [];
|
||||
|
||||
localStorage.setItem('metoyou_general_settings', generalSettings);
|
||||
|
||||
if (currentUserId) {
|
||||
localStorage.setItem(`metoyou_general_settings__${encodeURIComponent(currentUserId)}`, generalSettings);
|
||||
}
|
||||
|
||||
for (let index = 0; index < localStorage.length; index += 1) {
|
||||
const key = localStorage.key(index);
|
||||
|
||||
if (key === 'metoyou_lastViewedChat' || key?.startsWith('metoyou_lastViewedChat__')) {
|
||||
keysToRemove.push(key);
|
||||
}
|
||||
}
|
||||
|
||||
for (const key of keysToRemove) {
|
||||
localStorage.removeItem(key);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
export async function installTestServerEndpoint(
|
||||
context: BrowserContext,
|
||||
port: number = Number(process.env.TEST_SERVER_PORT) || 3099
|
||||
@@ -59,6 +128,15 @@ export async function installTestServerEndpoint(
|
||||
await context.addInitScript(applySeededEndpointStorageState, storageState);
|
||||
}
|
||||
|
||||
export async function installTestServerEndpoints(
|
||||
context: BrowserContext,
|
||||
endpoints: readonly SeededEndpointInput[]
|
||||
): Promise<void> {
|
||||
const storageState = buildSeededEndpointStorageState(endpoints);
|
||||
|
||||
await context.addInitScript(applySeededEndpointStorageState, storageState);
|
||||
}
|
||||
|
||||
/**
|
||||
* Seed localStorage with a single signal endpoint pointing at the test server.
|
||||
* Must be called AFTER navigating to the app origin (localStorage is per-origin)
|
||||
@@ -79,3 +157,12 @@ export async function seedTestServerEndpoint(
|
||||
|
||||
await page.evaluate(applySeededEndpointStorageState, storageState);
|
||||
}
|
||||
|
||||
export async function seedTestServerEndpoints(
|
||||
page: Page,
|
||||
endpoints: readonly SeededEndpointInput[]
|
||||
): Promise<void> {
|
||||
const storageState = buildSeededEndpointStorageState(endpoints);
|
||||
|
||||
await page.evaluate(applySeededEndpointStorageState, storageState);
|
||||
}
|
||||
|
||||
132
e2e/helpers/test-server.ts
Normal file
132
e2e/helpers/test-server.ts
Normal file
@@ -0,0 +1,132 @@
|
||||
import { spawn, type ChildProcess } from 'node:child_process';
|
||||
import { once } from 'node:events';
|
||||
import { createServer } from 'node:net';
|
||||
import { join } from 'node:path';
|
||||
|
||||
export interface TestServerHandle {
|
||||
port: number;
|
||||
url: string;
|
||||
stop: () => Promise<void>;
|
||||
}
|
||||
|
||||
const E2E_DIR = join(__dirname, '..');
|
||||
const START_SERVER_SCRIPT = join(E2E_DIR, 'helpers', 'start-test-server.js');
|
||||
|
||||
export async function startTestServer(retries = 3): Promise<TestServerHandle> {
|
||||
for (let attempt = 1; attempt <= retries; attempt++) {
|
||||
const port = await allocatePort();
|
||||
const child = spawn(process.execPath, [START_SERVER_SCRIPT], {
|
||||
cwd: E2E_DIR,
|
||||
env: {
|
||||
...process.env,
|
||||
TEST_SERVER_PORT: String(port)
|
||||
},
|
||||
stdio: 'pipe'
|
||||
});
|
||||
|
||||
child.stdout?.on('data', (chunk: Buffer | string) => {
|
||||
process.stdout.write(chunk.toString());
|
||||
});
|
||||
|
||||
child.stderr?.on('data', (chunk: Buffer | string) => {
|
||||
process.stderr.write(chunk.toString());
|
||||
});
|
||||
|
||||
try {
|
||||
await waitForServerReady(port, child);
|
||||
} catch (error) {
|
||||
await stopServer(child);
|
||||
|
||||
if (attempt < retries) {
|
||||
console.log(`[E2E Server] Attempt ${attempt} failed, retrying...`);
|
||||
continue;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
return {
|
||||
port,
|
||||
url: `http://localhost:${port}`,
|
||||
stop: async () => {
|
||||
await stopServer(child);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error('startTestServer: unreachable');
|
||||
}
|
||||
|
||||
async function allocatePort(): Promise<number> {
|
||||
return await new Promise<number>((resolve, reject) => {
|
||||
const probe = createServer();
|
||||
|
||||
probe.once('error', reject);
|
||||
probe.listen(0, '127.0.0.1', () => {
|
||||
const address = probe.address();
|
||||
|
||||
if (!address || typeof address === 'string') {
|
||||
probe.close();
|
||||
reject(new Error('Failed to resolve an ephemeral test server port'));
|
||||
return;
|
||||
}
|
||||
|
||||
const { port } = address;
|
||||
|
||||
probe.close((error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
|
||||
resolve(port);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async function waitForServerReady(port: number, child: ChildProcess, timeoutMs = 30_000): Promise<void> {
|
||||
const readyUrl = `http://127.0.0.1:${port}/api/servers?limit=1`;
|
||||
const deadline = Date.now() + timeoutMs;
|
||||
|
||||
while (Date.now() < deadline) {
|
||||
if (child.exitCode !== null) {
|
||||
throw new Error(`Test server exited before becoming ready (exit code ${child.exitCode})`);
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(readyUrl);
|
||||
|
||||
if (response.ok) {
|
||||
return;
|
||||
}
|
||||
} catch {
|
||||
// Server still starting.
|
||||
}
|
||||
|
||||
await wait(250);
|
||||
}
|
||||
|
||||
throw new Error(`Timed out waiting for test server on port ${port}`);
|
||||
}
|
||||
|
||||
async function stopServer(child: ChildProcess): Promise<void> {
|
||||
if (child.exitCode !== null) {
|
||||
return;
|
||||
}
|
||||
|
||||
child.kill('SIGTERM');
|
||||
|
||||
const exited = await Promise.race([once(child, 'exit').then(() => true), wait(3_000).then(() => false)]);
|
||||
|
||||
if (!exited && child.exitCode === null) {
|
||||
child.kill('SIGKILL');
|
||||
await once(child, 'exit');
|
||||
}
|
||||
}
|
||||
|
||||
function wait(durationMs: number): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
setTimeout(resolve, durationMs);
|
||||
});
|
||||
}
|
||||
@@ -46,75 +46,6 @@ export async function installWebRTCTracking(page: Page): Promise<void> {
|
||||
(window as any).RTCPeerConnection.prototype = OriginalRTCPeerConnection.prototype;
|
||||
Object.setPrototypeOf((window as any).RTCPeerConnection, OriginalRTCPeerConnection);
|
||||
|
||||
// Patch getUserMedia to use an AudioContext oscillator for audio
|
||||
// instead of the hardware capture device. Chromium's fake audio
|
||||
// device intermittently fails to produce frames after renegotiation.
|
||||
const origGetUserMedia = navigator.mediaDevices.getUserMedia.bind(navigator.mediaDevices);
|
||||
|
||||
navigator.mediaDevices.getUserMedia = async (constraints?: MediaStreamConstraints) => {
|
||||
const wantsAudio = !!constraints?.audio;
|
||||
|
||||
if (!wantsAudio) {
|
||||
return origGetUserMedia(constraints);
|
||||
}
|
||||
|
||||
// Get the original stream (may include video)
|
||||
const originalStream = await origGetUserMedia(constraints);
|
||||
const audioCtx = new AudioContext();
|
||||
const noiseBuffer = audioCtx.createBuffer(1, audioCtx.sampleRate * 2, audioCtx.sampleRate);
|
||||
const noiseData = noiseBuffer.getChannelData(0);
|
||||
|
||||
for (let sampleIndex = 0; sampleIndex < noiseData.length; sampleIndex++) {
|
||||
noiseData[sampleIndex] = (Math.random() * 2 - 1) * 0.18;
|
||||
}
|
||||
|
||||
const source = audioCtx.createBufferSource();
|
||||
const gain = audioCtx.createGain();
|
||||
|
||||
source.buffer = noiseBuffer;
|
||||
source.loop = true;
|
||||
gain.gain.value = 0.12;
|
||||
|
||||
const dest = audioCtx.createMediaStreamDestination();
|
||||
|
||||
source.connect(gain);
|
||||
gain.connect(dest);
|
||||
source.start();
|
||||
|
||||
if (audioCtx.state === 'suspended') {
|
||||
try {
|
||||
await audioCtx.resume();
|
||||
} catch {}
|
||||
}
|
||||
|
||||
const synthAudioTrack = dest.stream.getAudioTracks()[0];
|
||||
const resultStream = new MediaStream();
|
||||
|
||||
syntheticMediaResources.push({ audioCtx, source });
|
||||
|
||||
resultStream.addTrack(synthAudioTrack);
|
||||
|
||||
// Keep any video tracks from the original stream
|
||||
for (const videoTrack of originalStream.getVideoTracks()) {
|
||||
resultStream.addTrack(videoTrack);
|
||||
}
|
||||
|
||||
// Stop original audio tracks since we're not using them
|
||||
for (const track of originalStream.getAudioTracks()) {
|
||||
track.stop();
|
||||
}
|
||||
|
||||
synthAudioTrack.addEventListener('ended', () => {
|
||||
try {
|
||||
source.stop();
|
||||
} catch {}
|
||||
|
||||
void audioCtx.close().catch(() => {});
|
||||
}, { once: true });
|
||||
|
||||
return resultStream;
|
||||
};
|
||||
|
||||
// Patch getDisplayMedia to return a synthetic screen share stream
|
||||
// (canvas-based video + 880Hz oscillator audio) so the browser
|
||||
// picker dialog is never shown.
|
||||
@@ -198,6 +129,48 @@ export async function installWebRTCTracking(page: Page): Promise<void> {
|
||||
/**
|
||||
* Wait until at least one RTCPeerConnection reaches the 'connected' state.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensure every `AudioContext` created by the page auto-resumes so that
|
||||
* the input-gain Web Audio pipeline (`source -> gain -> destination`) never
|
||||
* stalls in the "suspended" state.
|
||||
*
|
||||
* On Linux with multiple headless Chromium instances, `new AudioContext()`
|
||||
* can start suspended without a user-gesture gate, causing the media
|
||||
* pipeline to emit only a single RTP packet.
|
||||
*
|
||||
* Call once per page, BEFORE navigating, alongside `installWebRTCTracking`.
|
||||
*/
|
||||
export async function installAutoResumeAudioContext(page: Page): Promise<void> {
|
||||
await page.addInitScript(() => {
|
||||
const OrigAudioContext = window.AudioContext;
|
||||
|
||||
(window as any).AudioContext = function(this: AudioContext, ...args: any[]) {
|
||||
const ctx: AudioContext = new OrigAudioContext(...args);
|
||||
// Track all created AudioContexts for test diagnostics
|
||||
const tracked = ((window as any).__trackedAudioContexts ??= []) as AudioContext[];
|
||||
|
||||
tracked.push(ctx);
|
||||
|
||||
if (ctx.state === 'suspended') {
|
||||
ctx.resume().catch(() => { /* noop */ });
|
||||
}
|
||||
|
||||
// Also catch transitions to suspended after creation
|
||||
ctx.addEventListener('statechange', () => {
|
||||
if (ctx.state === 'suspended') {
|
||||
ctx.resume().catch(() => { /* noop */ });
|
||||
}
|
||||
});
|
||||
|
||||
return ctx;
|
||||
} as any;
|
||||
|
||||
(window as any).AudioContext.prototype = OrigAudioContext.prototype;
|
||||
Object.setPrototypeOf((window as any).AudioContext, OrigAudioContext);
|
||||
});
|
||||
}
|
||||
|
||||
export async function waitForPeerConnected(page: Page, timeout = 30_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
() => (window as any).__rtcConnections?.some(
|
||||
@@ -218,6 +191,177 @@ export async function isPeerStillConnected(page: Page): Promise<boolean> {
|
||||
);
|
||||
}
|
||||
|
||||
/** Returns the number of tracked peer connections in `connected` state. */
|
||||
export async function getConnectedPeerCount(page: Page): Promise<number> {
|
||||
return page.evaluate(
|
||||
() => ((window as any).__rtcConnections as RTCPeerConnection[] | undefined)?.filter(
|
||||
(pc) => pc.connectionState === 'connected'
|
||||
).length ?? 0
|
||||
);
|
||||
}
|
||||
|
||||
/** Wait until the expected number of peer connections are `connected`. */
|
||||
export async function waitForConnectedPeerCount(page: Page, expectedCount: number, timeout = 45_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(count) => ((window as any).__rtcConnections as RTCPeerConnection[] | undefined)?.filter(
|
||||
(pc) => pc.connectionState === 'connected'
|
||||
).length === count,
|
||||
expectedCount,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resume all suspended AudioContext instances created by the synthetic
|
||||
* media patch. Uses CDP `Runtime.evaluate` with `userGesture: true` so
|
||||
* Chrome treats the call as a user-gesture - this satisfies the autoplay
|
||||
* policy that otherwise blocks `AudioContext.resume()`.
|
||||
*/
|
||||
export async function resumeSyntheticAudioContexts(page: Page): Promise<number> {
|
||||
const cdpSession = await page.context().newCDPSession(page);
|
||||
|
||||
try {
|
||||
const result = await cdpSession.send('Runtime.evaluate', {
|
||||
expression: `(async () => {
|
||||
const resources = window.__rtcSyntheticMediaResources;
|
||||
if (!resources) return 0;
|
||||
let resumed = 0;
|
||||
for (const r of resources) {
|
||||
if (r.audioCtx.state === 'suspended') {
|
||||
await r.audioCtx.resume();
|
||||
resumed++;
|
||||
}
|
||||
}
|
||||
return resumed;
|
||||
})()`,
|
||||
awaitPromise: true,
|
||||
userGesture: true
|
||||
});
|
||||
|
||||
return result.result.value ?? 0;
|
||||
} finally {
|
||||
await cdpSession.detach();
|
||||
}
|
||||
}
|
||||
|
||||
interface PerPeerAudioStat {
|
||||
connectionState: string;
|
||||
inboundBytes: number;
|
||||
inboundPackets: number;
|
||||
outboundBytes: number;
|
||||
outboundPackets: number;
|
||||
}
|
||||
|
||||
/** Get per-peer audio stats for every tracked RTCPeerConnection. */
|
||||
export async function getPerPeerAudioStats(page: Page): Promise<PerPeerAudioStat[]> {
|
||||
return page.evaluate(async () => {
|
||||
const connections = (window as any).__rtcConnections as RTCPeerConnection[] | undefined;
|
||||
|
||||
if (!connections?.length) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const snapshots: PerPeerAudioStat[] = [];
|
||||
|
||||
for (const pc of connections) {
|
||||
let inboundBytes = 0;
|
||||
let inboundPackets = 0;
|
||||
let outboundBytes = 0;
|
||||
let outboundPackets = 0;
|
||||
|
||||
try {
|
||||
const stats = await pc.getStats();
|
||||
|
||||
stats.forEach((report: any) => {
|
||||
const kind = report.kind ?? report.mediaType;
|
||||
|
||||
if (report.type === 'outbound-rtp' && kind === 'audio') {
|
||||
outboundBytes += report.bytesSent ?? 0;
|
||||
outboundPackets += report.packetsSent ?? 0;
|
||||
}
|
||||
|
||||
if (report.type === 'inbound-rtp' && kind === 'audio') {
|
||||
inboundBytes += report.bytesReceived ?? 0;
|
||||
inboundPackets += report.packetsReceived ?? 0;
|
||||
}
|
||||
});
|
||||
} catch {
|
||||
// Closed connection.
|
||||
}
|
||||
|
||||
snapshots.push({
|
||||
connectionState: pc.connectionState,
|
||||
inboundBytes,
|
||||
inboundPackets,
|
||||
outboundBytes,
|
||||
outboundPackets
|
||||
});
|
||||
}
|
||||
|
||||
return snapshots;
|
||||
});
|
||||
}
|
||||
|
||||
/** Wait until every connected peer connection shows inbound and outbound audio flow. */
|
||||
export async function waitForAllPeerAudioFlow(
|
||||
page: Page,
|
||||
expectedConnectedPeers: number,
|
||||
timeoutMs = 45_000,
|
||||
pollIntervalMs = 1_000
|
||||
): Promise<void> {
|
||||
const deadline = Date.now() + timeoutMs;
|
||||
// Track which peer indices have been confirmed flowing at least once.
|
||||
// This prevents a peer from being missed just because it briefly paused
|
||||
// during one specific poll interval.
|
||||
const confirmedFlowing = new Set<number>();
|
||||
|
||||
let previous = await getPerPeerAudioStats(page);
|
||||
|
||||
while (Date.now() < deadline) {
|
||||
await page.waitForTimeout(pollIntervalMs);
|
||||
const current = await getPerPeerAudioStats(page);
|
||||
const connectedPeers = current.filter((stat) => stat.connectionState === 'connected');
|
||||
|
||||
if (connectedPeers.length >= expectedConnectedPeers) {
|
||||
for (let index = 0; index < current.length; index++) {
|
||||
const curr = current[index];
|
||||
|
||||
if (!curr || curr.connectionState !== 'connected') {
|
||||
continue;
|
||||
}
|
||||
|
||||
const prev = previous[index] ?? {
|
||||
connectionState: 'new',
|
||||
inboundBytes: 0,
|
||||
inboundPackets: 0,
|
||||
outboundBytes: 0,
|
||||
outboundPackets: 0
|
||||
};
|
||||
const inboundFlowing = curr.inboundBytes > prev.inboundBytes || curr.inboundPackets > prev.inboundPackets;
|
||||
const outboundFlowing = curr.outboundBytes > prev.outboundBytes || curr.outboundPackets > prev.outboundPackets;
|
||||
|
||||
if (inboundFlowing && outboundFlowing) {
|
||||
confirmedFlowing.add(index);
|
||||
}
|
||||
}
|
||||
|
||||
// Check if enough peers have been confirmed across all samples
|
||||
const connectedIndices = current
|
||||
.map((stat, idx) => stat.connectionState === 'connected' ? idx : -1)
|
||||
.filter((idx) => idx >= 0);
|
||||
const confirmedCount = connectedIndices.filter((idx) => confirmedFlowing.has(idx)).length;
|
||||
|
||||
if (confirmedCount >= expectedConnectedPeers) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
previous = current;
|
||||
}
|
||||
|
||||
throw new Error(`Timed out waiting for ${expectedConnectedPeers} peers with bidirectional audio flow`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get outbound and inbound audio RTP stats aggregated across all peer
|
||||
* connections. Uses a per-connection high water mark stored on `window` so
|
||||
|
||||
@@ -19,13 +19,65 @@ export class ChatRoomPage {
|
||||
|
||||
/** Click a voice channel by name in the channels sidebar to join voice. */
|
||||
async joinVoiceChannel(channelName: string) {
|
||||
const channelButton = this.page.locator('app-rooms-side-panel')
|
||||
.getByRole('button', { name: channelName, exact: true });
|
||||
const channelButton = this.getVoiceChannelButton(channelName);
|
||||
|
||||
if (await channelButton.count() === 0) {
|
||||
await this.refreshRoomMetadata();
|
||||
}
|
||||
|
||||
if (await channelButton.count() === 0) {
|
||||
// Second attempt - metadata might still be syncing
|
||||
await this.page.waitForTimeout(2_000);
|
||||
await this.refreshRoomMetadata();
|
||||
}
|
||||
|
||||
await expect(channelButton).toBeVisible({ timeout: 15_000 });
|
||||
await channelButton.click();
|
||||
}
|
||||
|
||||
/** Creates a voice channel if it is not already present in the current room. */
|
||||
async ensureVoiceChannelExists(channelName: string) {
|
||||
const channelButton = this.getVoiceChannelButton(channelName);
|
||||
|
||||
if (await channelButton.count() > 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
await this.refreshRoomMetadata();
|
||||
|
||||
// Wait a bit longer for Angular to render the channel list after refresh
|
||||
try {
|
||||
await expect(channelButton).toBeVisible({ timeout: 5_000 });
|
||||
return;
|
||||
} catch {
|
||||
// Channel genuinely doesn't exist - create it
|
||||
}
|
||||
|
||||
await this.openCreateVoiceChannelDialog();
|
||||
|
||||
try {
|
||||
await this.createChannel(channelName);
|
||||
} catch {
|
||||
// If the dialog didn't close (e.g. duplicate name validation), dismiss it
|
||||
const dialog = this.page.locator('app-confirm-dialog');
|
||||
|
||||
if (await dialog.isVisible()) {
|
||||
const cancelButton = dialog.getByRole('button', { name: 'Cancel' });
|
||||
const closeButton = dialog.getByRole('button', { name: 'Close dialog' });
|
||||
|
||||
if (await cancelButton.isVisible()) {
|
||||
await cancelButton.click();
|
||||
} else if (await closeButton.isVisible()) {
|
||||
await closeButton.click();
|
||||
}
|
||||
|
||||
await expect(dialog).not.toBeVisible({ timeout: 5_000 }).catch(() => {});
|
||||
}
|
||||
}
|
||||
|
||||
await expect(channelButton).toBeVisible({ timeout: 15_000 });
|
||||
}
|
||||
|
||||
/** Click a text channel by name in the channels sidebar to switch chat rooms. */
|
||||
async joinTextChannel(channelName: string) {
|
||||
const channelButton = this.getTextChannelButton(channelName);
|
||||
@@ -100,6 +152,11 @@ export class ChatRoomPage {
|
||||
return this.voiceControls.locator('button:has(ng-icon[name="lucideMic"]), button:has(ng-icon[name="lucideMicOff"])').first();
|
||||
}
|
||||
|
||||
/** Get the deafen toggle button inside voice controls. */
|
||||
get deafenButton() {
|
||||
return this.voiceControls.locator('button:has(ng-icon[name="lucideHeadphones"])').first();
|
||||
}
|
||||
|
||||
/** Get the disconnect/hang-up button (destructive styled). */
|
||||
get disconnectButton() {
|
||||
return this.voiceControls.locator('button:has(ng-icon[name="lucidePhoneOff"])').first();
|
||||
@@ -112,10 +169,9 @@ export class ChatRoomPage {
|
||||
|
||||
/** Get the count of voice users listed under a voice channel. */
|
||||
async getVoiceUserCountInChannel(channelName: string): Promise<number> {
|
||||
const channelSection = this.page.locator('app-rooms-side-panel')
|
||||
.getByRole('button', { name: channelName })
|
||||
.locator('..');
|
||||
const userAvatars = channelSection.locator('app-user-avatar');
|
||||
// The voice channel button is inside a wrapper div; user avatars are siblings within that wrapper
|
||||
const channelWrapper = this.getVoiceChannelButton(channelName).locator('xpath=ancestor::div[1]');
|
||||
const userAvatars = channelWrapper.locator('app-user-avatar');
|
||||
|
||||
return userAvatars.count();
|
||||
}
|
||||
@@ -154,9 +210,11 @@ export class ChatRoomPage {
|
||||
}
|
||||
|
||||
private getTextChannelButton(channelName: string): Locator {
|
||||
const channelPattern = new RegExp(`#\\s*${escapeRegExp(channelName)}$`, 'i');
|
||||
return this.channelsSidePanel.locator(`button[data-channel-type="text"][data-channel-name="${channelName}"]`).first();
|
||||
}
|
||||
|
||||
return this.channelsSidePanel.getByRole('button', { name: channelPattern }).first();
|
||||
private getVoiceChannelButton(channelName: string): Locator {
|
||||
return this.channelsSidePanel.locator(`button[data-channel-type="voice"][data-channel-name="${channelName}"]`).first();
|
||||
}
|
||||
|
||||
private async createTextChannelThroughComponent(channelName: string): Promise<void> {
|
||||
@@ -384,7 +442,3 @@ export class ChatRoomPage {
|
||||
await this.page.waitForTimeout(500);
|
||||
}
|
||||
}
|
||||
|
||||
function escapeRegExp(value: string): string {
|
||||
return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { type Page, type Locator } from '@playwright/test';
|
||||
|
||||
export class LoginPage {
|
||||
readonly form: Locator;
|
||||
readonly usernameInput: Locator;
|
||||
readonly passwordInput: Locator;
|
||||
readonly serverSelect: Locator;
|
||||
@@ -9,12 +10,13 @@ export class LoginPage {
|
||||
readonly registerLink: Locator;
|
||||
|
||||
constructor(private page: Page) {
|
||||
this.form = page.locator('#login-username').locator('xpath=ancestor::div[contains(@class, "space-y-3")]').first();
|
||||
this.usernameInput = page.locator('#login-username');
|
||||
this.passwordInput = page.locator('#login-password');
|
||||
this.serverSelect = page.locator('#login-server');
|
||||
this.submitButton = page.getByRole('button', { name: 'Login' });
|
||||
this.submitButton = this.form.getByRole('button', { name: 'Login' });
|
||||
this.errorText = page.locator('.text-destructive');
|
||||
this.registerLink = page.getByRole('button', { name: 'Register' });
|
||||
this.registerLink = this.form.getByRole('button', { name: 'Register' });
|
||||
}
|
||||
|
||||
async goto() {
|
||||
|
||||
@@ -43,8 +43,11 @@ export class RegisterPage {
|
||||
|
||||
async register(username: string, displayName: string, password: string) {
|
||||
await this.usernameInput.fill(username);
|
||||
await expect(this.usernameInput).toHaveValue(username);
|
||||
await this.displayNameInput.fill(displayName);
|
||||
await expect(this.displayNameInput).toHaveValue(displayName);
|
||||
await this.passwordInput.fill(password);
|
||||
await expect(this.passwordInput).toHaveValue(password);
|
||||
await this.submitButton.click();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,8 @@ import {
|
||||
export class ServerSearchPage {
|
||||
readonly searchInput: Locator;
|
||||
readonly createServerButton: Locator;
|
||||
readonly railCreateServerButton: Locator;
|
||||
readonly searchCreateServerButton: Locator;
|
||||
readonly settingsButton: Locator;
|
||||
|
||||
// Create server dialog
|
||||
@@ -20,8 +22,10 @@ export class ServerSearchPage {
|
||||
readonly dialogCancelButton: Locator;
|
||||
|
||||
constructor(private page: Page) {
|
||||
this.searchInput = page.getByPlaceholder('Search servers...');
|
||||
this.createServerButton = page.getByRole('button', { name: 'Create New Server' });
|
||||
this.searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
this.railCreateServerButton = page.locator('button[title="Create Server"]');
|
||||
this.searchCreateServerButton = page.getByRole('button', { name: 'Create New Server' });
|
||||
this.createServerButton = this.searchCreateServerButton;
|
||||
this.settingsButton = page.locator('button[title="Settings"]');
|
||||
|
||||
// Create dialog elements
|
||||
@@ -39,8 +43,20 @@ export class ServerSearchPage {
|
||||
await this.page.goto('/search');
|
||||
}
|
||||
|
||||
async createServer(name: string, options?: { description?: string; topic?: string }) {
|
||||
await this.createServerButton.click();
|
||||
async createServer(name: string, options?: { description?: string; topic?: string; sourceId?: string }) {
|
||||
if (!await this.serverNameInput.isVisible()) {
|
||||
if (await this.searchCreateServerButton.isVisible()) {
|
||||
await this.searchCreateServerButton.click();
|
||||
} else {
|
||||
await this.railCreateServerButton.click();
|
||||
|
||||
if (!await this.serverNameInput.isVisible()) {
|
||||
await expect(this.searchCreateServerButton).toBeVisible({ timeout: 10_000 });
|
||||
await this.searchCreateServerButton.click();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await expect(this.serverNameInput).toBeVisible();
|
||||
await this.serverNameInput.fill(name);
|
||||
|
||||
@@ -52,6 +68,10 @@ export class ServerSearchPage {
|
||||
await this.serverTopicInput.fill(options.topic);
|
||||
}
|
||||
|
||||
if (options?.sourceId) {
|
||||
await this.signalEndpointSelect.selectOption(options.sourceId);
|
||||
}
|
||||
|
||||
await this.dialogCreateButton.click();
|
||||
}
|
||||
|
||||
@@ -60,6 +80,11 @@ export class ServerSearchPage {
|
||||
}
|
||||
|
||||
async joinServerFromSearch(name: string) {
|
||||
await this.page.locator('button', { hasText: name }).click();
|
||||
await this.searchInput.fill(name);
|
||||
|
||||
const serverCard = this.page.locator('div[title]', { hasText: name }).first();
|
||||
|
||||
await expect(serverCard).toBeVisible({ timeout: 15_000 });
|
||||
await serverCard.dblclick();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -22,7 +22,11 @@ export default defineConfig({
|
||||
...devices['Desktop Chrome'],
|
||||
permissions: ['microphone', 'camera'],
|
||||
launchOptions: {
|
||||
args: ['--use-fake-device-for-media-stream', '--use-fake-ui-for-media-stream']
|
||||
args: [
|
||||
'--use-fake-device-for-media-stream',
|
||||
'--use-fake-ui-for-media-stream',
|
||||
'--autoplay-policy=no-user-gesture-required'
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
269
e2e/tests/auth/user-session-data-isolation.spec.ts
Normal file
269
e2e/tests/auth/user-session-data-isolation.spec.ts
Normal file
@@ -0,0 +1,269 @@
|
||||
import { mkdtemp, rm } from 'node:fs/promises';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { join } from 'node:path';
|
||||
import {
|
||||
chromium,
|
||||
type BrowserContext,
|
||||
type Page
|
||||
} from '@playwright/test';
|
||||
import { test, expect } from '../../fixtures/multi-client';
|
||||
import { installTestServerEndpoint } from '../../helpers/seed-test-endpoint';
|
||||
import { ChatMessagesPage } from '../../pages/chat-messages.page';
|
||||
import { LoginPage } from '../../pages/login.page';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
|
||||
interface TestUser {
|
||||
username: string;
|
||||
displayName: string;
|
||||
password: string;
|
||||
}
|
||||
|
||||
interface PersistentClient {
|
||||
context: BrowserContext;
|
||||
page: Page;
|
||||
userDataDir: string;
|
||||
}
|
||||
|
||||
const CLIENT_LAUNCH_ARGS = [
|
||||
'--use-fake-device-for-media-stream',
|
||||
'--use-fake-ui-for-media-stream'
|
||||
];
|
||||
|
||||
test.describe('User session data isolation', () => {
|
||||
test.describe.configure({ timeout: 240_000 });
|
||||
|
||||
test('preserves a user saved rooms and local history across app restarts', async ({ testServer }) => {
|
||||
const suffix = uniqueName('persist');
|
||||
const userDataDir = await mkdtemp(join(tmpdir(), 'metoyou-auth-persist-'));
|
||||
const alice: TestUser = {
|
||||
username: `alice_${suffix}`,
|
||||
displayName: 'Alice',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
const aliceServerName = `Alice Session Server ${suffix}`;
|
||||
const aliceMessage = `Alice persisted message ${suffix}`;
|
||||
let client: PersistentClient | null = null;
|
||||
|
||||
try {
|
||||
client = await launchPersistentClient(userDataDir, testServer.port);
|
||||
|
||||
await test.step('Alice registers and creates local chat history', async () => {
|
||||
await registerUser(client.page, alice);
|
||||
await createServerAndSendMessage(client.page, aliceServerName, aliceMessage);
|
||||
});
|
||||
|
||||
await test.step('Alice sees the same saved room and message after a full restart', async () => {
|
||||
await restartPersistentClient(client, testServer.port);
|
||||
await openApp(client.page);
|
||||
await expect(client.page).not.toHaveURL(/\/login/, { timeout: 15_000 });
|
||||
await expectSavedRoomAndHistory(client.page, aliceServerName, aliceMessage);
|
||||
});
|
||||
} finally {
|
||||
await closePersistentClient(client);
|
||||
await rm(userDataDir, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
test('gives a new user a blank slate and restores only that user local data after account switches', async ({ testServer }) => {
|
||||
const suffix = uniqueName('isolation');
|
||||
const userDataDir = await mkdtemp(join(tmpdir(), 'metoyou-auth-isolation-'));
|
||||
const alice: TestUser = {
|
||||
username: `alice_${suffix}`,
|
||||
displayName: 'Alice',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
const bob: TestUser = {
|
||||
username: `bob_${suffix}`,
|
||||
displayName: 'Bob',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
const aliceServerName = `Alice Private Server ${suffix}`;
|
||||
const bobServerName = `Bob Private Server ${suffix}`;
|
||||
const aliceMessage = `Alice history ${suffix}`;
|
||||
const bobMessage = `Bob history ${suffix}`;
|
||||
let client: PersistentClient | null = null;
|
||||
|
||||
try {
|
||||
client = await launchPersistentClient(userDataDir, testServer.port);
|
||||
|
||||
await test.step('Alice creates persisted local data and verifies it survives a restart', async () => {
|
||||
await registerUser(client.page, alice);
|
||||
await createServerAndSendMessage(client.page, aliceServerName, aliceMessage);
|
||||
|
||||
await restartPersistentClient(client, testServer.port);
|
||||
await openApp(client.page);
|
||||
await expectSavedRoomAndHistory(client.page, aliceServerName, aliceMessage);
|
||||
});
|
||||
|
||||
await test.step('Bob starts from a blank slate in the same browser profile', async () => {
|
||||
await logoutUser(client.page);
|
||||
await registerUser(client.page, bob);
|
||||
await expectBlankSlate(client.page, [aliceServerName]);
|
||||
});
|
||||
|
||||
await test.step('Bob gets only his own saved room and history after a restart', async () => {
|
||||
await createServerAndSendMessage(client.page, bobServerName, bobMessage);
|
||||
|
||||
await restartPersistentClient(client, testServer.port);
|
||||
await openApp(client.page);
|
||||
await expectSavedRoomAndHistory(client.page, bobServerName, bobMessage);
|
||||
await expectSavedRoomHidden(client.page, aliceServerName);
|
||||
});
|
||||
|
||||
await test.step('When Alice logs back in she sees only Alice local data, not Bob data', async () => {
|
||||
await logoutUser(client.page);
|
||||
await restartPersistentClient(client, testServer.port);
|
||||
await loginUser(client.page, alice);
|
||||
|
||||
await expectSavedRoomVisible(client.page, aliceServerName);
|
||||
await expectSavedRoomHidden(client.page, bobServerName);
|
||||
await expectSavedRoomAndHistory(client.page, aliceServerName, aliceMessage);
|
||||
});
|
||||
} finally {
|
||||
await closePersistentClient(client);
|
||||
await rm(userDataDir, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
async function launchPersistentClient(userDataDir: string, testServerPort: number): Promise<PersistentClient> {
|
||||
const context = await chromium.launchPersistentContext(userDataDir, {
|
||||
args: CLIENT_LAUNCH_ARGS,
|
||||
baseURL: 'http://localhost:4200',
|
||||
permissions: ['microphone', 'camera']
|
||||
});
|
||||
|
||||
await installTestServerEndpoint(context, testServerPort);
|
||||
|
||||
const page = context.pages()[0] ?? await context.newPage();
|
||||
|
||||
return {
|
||||
context,
|
||||
page,
|
||||
userDataDir
|
||||
};
|
||||
}
|
||||
|
||||
async function restartPersistentClient(client: PersistentClient, testServerPort: number): Promise<void> {
|
||||
await client.context.close();
|
||||
|
||||
const restartedClient = await launchPersistentClient(client.userDataDir, testServerPort);
|
||||
|
||||
client.context = restartedClient.context;
|
||||
client.page = restartedClient.page;
|
||||
}
|
||||
|
||||
async function closePersistentClient(client: PersistentClient | null): Promise<void> {
|
||||
if (!client) {
|
||||
return;
|
||||
}
|
||||
|
||||
await client.context.close().catch(() => {});
|
||||
}
|
||||
|
||||
async function openApp(page: Page): Promise<void> {
|
||||
await retryTransientNavigation(() => page.goto('/', { waitUntil: 'domcontentloaded' }));
|
||||
}
|
||||
|
||||
async function registerUser(page: Page, user: TestUser): Promise<void> {
|
||||
const registerPage = new RegisterPage(page);
|
||||
|
||||
await retryTransientNavigation(() => registerPage.goto());
|
||||
await registerPage.register(user.username, user.displayName, user.password);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function loginUser(page: Page, user: TestUser): Promise<void> {
|
||||
const loginPage = new LoginPage(page);
|
||||
|
||||
await retryTransientNavigation(() => loginPage.goto());
|
||||
await loginPage.login(user.username, user.password);
|
||||
await expect(page).toHaveURL(/\/(search|room)(\/|$)/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function logoutUser(page: Page): Promise<void> {
|
||||
const menuButton = page.getByRole('button', { name: 'Menu' });
|
||||
const logoutButton = page.getByRole('button', { name: 'Logout' });
|
||||
const loginPage = new LoginPage(page);
|
||||
|
||||
await expect(menuButton).toBeVisible({ timeout: 10_000 });
|
||||
await menuButton.click();
|
||||
await expect(logoutButton).toBeVisible({ timeout: 10_000 });
|
||||
await logoutButton.click();
|
||||
await expect(page).toHaveURL(/\/login/, { timeout: 15_000 });
|
||||
await expect(loginPage.usernameInput).toBeVisible({ timeout: 10_000 });
|
||||
}
|
||||
|
||||
async function createServerAndSendMessage(page: Page, serverName: string, messageText: string): Promise<void> {
|
||||
const searchPage = new ServerSearchPage(page);
|
||||
const messagesPage = new ChatMessagesPage(page);
|
||||
|
||||
await searchPage.createServer(serverName, {
|
||||
description: `User session isolation coverage for ${serverName}`
|
||||
});
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
|
||||
await messagesPage.sendMessage(messageText);
|
||||
await expect(messagesPage.getMessageItemByText(messageText)).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function expectSavedRoomAndHistory(page: Page, roomName: string, messageText: string): Promise<void> {
|
||||
const roomButton = getSavedRoomButton(page, roomName);
|
||||
const messagesPage = new ChatMessagesPage(page);
|
||||
|
||||
await expect(roomButton).toBeVisible({ timeout: 20_000 });
|
||||
await roomButton.click();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(messagesPage.getMessageItemByText(messageText)).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function expectBlankSlate(page: Page, hiddenRoomNames: string[]): Promise<void> {
|
||||
const searchPage = new ServerSearchPage(page);
|
||||
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(searchPage.createServerButton).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
for (const roomName of hiddenRoomNames) {
|
||||
await expectSavedRoomHidden(page, roomName);
|
||||
}
|
||||
}
|
||||
|
||||
async function expectSavedRoomVisible(page: Page, roomName: string): Promise<void> {
|
||||
await expect(getSavedRoomButton(page, roomName)).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function expectSavedRoomHidden(page: Page, roomName: string): Promise<void> {
|
||||
await expect(getSavedRoomButton(page, roomName)).toHaveCount(0);
|
||||
}
|
||||
|
||||
function getSavedRoomButton(page: Page, roomName: string) {
|
||||
return page.locator(`button[title="${roomName}"]`).first();
|
||||
}
|
||||
|
||||
async function retryTransientNavigation<T>(navigate: () => Promise<T>, attempts = 4): Promise<T> {
|
||||
let lastError: unknown;
|
||||
|
||||
for (let attempt = 1; attempt <= attempts; attempt += 1) {
|
||||
try {
|
||||
return await navigate();
|
||||
} catch (error) {
|
||||
lastError = error;
|
||||
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
const isTransientNavigationError = message.includes('ERR_EMPTY_RESPONSE') || message.includes('ERR_CONNECTION_RESET');
|
||||
|
||||
if (!isTransientNavigationError || attempt === attempts) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError instanceof Error
|
||||
? lastError
|
||||
: new Error(`Navigation failed after ${attempts} attempts`);
|
||||
}
|
||||
|
||||
function uniqueName(prefix: string): string {
|
||||
return `${prefix}-${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 8)}`;
|
||||
}
|
||||
@@ -18,6 +18,85 @@ const DELETED_MESSAGE_CONTENT = '[Message deleted]';
|
||||
test.describe('Chat messaging features', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('shows per-server channel lists on first saved-server click', async ({ createClient }) => {
|
||||
const scenario = await createSingleClientChatScenario(createClient);
|
||||
const alphaServerName = `Alpha Server ${uniqueName('rail')}`;
|
||||
const betaServerName = `Beta Server ${uniqueName('rail')}`;
|
||||
const alphaChannelName = uniqueName('alpha-updates');
|
||||
const betaChannelName = uniqueName('beta-plans');
|
||||
const channelsPanel = scenario.room.channelsSidePanel;
|
||||
|
||||
await test.step('Create first saved server with a unique text channel', async () => {
|
||||
await createServerAndOpenRoom(scenario.search, scenario.client.page, alphaServerName, 'Rail switch alpha server');
|
||||
await scenario.room.ensureTextChannelExists(alphaChannelName);
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${alphaChannelName}"]`)
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Create second saved server with a different text channel', async () => {
|
||||
await createServerAndOpenRoom(scenario.search, scenario.client.page, betaServerName, 'Rail switch beta server');
|
||||
await scenario.room.ensureTextChannelExists(betaChannelName);
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${betaChannelName}"]`)
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Opening first server once restores only its channels', async () => {
|
||||
await openSavedRoomByName(scenario.client.page, alphaServerName);
|
||||
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${alphaChannelName}"]`)
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${betaChannelName}"]`)
|
||||
).toHaveCount(0);
|
||||
});
|
||||
|
||||
await test.step('Opening second server once restores only its channels', async () => {
|
||||
await openSavedRoomByName(scenario.client.page, betaServerName);
|
||||
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${betaChannelName}"]`)
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
channelsPanel.locator(`button[data-channel-type="text"][data-channel-name="${alphaChannelName}"]`)
|
||||
).toHaveCount(0);
|
||||
});
|
||||
});
|
||||
|
||||
test('shows local room history on first saved-server click', async ({ createClient }) => {
|
||||
const scenario = await createSingleClientChatScenario(createClient);
|
||||
const alphaServerName = `History Alpha ${uniqueName('rail')}`;
|
||||
const betaServerName = `History Beta ${uniqueName('rail')}`;
|
||||
const alphaMessage = `Alpha history message ${uniqueName('msg')}`;
|
||||
const betaMessage = `Beta history message ${uniqueName('msg')}`;
|
||||
|
||||
await test.step('Create first server and send a local message', async () => {
|
||||
await createServerAndOpenRoom(scenario.search, scenario.client.page, alphaServerName, 'Rail history alpha server');
|
||||
await scenario.messages.sendMessage(alphaMessage);
|
||||
await expect(scenario.messages.getMessageItemByText(alphaMessage)).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Create second server and send a different local message', async () => {
|
||||
await createServerAndOpenRoom(scenario.search, scenario.client.page, betaServerName, 'Rail history beta server');
|
||||
await scenario.messages.sendMessage(betaMessage);
|
||||
await expect(scenario.messages.getMessageItemByText(betaMessage)).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Opening first server once restores its history immediately', async () => {
|
||||
await openSavedRoomByName(scenario.client.page, alphaServerName);
|
||||
await expect(scenario.messages.getMessageItemByText(alphaMessage)).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Opening second server once restores its history immediately', async () => {
|
||||
await openSavedRoomByName(scenario.client.page, betaServerName);
|
||||
await expect(scenario.messages.getMessageItemByText(betaMessage)).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
});
|
||||
|
||||
test('syncs messages in a newly created text channel', async ({ createClient }) => {
|
||||
const scenario = await createChatScenario(createClient);
|
||||
const channelName = uniqueName('updates');
|
||||
@@ -143,6 +222,43 @@ interface ChatScenario {
|
||||
bobMessages: ChatMessagesPage;
|
||||
}
|
||||
|
||||
interface SingleClientChatScenario {
|
||||
client: Client;
|
||||
messages: ChatMessagesPage;
|
||||
room: ChatRoomPage;
|
||||
search: ServerSearchPage;
|
||||
}
|
||||
|
||||
async function createSingleClientChatScenario(createClient: () => Promise<Client>): Promise<SingleClientChatScenario> {
|
||||
const suffix = uniqueName('solo');
|
||||
const client = await createClient();
|
||||
const credentials = {
|
||||
username: `solo_${suffix}`,
|
||||
displayName: 'Solo',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
|
||||
await installChatFeatureMocks(client.page);
|
||||
|
||||
const registerPage = new RegisterPage(client.page);
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(
|
||||
credentials.username,
|
||||
credentials.displayName,
|
||||
credentials.password
|
||||
);
|
||||
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
|
||||
return {
|
||||
client,
|
||||
messages: new ChatMessagesPage(client.page),
|
||||
room: new ChatRoomPage(client.page),
|
||||
search: new ServerSearchPage(client.page)
|
||||
};
|
||||
}
|
||||
|
||||
async function createChatScenario(createClient: () => Promise<Client>): Promise<ChatScenario> {
|
||||
const suffix = uniqueName('chat');
|
||||
const serverName = `Chat Server ${suffix}`;
|
||||
@@ -192,11 +308,8 @@ async function createChatScenario(createClient: () => Promise<Client>): Promise<
|
||||
await expect(alice.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
|
||||
const bobSearchPage = new ServerSearchPage(bob.page);
|
||||
const serverCard = bob.page.locator('button', { hasText: serverName }).first();
|
||||
|
||||
await bobSearchPage.searchInput.fill(serverName);
|
||||
await expect(serverCard).toBeVisible({ timeout: 15_000 });
|
||||
await serverCard.click();
|
||||
await bobSearchPage.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
@@ -217,6 +330,52 @@ async function createChatScenario(createClient: () => Promise<Client>): Promise<
|
||||
};
|
||||
}
|
||||
|
||||
async function createServerAndOpenRoom(
|
||||
searchPage: ServerSearchPage,
|
||||
page: Page,
|
||||
serverName: string,
|
||||
description: string
|
||||
): Promise<void> {
|
||||
await searchPage.createServer(serverName, { description });
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
await waitForCurrentRoomName(page, serverName);
|
||||
}
|
||||
|
||||
async function openSavedRoomByName(page: Page, roomName: string): Promise<void> {
|
||||
const roomButton = page.locator(`button[title="${roomName}"]`);
|
||||
|
||||
await expect(roomButton).toBeVisible({ timeout: 20_000 });
|
||||
await roomButton.click();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
await waitForCurrentRoomName(page, roomName);
|
||||
}
|
||||
|
||||
async function waitForCurrentRoomName(page: Page, roomName: string, timeout = 20_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(expectedRoomName) => {
|
||||
interface RoomShape { name?: string }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
|
||||
return currentRoom?.name === expectedRoomName;
|
||||
},
|
||||
roomName,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
async function installChatFeatureMocks(page: Page): Promise<void> {
|
||||
await page.route('**/api/klipy/config', async (route) => {
|
||||
await route.fulfill({
|
||||
|
||||
116
e2e/tests/chat/dm-flow.spec.ts
Normal file
116
e2e/tests/chat/dm-flow.spec.ts
Normal file
@@ -0,0 +1,116 @@
|
||||
import { type Page } from '@playwright/test';
|
||||
import {
|
||||
test,
|
||||
expect,
|
||||
type Client
|
||||
} from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatMessagesPage } from '../../pages/chat-messages.page';
|
||||
import { disableLastViewedChatResume } from '../../helpers/seed-test-endpoint';
|
||||
|
||||
test.describe('Direct message flow', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('opens a DM from a user card and queues messages while offline', async ({ createClient }) => {
|
||||
const scenario = await createDmScenario(createClient);
|
||||
const offlineMessage = `Offline DM ${uniqueName('msg')}`;
|
||||
|
||||
await test.step('Alice opens Bob from the room user list', async () => {
|
||||
const bobUserCard = scenario.alice.page.locator('[data-testid^="room-user-card-"]', { hasText: 'Bob' }).first();
|
||||
|
||||
await expect(bobUserCard).toBeVisible({ timeout: 20_000 });
|
||||
await bobUserCard.getByRole('button', { name: 'Message Bob' }).click();
|
||||
await expect(scenario.alice.page).toHaveURL(/\/dm\//, { timeout: 15_000 });
|
||||
await expect(scenario.alice.page.getByRole('heading', { name: 'Bob' })).toBeVisible({ timeout: 10_000 });
|
||||
});
|
||||
|
||||
await test.step('Offline send persists locally as queued', async () => {
|
||||
await scenario.alice.page.evaluate(() => window.simulateOffline?.());
|
||||
await scenario.alice.page.getByTestId('dm-input').fill(offlineMessage);
|
||||
await scenario.alice.page.getByTestId('dm-input').press('Enter');
|
||||
|
||||
await expect(scenario.alice.page.locator('app-dm-chat').getByText(offlineMessage)).toBeVisible({ timeout: 10_000 });
|
||||
await expect(scenario.alice.page.getByTestId('message-status').last()).toContainText('QUEUED');
|
||||
});
|
||||
});
|
||||
|
||||
test('shows friend and message actions on the search people list', async ({ createClient }) => {
|
||||
const scenario = await createDmScenario(createClient);
|
||||
|
||||
await disableLastViewedChatResume(scenario.alice.page);
|
||||
await scenario.alice.page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await expect(scenario.alice.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(scenario.alice.page.locator('app-server-search')).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.alice.page.locator('app-user-search-list')).toBeVisible({ timeout: 20_000 });
|
||||
const bobPeopleCard = scenario.alice.page
|
||||
.locator('app-user-search-list [data-testid$="-' + scenario.bobUserId + '"]', { hasText: 'Bob' })
|
||||
.first();
|
||||
|
||||
await expect(bobPeopleCard).toBeVisible({ timeout: 15_000 });
|
||||
const friendButton = bobPeopleCard.locator(`[data-testid="friend-button-${scenario.bobUserId}"]`);
|
||||
const messageButton = bobPeopleCard.getByRole('button', { name: 'Message Bob' });
|
||||
|
||||
await expect(friendButton).toBeAttached({ timeout: 15_000 });
|
||||
await expect(messageButton).toBeAttached({ timeout: 15_000 });
|
||||
});
|
||||
});
|
||||
|
||||
interface DmScenario {
|
||||
alice: Client;
|
||||
bob: Client;
|
||||
bobUserId: string;
|
||||
aliceSearch: ServerSearchPage;
|
||||
}
|
||||
|
||||
async function createDmScenario(createClient: () => Promise<Client>): Promise<DmScenario> {
|
||||
const suffix = uniqueName('dm');
|
||||
const serverName = `DM Server ${suffix}`;
|
||||
const alice = await createClient();
|
||||
const bob = await createClient();
|
||||
|
||||
await registerUser(alice.page, `alice_${suffix}`, 'Alice');
|
||||
await registerUser(bob.page, `bob_${suffix}`, 'Bob');
|
||||
|
||||
const aliceSearch = new ServerSearchPage(alice.page);
|
||||
|
||||
await aliceSearch.createServer(serverName, { description: 'E2E direct message discovery server' });
|
||||
await expect(alice.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
await new ChatMessagesPage(alice.page).waitForReady();
|
||||
|
||||
const bobSearch = new ServerSearchPage(bob.page);
|
||||
|
||||
await bobSearch.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
await new ChatMessagesPage(bob.page).waitForReady();
|
||||
const bobRoomCard = alice.page.locator('[data-testid^="room-user-card-"]', { hasText: 'Bob' }).first();
|
||||
|
||||
await expect(bobRoomCard).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
const bobUserCardTestId = await bobRoomCard.getAttribute('data-testid');
|
||||
const bobUserId = bobUserCardTestId?.replace('room-user-card-', '');
|
||||
|
||||
if (!bobUserId) {
|
||||
throw new Error('Expected Bob room user card to expose a stable test id.');
|
||||
}
|
||||
|
||||
return {
|
||||
alice,
|
||||
bob,
|
||||
bobUserId,
|
||||
aliceSearch
|
||||
};
|
||||
}
|
||||
|
||||
async function registerUser(page: Page, username: string, displayName: string): Promise<void> {
|
||||
const registerPage = new RegisterPage(page);
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, 'TestPass123!');
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
function uniqueName(prefix: string): string {
|
||||
return `${prefix}-${Date.now()}-${Math.random().toString(36)
|
||||
.slice(2, 8)}`;
|
||||
}
|
||||
260
e2e/tests/chat/notifications.spec.ts
Normal file
260
e2e/tests/chat/notifications.spec.ts
Normal file
@@ -0,0 +1,260 @@
|
||||
import {
|
||||
expect,
|
||||
type Locator,
|
||||
type Page
|
||||
} from '@playwright/test';
|
||||
import { test, type Client } from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
import { ChatMessagesPage } from '../../pages/chat-messages.page';
|
||||
|
||||
interface DesktopNotificationRecord {
|
||||
title: string;
|
||||
body: string;
|
||||
}
|
||||
|
||||
interface NotificationScenario {
|
||||
alice: Client;
|
||||
bob: Client;
|
||||
aliceRoom: ChatRoomPage;
|
||||
bobRoom: ChatRoomPage;
|
||||
bobMessages: ChatMessagesPage;
|
||||
serverName: string;
|
||||
channelName: string;
|
||||
}
|
||||
|
||||
test.describe('Chat notifications', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('shows desktop notifications and unread badges for inactive channels', async ({ createClient }) => {
|
||||
const scenario = await createNotificationScenario(createClient);
|
||||
const message = `Background notification ${uniqueName('msg')}`;
|
||||
|
||||
await test.step('Bob sends a message to Alice\'s inactive channel', async () => {
|
||||
await clearDesktopNotifications(scenario.alice.page);
|
||||
await scenario.bobRoom.joinTextChannel(scenario.channelName);
|
||||
await scenario.bobMessages.sendMessage(message);
|
||||
});
|
||||
|
||||
await test.step('Alice receives a desktop notification with the channel preview', async () => {
|
||||
const notification = await waitForDesktopNotification(scenario.alice.page);
|
||||
|
||||
expect(notification).toEqual({
|
||||
title: `${scenario.serverName} · #${scenario.channelName}`,
|
||||
body: `Bob: ${message}`
|
||||
});
|
||||
});
|
||||
|
||||
await test.step('Alice sees unread badges for the room and the inactive channel', async () => {
|
||||
await expect(getUnreadBadge(getSavedRoomButton(scenario.alice.page, scenario.serverName))).toHaveText('1', { timeout: 20_000 });
|
||||
await expect(getUnreadBadge(getTextChannelButton(scenario.alice.page, scenario.channelName))).toHaveText('1', { timeout: 20_000 });
|
||||
});
|
||||
});
|
||||
|
||||
test('keeps unread badges visible when a muted channel suppresses desktop popups', async ({ createClient }) => {
|
||||
const scenario = await createNotificationScenario(createClient);
|
||||
const message = `Muted notification ${uniqueName('msg')}`;
|
||||
|
||||
await test.step('Alice mutes the inactive text channel', async () => {
|
||||
await muteTextChannel(scenario.alice.page, scenario.channelName);
|
||||
await clearDesktopNotifications(scenario.alice.page);
|
||||
});
|
||||
|
||||
await test.step('Bob sends a message into the muted channel', async () => {
|
||||
await scenario.bobRoom.joinTextChannel(scenario.channelName);
|
||||
await scenario.bobMessages.sendMessage(message);
|
||||
});
|
||||
|
||||
await test.step('Alice still sees unread badges for the room and channel', async () => {
|
||||
await expect(getUnreadBadge(getSavedRoomButton(scenario.alice.page, scenario.serverName))).toHaveText('1', { timeout: 20_000 });
|
||||
await expect(getUnreadBadge(getTextChannelButton(scenario.alice.page, scenario.channelName))).toHaveText('1', { timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Alice does not get a muted desktop popup', async () => {
|
||||
const notificationAppeared = await waitForAnyDesktopNotification(scenario.alice.page, 1_500);
|
||||
|
||||
expect(notificationAppeared).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
async function createNotificationScenario(createClient: () => Promise<Client>): Promise<NotificationScenario> {
|
||||
const suffix = uniqueName('notify');
|
||||
const serverName = `Notifications Server ${suffix}`;
|
||||
const channelName = uniqueName('updates');
|
||||
const aliceCredentials = {
|
||||
username: `alice_${suffix}`,
|
||||
displayName: 'Alice',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
const bobCredentials = {
|
||||
username: `bob_${suffix}`,
|
||||
displayName: 'Bob',
|
||||
password: 'TestPass123!'
|
||||
};
|
||||
const alice = await createClient();
|
||||
const bob = await createClient();
|
||||
|
||||
await installDesktopNotificationSpy(alice.page);
|
||||
|
||||
await registerUser(alice.page, aliceCredentials.username, aliceCredentials.displayName, aliceCredentials.password);
|
||||
await registerUser(bob.page, bobCredentials.username, bobCredentials.displayName, bobCredentials.password);
|
||||
|
||||
const aliceSearch = new ServerSearchPage(alice.page);
|
||||
|
||||
await aliceSearch.createServer(serverName, {
|
||||
description: 'E2E notification coverage server'
|
||||
});
|
||||
|
||||
await expect(alice.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
|
||||
const bobSearch = new ServerSearchPage(bob.page);
|
||||
|
||||
await bobSearch.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
const aliceMessages = new ChatMessagesPage(alice.page);
|
||||
const bobMessages = new ChatMessagesPage(bob.page);
|
||||
|
||||
await aliceMessages.waitForReady();
|
||||
await bobMessages.waitForReady();
|
||||
await aliceRoom.ensureTextChannelExists(channelName);
|
||||
await expect(getTextChannelButton(alice.page, channelName)).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
return {
|
||||
alice,
|
||||
bob,
|
||||
aliceRoom,
|
||||
bobRoom,
|
||||
bobMessages,
|
||||
serverName,
|
||||
channelName
|
||||
};
|
||||
}
|
||||
|
||||
async function registerUser(page: Page, username: string, displayName: string, password: string): Promise<void> {
|
||||
const registerPage = new RegisterPage(page);
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, password);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function installDesktopNotificationSpy(page: Page): Promise<void> {
|
||||
await page.addInitScript(() => {
|
||||
const notifications: DesktopNotificationRecord[] = [];
|
||||
|
||||
class MockNotification {
|
||||
static permission = 'granted';
|
||||
|
||||
onclick: (() => void) | null = null;
|
||||
|
||||
constructor(title: string, options?: NotificationOptions) {
|
||||
notifications.push({
|
||||
title,
|
||||
body: options?.body ?? ''
|
||||
});
|
||||
}
|
||||
|
||||
static async requestPermission(): Promise<NotificationPermission> {
|
||||
return 'granted';
|
||||
}
|
||||
|
||||
close(): void {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
Object.defineProperty(window, '__desktopNotifications', {
|
||||
value: notifications,
|
||||
configurable: true
|
||||
});
|
||||
|
||||
Object.defineProperty(window, 'Notification', {
|
||||
value: MockNotification,
|
||||
configurable: true,
|
||||
writable: true
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async function clearDesktopNotifications(page: Page): Promise<void> {
|
||||
await page.evaluate(() => {
|
||||
(window as WindowWithDesktopNotifications).__desktopNotifications.length = 0;
|
||||
});
|
||||
}
|
||||
|
||||
async function waitForDesktopNotification(page: Page): Promise<DesktopNotificationRecord> {
|
||||
await expect.poll(
|
||||
async () => (await readDesktopNotifications(page)).length,
|
||||
{
|
||||
timeout: 20_000,
|
||||
message: 'Expected a desktop notification to be emitted'
|
||||
}
|
||||
).toBeGreaterThan(0);
|
||||
|
||||
const notifications = await readDesktopNotifications(page);
|
||||
|
||||
return notifications[notifications.length - 1];
|
||||
}
|
||||
|
||||
async function waitForAnyDesktopNotification(page: Page, timeout: number): Promise<boolean> {
|
||||
try {
|
||||
await page.waitForFunction(
|
||||
() => (window as WindowWithDesktopNotifications).__desktopNotifications.length > 0,
|
||||
undefined,
|
||||
{ timeout }
|
||||
);
|
||||
|
||||
return true;
|
||||
} catch (error) {
|
||||
if (error instanceof Error && error.name === 'TimeoutError') {
|
||||
return false;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
async function readDesktopNotifications(page: Page): Promise<DesktopNotificationRecord[]> {
|
||||
return page.evaluate(() => {
|
||||
return [...(window as WindowWithDesktopNotifications).__desktopNotifications];
|
||||
});
|
||||
}
|
||||
|
||||
async function muteTextChannel(page: Page, channelName: string): Promise<void> {
|
||||
const channelButton = getTextChannelButton(page, channelName);
|
||||
const contextMenu = page.locator('app-context-menu');
|
||||
|
||||
await expect(channelButton).toBeVisible({ timeout: 20_000 });
|
||||
await channelButton.click({ button: 'right' });
|
||||
await expect(contextMenu.getByRole('button', { name: 'Mute Notifications' })).toBeVisible({ timeout: 10_000 });
|
||||
await contextMenu.getByRole('button', { name: 'Mute Notifications' }).click();
|
||||
await expect(contextMenu).toHaveCount(0);
|
||||
}
|
||||
|
||||
function getSavedRoomButton(page: Page, roomName: string): Locator {
|
||||
return page.locator(`button[title="${roomName}"]`).first();
|
||||
}
|
||||
|
||||
function getTextChannelButton(page: Page, channelName: string): Locator {
|
||||
return page.locator('app-rooms-side-panel').first()
|
||||
.locator(`button[data-channel-type="text"][data-channel-name="${channelName}"]`)
|
||||
.first();
|
||||
}
|
||||
|
||||
function getUnreadBadge(container: Locator): Locator {
|
||||
return container.locator('span.rounded-full').first();
|
||||
}
|
||||
|
||||
function uniqueName(prefix: string): string {
|
||||
return `${prefix}-${Date.now()}-${Math.random().toString(36)
|
||||
.slice(2, 8)}`;
|
||||
}
|
||||
|
||||
interface WindowWithDesktopNotifications extends Window {
|
||||
__desktopNotifications: DesktopNotificationRecord[];
|
||||
}
|
||||
@@ -69,6 +69,7 @@ const NETSCAPE_LOOP_EXTENSION = Buffer.from([
|
||||
]);
|
||||
const CLIENT_LAUNCH_ARGS = ['--use-fake-device-for-media-stream', '--use-fake-ui-for-media-stream'];
|
||||
const VOICE_CHANNEL = 'General';
|
||||
const AVATAR_SYNC_TIMEOUT_MS = 45_000;
|
||||
|
||||
test.describe('Profile avatar sync', () => {
|
||||
test.describe.configure({ timeout: 240_000 });
|
||||
@@ -384,11 +385,8 @@ async function registerUser(client: PersistentClient): Promise<void> {
|
||||
|
||||
async function joinServerFromSearch(page: Page, serverName: string): Promise<void> {
|
||||
const searchPage = new ServerSearchPage(page);
|
||||
const serverCard = page.locator('button', { hasText: serverName }).first();
|
||||
|
||||
await searchPage.searchInput.fill(serverName);
|
||||
await expect(serverCard).toBeVisible({ timeout: 15_000 });
|
||||
await serverCard.click();
|
||||
await searchPage.joinServerFromSearch(serverName);
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
@@ -601,7 +599,7 @@ async function expectSidebarAvatar(page: Page, displayName: string, expectedData
|
||||
|
||||
return image.getAttribute('src');
|
||||
}, {
|
||||
timeout: 20_000,
|
||||
timeout: AVATAR_SYNC_TIMEOUT_MS,
|
||||
message: `${displayName} avatar src should update`
|
||||
}).toBe(expectedDataUrl);
|
||||
|
||||
@@ -618,7 +616,7 @@ async function expectSidebarAvatar(page: Page, displayName: string, expectedData
|
||||
return img.complete && img.naturalWidth > 0 && img.naturalHeight > 0;
|
||||
});
|
||||
}, {
|
||||
timeout: 20_000,
|
||||
timeout: AVATAR_SYNC_TIMEOUT_MS,
|
||||
message: `${displayName} avatar image should load`
|
||||
}).toBe(true);
|
||||
}
|
||||
@@ -638,7 +636,7 @@ async function expectChatMessageAvatar(page: Page, messageText: string, expected
|
||||
|
||||
return image.getAttribute('src');
|
||||
}, {
|
||||
timeout: 20_000,
|
||||
timeout: AVATAR_SYNC_TIMEOUT_MS,
|
||||
message: `Chat message avatar for "${messageText}" should update`
|
||||
}).toBe(expectedDataUrl);
|
||||
}
|
||||
@@ -665,7 +663,7 @@ async function expectVoiceControlsAvatar(page: Page, expectedDataUrl: string): P
|
||||
|
||||
return image.getAttribute('src');
|
||||
}, {
|
||||
timeout: 20_000,
|
||||
timeout: AVATAR_SYNC_TIMEOUT_MS,
|
||||
message: 'Voice controls avatar should update'
|
||||
}).toBe(expectedDataUrl);
|
||||
}
|
||||
|
||||
185
e2e/tests/plugins/plugin-api-two-users.spec.ts
Normal file
185
e2e/tests/plugins/plugin-api-two-users.spec.ts
Normal file
@@ -0,0 +1,185 @@
|
||||
import { type Page } from '@playwright/test';
|
||||
import {
|
||||
expect,
|
||||
test,
|
||||
type Client
|
||||
} from '../../fixtures/multi-client';
|
||||
import { ChatMessagesPage } from '../../pages/chat-messages.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
|
||||
const PLUGIN_SOURCE_URL = 'http://localhost:4200/plugins/e2e-plugin-source.json';
|
||||
const PLUGIN_TITLE = 'E2E All API Plugin';
|
||||
const EDITED_MESSAGE = 'Plugin API edited message';
|
||||
const ORIGINAL_MESSAGE = 'Plugin API original message';
|
||||
const DELETED_MESSAGE = 'Plugin API deleted message';
|
||||
const DELETED_MESSAGE_CONTENT = '[Message deleted]';
|
||||
const PLUGIN_BOT_MESSAGE = 'Plugin bot message from all-api fixture';
|
||||
const CUSTOM_EMBED_TEXT = 'E2E custom embed: Plugin API custom embed';
|
||||
const SOUND_BOARD_TEXT = 'E2E soundboard ready';
|
||||
const SOUND_BOARD_LABEL = 'E2E Soundboard';
|
||||
const SOUND_BOARD_PLAYED_MESSAGE = 'E2E soundboard played Airhorn to voice channel';
|
||||
const VOICE_CHANNEL = 'Plugin Voice';
|
||||
|
||||
test.describe('Plugin API multi-user runtime', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('runs chat, embed, soundboard, and profile APIs between two users', async ({ createClient }) => {
|
||||
const scenario = await createPluginApiScenario(createClient);
|
||||
|
||||
await test.step('Install the server plugin as Alice', async () => {
|
||||
await installGrantAndActivatePlugin(scenario.alice.page, true);
|
||||
await closeSettingsModal(scenario.alice.page);
|
||||
await expect(soundboardComposerButton(scenario.alice.page)).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.alice.page.getByText(SOUND_BOARD_TEXT, { exact: true })).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.alice.page.getByTestId('e2e-plugin-owned-dom')).toHaveAttribute('data-plugin-owner', 'e2e.all-api-plugin');
|
||||
});
|
||||
|
||||
await test.step('Activate the server plugin for Bob as the embed/soundboard receiver', async () => {
|
||||
await installGrantAndActivatePlugin(scenario.bob.page, false);
|
||||
await closeSettingsModal(scenario.bob.page);
|
||||
await expect(soundboardComposerButton(scenario.bob.page)).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.bob.page.getByText(SOUND_BOARD_TEXT, { exact: true })).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.bob.page.getByTestId('e2e-plugin-owned-dom')).toHaveAttribute('data-plugin-owner', 'e2e.all-api-plugin');
|
||||
});
|
||||
|
||||
await test.step('Alice opens the plugin soundboard modal and plays a sound to voice', async () => {
|
||||
await soundboardComposerButton(scenario.alice.page).click();
|
||||
await expect(scenario.alice.page.getByRole('dialog', { name: SOUND_BOARD_LABEL })).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.alice.page.getByTestId('e2e-soundboard-modal')).toHaveAttribute('data-plugin-owner', 'e2e.all-api-plugin');
|
||||
await scenario.alice.page.getByRole('button', { name: 'Play airhorn to voice' }).click();
|
||||
await expect(scenario.alice.page.getByTestId('e2e-soundboard-status')).toHaveText(SOUND_BOARD_PLAYED_MESSAGE, { timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob receives messages sent and edited by Alice through the plugin API', async () => {
|
||||
await expect(scenario.bobMessages.getMessageItemByText(EDITED_MESSAGE)).toBeVisible({ timeout: 30_000 });
|
||||
await expect(scenario.bobMessages.getMessageItemByText(ORIGINAL_MESSAGE)).toHaveCount(0);
|
||||
await expect(scenario.bob.page.getByText('(edited)')).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob sees plugin API deletion state and plugin-user messages', async () => {
|
||||
await expect(scenario.bobMessages.getMessageItemByText(DELETED_MESSAGE_CONTENT)).toBeVisible({ timeout: 30_000 });
|
||||
await expect(scenario.bobMessages.getMessageItemByText(DELETED_MESSAGE)).toHaveCount(0);
|
||||
await expect(scenario.bobMessages.getMessageItemByText(PLUGIN_BOT_MESSAGE)).toBeVisible({ timeout: 30_000 });
|
||||
await expect(scenario.bobMessages.getMessageItemByText(SOUND_BOARD_PLAYED_MESSAGE)).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob renders Alice custom embed through the plugin embed API', async () => {
|
||||
await expect(scenario.bob.page.getByTestId('plugin-message-embeds')).toContainText(CUSTOM_EMBED_TEXT, { timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob sees Alice profile name changed by the plugin API', async () => {
|
||||
await expect(scenario.bobMessages.getMessageItemByText(EDITED_MESSAGE)).toContainText('Alice Plugin Renamed', { timeout: 30_000 });
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
interface PluginApiScenario {
|
||||
alice: Client;
|
||||
aliceRoom: ChatRoomPage;
|
||||
bob: Client;
|
||||
bobRoom: ChatRoomPage;
|
||||
aliceMessages: ChatMessagesPage;
|
||||
bobMessages: ChatMessagesPage;
|
||||
}
|
||||
|
||||
async function createPluginApiScenario(createClient: () => Promise<Client>): Promise<PluginApiScenario> {
|
||||
const suffix = uniqueName('plugin-api');
|
||||
const serverName = `Plugin API Server ${suffix}`;
|
||||
const alice = await createClient();
|
||||
const bob = await createClient();
|
||||
|
||||
await registerUser(alice.page, `alice_${suffix}`, 'Alice');
|
||||
await registerUser(bob.page, `bob_${suffix}`, 'Bob');
|
||||
|
||||
const aliceSearch = new ServerSearchPage(alice.page);
|
||||
|
||||
await aliceSearch.createServer(serverName, { description: 'Two-user plugin API E2E coverage' });
|
||||
await expect(alice.page).toHaveURL(/\/room\//, { timeout: 30_000 });
|
||||
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
|
||||
await aliceRoom.ensureVoiceChannelExists(VOICE_CHANNEL);
|
||||
|
||||
const bobSearch = new ServerSearchPage(bob.page);
|
||||
|
||||
await bobSearch.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 30_000 });
|
||||
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
|
||||
await aliceRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await bobRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(aliceRoom.voiceControls).toBeVisible({ timeout: 30_000 });
|
||||
await expect(bobRoom.voiceControls).toBeVisible({ timeout: 30_000 });
|
||||
|
||||
const aliceMessages = new ChatMessagesPage(alice.page);
|
||||
const bobMessages = new ChatMessagesPage(bob.page);
|
||||
|
||||
await aliceMessages.waitForReady();
|
||||
await bobMessages.waitForReady();
|
||||
await expect(alice.page.locator('[data-testid^="room-user-card-"]', { hasText: 'Bob' })).toBeVisible({ timeout: 30_000 });
|
||||
await expect(bob.page.locator('[data-testid^="room-user-card-"]', { hasText: 'Alice' })).toBeVisible({ timeout: 30_000 });
|
||||
|
||||
return {
|
||||
alice,
|
||||
aliceRoom,
|
||||
bob,
|
||||
bobRoom,
|
||||
aliceMessages,
|
||||
bobMessages
|
||||
};
|
||||
}
|
||||
|
||||
async function registerUser(page: Page, username: string, displayName: string): Promise<void> {
|
||||
const registerPage = new RegisterPage(page);
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, 'TestPass123!');
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 30_000 });
|
||||
}
|
||||
|
||||
async function installGrantAndActivatePlugin(page: Page, installFromStore: boolean): Promise<void> {
|
||||
await page.getByRole('button', { name: 'Plugins' }).click();
|
||||
await expect(page).toHaveURL(/\/plugin-store/, { timeout: 20_000 });
|
||||
await expect(page.getByTestId('plugin-store-page')).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
if (installFromStore) {
|
||||
await page.getByLabel('Plugin source manifest URL').fill(PLUGIN_SOURCE_URL);
|
||||
await page.getByRole('button', { name: 'Add Source' }).click();
|
||||
await expect(page.getByRole('heading', { name: PLUGIN_TITLE })).toBeVisible({ timeout: 20_000 });
|
||||
await page.getByRole('button', { exact: true, name: /^(Install|Install to Server)$/ }).click();
|
||||
await expect(page.getByRole('dialog', { name: PLUGIN_TITLE })).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { name: 'Install and Activate' }).click();
|
||||
await expect(page.locator('article', { hasText: PLUGIN_TITLE }).getByText('Installed')).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
await page.getByRole('button', { name: 'Manage Plugins' }).click();
|
||||
await expect(page.getByTestId('plugin-manager')).toBeVisible({ timeout: 20_000 });
|
||||
await expect(page.locator('article', { hasText: PLUGIN_TITLE })).toBeVisible({ timeout: 20_000 });
|
||||
await page.locator('article', { hasText: PLUGIN_TITLE })
|
||||
.getByRole('button', { name: 'Select' })
|
||||
.click();
|
||||
|
||||
await page.getByRole('button', { name: 'Grant all requested' }).click();
|
||||
await page.getByRole('button', { name: 'Activate ready plugins' }).click();
|
||||
await expect(page.locator('article', { hasText: PLUGIN_TITLE }).getByText('ready', { exact: true })).toBeVisible({ timeout: 30_000 });
|
||||
await page.getByRole('button', { name: 'Logs' }).click();
|
||||
await expect(page.getByText('all-api plugin completed')).toBeVisible({ timeout: 30_000 });
|
||||
}
|
||||
|
||||
async function closeSettingsModal(page: Page): Promise<void> {
|
||||
await page.keyboard.press('Escape');
|
||||
await expect(page.getByTestId('plugin-manager')).toHaveCount(0);
|
||||
}
|
||||
|
||||
function uniqueName(prefix: string): string {
|
||||
return `${prefix}-${Date.now()}-${Math.random().toString(36)
|
||||
.slice(2, 8)}`;
|
||||
}
|
||||
|
||||
function soundboardComposerButton(page: Page) {
|
||||
return page.locator('app-chat-message-composer')
|
||||
.getByRole('button', { exact: true, name: SOUND_BOARD_LABEL });
|
||||
}
|
||||
93
e2e/tests/plugins/plugin-manager-ui.spec.ts
Normal file
93
e2e/tests/plugins/plugin-manager-ui.spec.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
import { expect, test } from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
|
||||
test.describe('Plugin manager UI', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('installs, grants, activates, and logs an all-API test plugin', async ({ createClient }) => {
|
||||
const client = await createClient();
|
||||
const { page } = client;
|
||||
const suffix = Date.now();
|
||||
const register = new RegisterPage(page);
|
||||
const search = new ServerSearchPage(page);
|
||||
|
||||
await test.step('Register user and create server context', async () => {
|
||||
await register.goto();
|
||||
await register.register(`plugin_${suffix}`, 'Plugin Tester', 'TestPass123!');
|
||||
await expect(page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await search.createServer(`Plugin API Server ${suffix}`, {
|
||||
description: 'Plugin manager UI E2E coverage'
|
||||
});
|
||||
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Open visible Plugins button', async () => {
|
||||
await page.getByRole('button', { name: 'Plugins' }).click();
|
||||
await expect(page).toHaveURL(/\/plugin-store/, { timeout: 10_000 });
|
||||
await expect(page.getByTestId('plugin-store-page')).toBeVisible({ timeout: 10_000 });
|
||||
});
|
||||
|
||||
await test.step('Install fixture plugin from source manifest', async () => {
|
||||
await page.getByLabel('Plugin source manifest URL').fill('http://localhost:4200/plugins/e2e-plugin-source.json');
|
||||
await page.getByRole('button', { name: 'Add Source' }).click();
|
||||
await expect(page.getByRole('heading', { name: 'E2E All API Plugin' })).toBeVisible({ timeout: 15_000 });
|
||||
await page.getByRole('button', { name: 'Readme' }).click();
|
||||
await expect(page.getByText('Fixture plugin for Playwright coverage.')).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { exact: true, name: /^(Install|Install to Server)$/ }).click();
|
||||
const installDialog = page.getByRole('dialog', { name: 'E2E All API Plugin' });
|
||||
|
||||
await expect(installDialog).toBeVisible({ timeout: 10_000 });
|
||||
await expect(installDialog.getByText('Install to server', { exact: true })).toBeVisible();
|
||||
await page.getByRole('button', { name: 'Install and Activate' }).click();
|
||||
await expect(page.locator('article', { hasText: 'E2E All API Plugin' }).getByText('Installed')).toBeVisible({ timeout: 10_000 });
|
||||
});
|
||||
|
||||
await test.step('Open plugin manager from the store page', async () => {
|
||||
await page.getByRole('button', { name: 'Manage Plugins' }).click();
|
||||
await expect(page.getByTestId('plugin-manager')).toBeVisible({ timeout: 10_000 });
|
||||
await expect(page.getByTestId('plugin-manager').getByRole('heading', { name: 'Server plugins' })).toBeVisible();
|
||||
await expect(page.getByText('E2E All API Plugin')).toBeVisible();
|
||||
});
|
||||
|
||||
await test.step('Grant capabilities and activate runtime', async () => {
|
||||
const manager = page.getByTestId('plugin-manager');
|
||||
const pluginCard = manager.locator('article', { hasText: 'E2E All API Plugin' });
|
||||
|
||||
await manager.getByRole('button', { name: 'Installed' }).click();
|
||||
await expect(pluginCard).toBeVisible({ timeout: 10_000 });
|
||||
await pluginCard.getByRole('button', { name: 'Select' }).click();
|
||||
|
||||
await page.getByRole('button', { name: 'Grant all requested' }).click();
|
||||
await page.getByRole('button', { name: 'Activate ready plugins' }).click();
|
||||
await expect(page.locator('article', { hasText: 'E2E All API Plugin' }).getByText('ready', { exact: true })).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Verify plugin exercised APIs through logs and extension points', async () => {
|
||||
const manager = page.getByTestId('plugin-manager');
|
||||
|
||||
await manager.getByRole('button', { name: 'Logs' }).click();
|
||||
await expect(page.getByText('all-api plugin completed')).toBeVisible({ timeout: 20_000 });
|
||||
await expect(page.getByText('all-api plugin ready')).toBeVisible({ timeout: 10_000 });
|
||||
await manager.getByRole('button', { name: 'Extension points' }).click();
|
||||
await expect(page.getByTestId('plugin-extension-counts')).toContainText('Settings pages');
|
||||
await expect(page.getByTestId('plugin-extension-counts')).toContainText('Embed renderers');
|
||||
await expect(page.getByTestId('plugin-extension-counts')).toContainText('1');
|
||||
await expect(page.getByTestId('plugin-conflict-diagnostics')).toContainText(
|
||||
'No duplicate route, action, embed, channel, panel, or settings contribution ids detected.'
|
||||
);
|
||||
|
||||
await manager.getByRole('button', { exact: true, name: 'Requirements' }).click();
|
||||
await expect(page.getByTestId('plugin-server-requirements')).toContainText('E2E All API Plugin');
|
||||
await expect(page.getByTestId('plugin-server-requirements')).toContainText('enabled');
|
||||
|
||||
await manager.getByRole('button', { exact: true, name: 'Settings' }).click();
|
||||
await expect(page.getByTestId('plugin-generated-settings')).toContainText('E2E settings contribution');
|
||||
await expect(page.getByTestId('plugin-generated-settings')).toContainText('"enabled"');
|
||||
|
||||
await manager.getByRole('button', { exact: true, name: 'Docs' }).click();
|
||||
await expect(page.getByTestId('plugin-installed-docs')).toContainText('Calls every public Toju plugin API surface');
|
||||
});
|
||||
});
|
||||
});
|
||||
369
e2e/tests/plugins/plugin-support-api.spec.ts
Normal file
369
e2e/tests/plugins/plugin-support-api.spec.ts
Normal file
@@ -0,0 +1,369 @@
|
||||
import type { APIRequestContext, APIResponse } from '@playwright/test';
|
||||
import WebSocket from 'ws';
|
||||
import { expect, test } from '../../fixtures/multi-client';
|
||||
import {
|
||||
getPluginApiTestEvent,
|
||||
readPluginApiTestManifest,
|
||||
TEST_PLUGIN_ID,
|
||||
TEST_PLUGIN_P2P_EVENT,
|
||||
TEST_PLUGIN_RELAY_EVENT
|
||||
} from '../../helpers/plugin-api-test-fixture';
|
||||
|
||||
const OWNER_USER_ID = 'plugin-api-owner';
|
||||
|
||||
interface CreatedServerResponse {
|
||||
id: string;
|
||||
}
|
||||
|
||||
interface PluginRequirementResponse {
|
||||
requirement: {
|
||||
pluginId: string;
|
||||
reason?: string;
|
||||
status: string;
|
||||
versionRange?: string;
|
||||
};
|
||||
}
|
||||
|
||||
interface PluginEventDefinitionResponse {
|
||||
eventDefinition: {
|
||||
direction: string;
|
||||
eventName: string;
|
||||
maxPayloadBytes: number;
|
||||
pluginId: string;
|
||||
scope: string;
|
||||
};
|
||||
}
|
||||
|
||||
interface PluginSnapshotResponse {
|
||||
eventDefinitions: PluginEventDefinitionResponse['eventDefinition'][];
|
||||
requirements: PluginRequirementResponse['requirement'][];
|
||||
serverId: string;
|
||||
}
|
||||
|
||||
interface SocketMessage {
|
||||
[key: string]: unknown;
|
||||
type?: string;
|
||||
}
|
||||
|
||||
interface TestSocket {
|
||||
close: () => Promise<void>;
|
||||
messages: SocketMessage[];
|
||||
send: (message: SocketMessage) => void;
|
||||
}
|
||||
|
||||
test.describe('Plugin support API', () => {
|
||||
test('covers plugin requirement, event, data, and websocket APIs with the fixture plugin', async ({ request, testServer }) => {
|
||||
const manifest = await readPluginApiTestManifest();
|
||||
const server = await createServer(request, testServer.url, `Plugin API ${Date.now()}`);
|
||||
const relayEvent = getPluginApiTestEvent(manifest, TEST_PLUGIN_RELAY_EVENT);
|
||||
const p2pEvent = getPluginApiTestEvent(manifest, TEST_PLUGIN_P2P_EVENT);
|
||||
const pluginsApi = `${testServer.url}/api/servers/${encodeURIComponent(server.id)}/plugins`;
|
||||
|
||||
await test.step('Initial snapshot is empty', async () => {
|
||||
const snapshot = await expectJson<PluginSnapshotResponse>(await request.get(pluginsApi));
|
||||
|
||||
expect(snapshot).toEqual(expect.objectContaining({
|
||||
eventDefinitions: [],
|
||||
requirements: [],
|
||||
serverId: server.id
|
||||
}));
|
||||
});
|
||||
|
||||
await test.step('Requirement API enforces server management permission', async () => {
|
||||
const response = await request.put(`${pluginsApi}/${TEST_PLUGIN_ID}/requirement`, {
|
||||
data: {
|
||||
actorUserId: 'not-the-owner',
|
||||
status: 'required'
|
||||
}
|
||||
});
|
||||
const body = await expectJson<{ errorCode: string }>(response, 403);
|
||||
|
||||
expect(body.errorCode).toBe('NOT_AUTHORIZED');
|
||||
});
|
||||
|
||||
await test.step('Requirement and event definition APIs persist the test plugin contract', async () => {
|
||||
const requirement = await expectJson<PluginRequirementResponse>(await request.put(`${pluginsApi}/${TEST_PLUGIN_ID}/requirement`, {
|
||||
data: {
|
||||
actorUserId: OWNER_USER_ID,
|
||||
reason: manifest.description,
|
||||
status: 'required',
|
||||
versionRange: `^${manifest.version}`
|
||||
}
|
||||
}));
|
||||
|
||||
expect(requirement.requirement).toEqual(expect.objectContaining({
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
reason: manifest.description,
|
||||
status: 'required',
|
||||
versionRange: `^${manifest.version}`
|
||||
}));
|
||||
|
||||
const relayDefinition = await upsertEventDefinition(request, pluginsApi, relayEvent);
|
||||
const p2pDefinition = await upsertEventDefinition(request, pluginsApi, p2pEvent);
|
||||
|
||||
expect(relayDefinition.eventDefinition).toEqual(expect.objectContaining({
|
||||
direction: 'serverRelay',
|
||||
eventName: TEST_PLUGIN_RELAY_EVENT,
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
scope: 'server'
|
||||
}));
|
||||
|
||||
expect(p2pDefinition.eventDefinition).toEqual(expect.objectContaining({
|
||||
direction: 'p2pHint',
|
||||
eventName: TEST_PLUGIN_P2P_EVENT,
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
scope: 'user'
|
||||
}));
|
||||
|
||||
const snapshot = await expectJson<PluginSnapshotResponse>(await request.get(pluginsApi));
|
||||
|
||||
expect(snapshot.requirements.map((entry) => entry.pluginId)).toEqual([TEST_PLUGIN_ID]);
|
||||
expect(snapshot.eventDefinitions.map((entry) => entry.eventName).sort()).toEqual([TEST_PLUGIN_P2P_EVENT, TEST_PLUGIN_RELAY_EVENT]);
|
||||
});
|
||||
|
||||
await test.step('Plugin data API refuses arbitrary server persistence', async () => {
|
||||
const stored = await expectJson<{ errorCode: string }>(await request.put(`${pluginsApi}/${TEST_PLUGIN_ID}/data/settings`, {
|
||||
data: {
|
||||
actorUserId: OWNER_USER_ID,
|
||||
schemaVersion: 1,
|
||||
scope: 'server',
|
||||
value: {
|
||||
enabled: true,
|
||||
pluginVersion: manifest.version
|
||||
}
|
||||
}
|
||||
}), 410);
|
||||
|
||||
expect(stored.errorCode).toBe('PLUGIN_DATA_DISABLED');
|
||||
|
||||
const listed = await expectJson<{ errorCode: string }>(await request.get(`${pluginsApi}/${TEST_PLUGIN_ID}/data`, {
|
||||
params: {
|
||||
key: 'settings',
|
||||
scope: 'server',
|
||||
userId: OWNER_USER_ID
|
||||
}
|
||||
}), 410);
|
||||
|
||||
expect(listed.errorCode).toBe('PLUGIN_DATA_DISABLED');
|
||||
|
||||
const afterDelete = await expectJson<{ errorCode: string }>(await request.delete(`${pluginsApi}/${TEST_PLUGIN_ID}/data/settings`, {
|
||||
data: {
|
||||
actorUserId: OWNER_USER_ID,
|
||||
scope: 'server'
|
||||
}
|
||||
}), 410);
|
||||
|
||||
expect(afterDelete.errorCode).toBe('PLUGIN_DATA_DISABLED');
|
||||
});
|
||||
|
||||
await test.step('WebSocket plugin API sends snapshots, relays server events, and rejects p2p relays', async () => {
|
||||
const alice = await openTestSocket(testServer.url);
|
||||
const bob = await openTestSocket(testServer.url);
|
||||
|
||||
try {
|
||||
alice.send({ type: 'identify', oderId: OWNER_USER_ID, displayName: 'Plugin Owner' });
|
||||
bob.send({ type: 'identify', oderId: 'plugin-api-peer', displayName: 'Plugin Peer' });
|
||||
alice.send({ type: 'join_server', serverId: server.id });
|
||||
bob.send({ type: 'join_server', serverId: server.id });
|
||||
|
||||
const aliceSnapshot = await waitForSocketMessage(alice, (message) => message.type === 'plugin_requirements');
|
||||
const bobSnapshot = await waitForSocketMessage(bob, (message) => message.type === 'plugin_requirements');
|
||||
const bobEventNames = (bobSnapshot['snapshot'] as PluginSnapshotResponse).eventDefinitions
|
||||
.map((entry) => entry.eventName)
|
||||
.sort();
|
||||
|
||||
expect((aliceSnapshot['snapshot'] as PluginSnapshotResponse).requirements[0]?.pluginId).toBe(TEST_PLUGIN_ID);
|
||||
expect(bobEventNames).toEqual([TEST_PLUGIN_P2P_EVENT, TEST_PLUGIN_RELAY_EVENT]);
|
||||
|
||||
alice.send({
|
||||
type: 'plugin_event',
|
||||
eventId: 'relay-event-1',
|
||||
eventName: TEST_PLUGIN_RELAY_EVENT,
|
||||
payload: { message: 'hello from fixture plugin' },
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
serverId: server.id,
|
||||
sourcePluginUserId: 'fixture-plugin-user'
|
||||
});
|
||||
|
||||
const relayedEvent = await waitForSocketMessage(bob, (message) => message.type === 'plugin_event');
|
||||
|
||||
expect(relayedEvent).toEqual(expect.objectContaining({
|
||||
eventId: 'relay-event-1',
|
||||
eventName: TEST_PLUGIN_RELAY_EVENT,
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
serverId: server.id,
|
||||
sourcePluginUserId: 'fixture-plugin-user',
|
||||
sourceUserId: OWNER_USER_ID
|
||||
}));
|
||||
|
||||
expect(relayedEvent['payload']).toEqual({ message: 'hello from fixture plugin' });
|
||||
expect(typeof relayedEvent['emittedAt']).toBe('number');
|
||||
|
||||
alice.send({
|
||||
type: 'plugin_event',
|
||||
eventId: 'p2p-event-1',
|
||||
eventName: TEST_PLUGIN_P2P_EVENT,
|
||||
payload: { hint: true },
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
serverId: server.id
|
||||
});
|
||||
|
||||
const p2pError = await waitForSocketMessage(
|
||||
alice,
|
||||
(message) => message.type === 'plugin_error' && message['eventId'] === 'p2p-event-1'
|
||||
);
|
||||
|
||||
expect(p2pError['code']).toBe('PLUGIN_EVENT_NOT_RELAYABLE');
|
||||
|
||||
alice.send({
|
||||
type: 'plugin_event',
|
||||
eventId: 'missing-event-1',
|
||||
eventName: 'e2e:missing',
|
||||
payload: {},
|
||||
pluginId: TEST_PLUGIN_ID,
|
||||
serverId: server.id
|
||||
});
|
||||
|
||||
const missingError = await waitForSocketMessage(
|
||||
alice,
|
||||
(message) => message.type === 'plugin_error' && message['eventId'] === 'missing-event-1'
|
||||
);
|
||||
|
||||
expect(missingError['code']).toBe('PLUGIN_EVENT_NOT_REGISTERED');
|
||||
} finally {
|
||||
await Promise.all([alice.close(), bob.close()]);
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Delete APIs remove event definitions and requirements', async () => {
|
||||
await expectJson<{ ok: boolean }>(await request.delete(`${pluginsApi}/${TEST_PLUGIN_ID}/events/${TEST_PLUGIN_RELAY_EVENT}`, {
|
||||
data: { actorUserId: OWNER_USER_ID }
|
||||
}));
|
||||
|
||||
await expectJson<{ ok: boolean }>(await request.delete(`${pluginsApi}/${TEST_PLUGIN_ID}/events/${TEST_PLUGIN_P2P_EVENT}`, {
|
||||
data: { actorUserId: OWNER_USER_ID }
|
||||
}));
|
||||
|
||||
await expectJson<{ ok: boolean }>(await request.delete(`${pluginsApi}/${TEST_PLUGIN_ID}/requirement`, {
|
||||
data: { actorUserId: OWNER_USER_ID }
|
||||
}));
|
||||
|
||||
const snapshot = await expectJson<PluginSnapshotResponse>(await request.get(pluginsApi));
|
||||
|
||||
expect(snapshot.eventDefinitions).toEqual([]);
|
||||
expect(snapshot.requirements).toEqual([]);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
async function createServer(
|
||||
request: APIRequestContext,
|
||||
baseUrl: string,
|
||||
serverName: string
|
||||
): Promise<CreatedServerResponse> {
|
||||
const response = await request.post(`${baseUrl}/api/servers`, {
|
||||
data: {
|
||||
channels: [
|
||||
{
|
||||
id: 'general-text',
|
||||
name: 'general',
|
||||
position: 0,
|
||||
type: 'text'
|
||||
}
|
||||
],
|
||||
description: 'Server for plugin API E2E coverage',
|
||||
id: `plugin-api-${Date.now()}`,
|
||||
isPrivate: false,
|
||||
name: serverName,
|
||||
ownerId: OWNER_USER_ID,
|
||||
ownerPublicKey: 'plugin-api-owner-public-key',
|
||||
tags: ['plugins']
|
||||
}
|
||||
});
|
||||
|
||||
return await expectJson<CreatedServerResponse>(response, 201);
|
||||
}
|
||||
|
||||
async function upsertEventDefinition(
|
||||
request: APIRequestContext,
|
||||
pluginsApi: string,
|
||||
eventDefinition: ReturnType<typeof getPluginApiTestEvent>
|
||||
): Promise<PluginEventDefinitionResponse> {
|
||||
return await expectJson<PluginEventDefinitionResponse>(await request.put(
|
||||
`${pluginsApi}/${TEST_PLUGIN_ID}/events/${encodeURIComponent(eventDefinition.eventName)}`,
|
||||
{
|
||||
data: {
|
||||
actorUserId: OWNER_USER_ID,
|
||||
direction: eventDefinition.direction,
|
||||
maxPayloadBytes: eventDefinition.maxPayloadBytes,
|
||||
schemaJson: '{"type":"object"}',
|
||||
scope: eventDefinition.scope
|
||||
}
|
||||
}
|
||||
));
|
||||
}
|
||||
|
||||
async function expectJson<T>(response: APIResponse, status = 200): Promise<T> {
|
||||
expect(response.status()).toBe(status);
|
||||
|
||||
return await response.json() as T;
|
||||
}
|
||||
|
||||
async function openTestSocket(baseUrl: string): Promise<TestSocket> {
|
||||
const socketUrl = baseUrl.replace(/^http/, 'ws');
|
||||
const socket = new WebSocket(socketUrl);
|
||||
const messages: SocketMessage[] = [];
|
||||
|
||||
socket.on('message', (data) => {
|
||||
messages.push(JSON.parse(data.toString()) as SocketMessage);
|
||||
});
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
socket.once('open', () => resolve());
|
||||
socket.once('error', reject);
|
||||
});
|
||||
|
||||
await waitForSocketMessage({ messages, send: () => {}, close: async () => {} }, (message) => message.type === 'connected');
|
||||
|
||||
return {
|
||||
close: async () => {
|
||||
if (socket.readyState === WebSocket.CLOSED) {
|
||||
return;
|
||||
}
|
||||
|
||||
await new Promise<void>((resolve) => {
|
||||
socket.once('close', () => resolve());
|
||||
socket.close();
|
||||
});
|
||||
},
|
||||
messages,
|
||||
send: (message: SocketMessage) => {
|
||||
socket.send(JSON.stringify(message));
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
async function waitForSocketMessage(
|
||||
socket: Pick<TestSocket, 'messages'>,
|
||||
predicate: (message: SocketMessage) => boolean,
|
||||
timeoutMs = 10_000
|
||||
): Promise<SocketMessage> {
|
||||
const startedAt = Date.now();
|
||||
|
||||
return await new Promise((resolve, reject) => {
|
||||
const interval = setInterval(() => {
|
||||
const message = socket.messages.find(predicate);
|
||||
|
||||
if (message) {
|
||||
clearInterval(interval);
|
||||
resolve(message);
|
||||
return;
|
||||
}
|
||||
|
||||
if (Date.now() - startedAt > timeoutMs) {
|
||||
clearInterval(interval);
|
||||
reject(new Error('Timed out waiting for websocket message'));
|
||||
}
|
||||
}, 25);
|
||||
});
|
||||
}
|
||||
@@ -8,7 +8,8 @@ import {
|
||||
waitForVideoFlow,
|
||||
waitForOutboundVideoFlow,
|
||||
waitForInboundVideoFlow,
|
||||
dumpRtcDiagnostics
|
||||
dumpRtcDiagnostics,
|
||||
installAutoResumeAudioContext
|
||||
} from '../../helpers/webrtc-helpers';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
@@ -38,7 +39,7 @@ async function registerUser(page: import('@playwright/test').Page, user: typeof
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
/** Both users register → Alice creates server → Bob joins. */
|
||||
/** Both users register -> Alice creates server -> Bob joins. */
|
||||
async function setupServerWithBothUsers(
|
||||
alice: { page: import('@playwright/test').Page },
|
||||
bob: { page: import('@playwright/test').Page }
|
||||
@@ -55,12 +56,7 @@ async function setupServerWithBothUsers(
|
||||
// Bob joins server
|
||||
const bobSearch = new ServerSearchPage(bob.page);
|
||||
|
||||
await bobSearch.searchInput.fill(SERVER_NAME);
|
||||
|
||||
const serverCard = bob.page.locator('button', { hasText: SERVER_NAME }).first();
|
||||
|
||||
await expect(serverCard).toBeVisible({ timeout: 10_000 });
|
||||
await serverCard.click();
|
||||
await bobSearch.joinServerFromSearch(SERVER_NAME);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
@@ -80,19 +76,45 @@ async function joinVoiceTogether(
|
||||
await expect(existingChannel).toBeVisible({ timeout: 10_000 });
|
||||
}
|
||||
|
||||
await aliceRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(alice.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
const doJoin = async () => {
|
||||
await aliceRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(alice.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
await bobRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(bob.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
await bobRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(bob.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
// Wait for WebRTC + audio pipeline
|
||||
await waitForPeerConnected(alice.page, 30_000);
|
||||
await waitForPeerConnected(bob.page, 30_000);
|
||||
await waitForAudioStatsPresent(alice.page, 20_000);
|
||||
await waitForAudioStatsPresent(bob.page, 20_000);
|
||||
// Wait for WebRTC + audio pipeline
|
||||
await waitForPeerConnected(alice.page, 30_000);
|
||||
await waitForPeerConnected(bob.page, 30_000);
|
||||
await waitForAudioStatsPresent(alice.page, 20_000);
|
||||
await waitForAudioStatsPresent(bob.page, 20_000);
|
||||
};
|
||||
|
||||
await doJoin();
|
||||
|
||||
// Chromium's --use-fake-device-for-media-stream can produce a silent
|
||||
// capture track on the very first getUserMedia call. If bidirectional
|
||||
// audio doesn't flow within a short window, leave and rejoin voice to
|
||||
// re-acquire the mic (second getUserMedia on a warm device works).
|
||||
const aliceDelta = await waitForAudioFlow(alice.page, 10_000);
|
||||
const bobDelta = await waitForAudioFlow(bob.page, 10_000);
|
||||
const aliceFlowing =
|
||||
(aliceDelta.outboundBytesDelta > 0 || aliceDelta.outboundPacketsDelta > 0) &&
|
||||
(aliceDelta.inboundBytesDelta > 0 || aliceDelta.inboundPacketsDelta > 0);
|
||||
const bobFlowing =
|
||||
(bobDelta.outboundBytesDelta > 0 || bobDelta.outboundPacketsDelta > 0) &&
|
||||
(bobDelta.inboundBytesDelta > 0 || bobDelta.inboundPacketsDelta > 0);
|
||||
|
||||
if (!aliceFlowing || !bobFlowing) {
|
||||
// Leave voice
|
||||
await aliceRoom.disconnectButton.click();
|
||||
await bobRoom.disconnectButton.click();
|
||||
await alice.page.waitForTimeout(2_000);
|
||||
|
||||
// Rejoin
|
||||
await doJoin();
|
||||
}
|
||||
|
||||
// Expand voice workspace on both clients so the demand-driven screen
|
||||
// share request flow can fire (requires connectRemoteShares = true).
|
||||
@@ -142,6 +164,20 @@ test.describe('Screen sharing', () => {
|
||||
|
||||
await installWebRTCTracking(alice.page);
|
||||
await installWebRTCTracking(bob.page);
|
||||
await installAutoResumeAudioContext(alice.page);
|
||||
await installAutoResumeAudioContext(bob.page);
|
||||
|
||||
// Seed deterministic voice settings so noise reduction doesn't
|
||||
// swallow the fake audio tone.
|
||||
const voiceSettings = JSON.stringify({
|
||||
inputVolume: 100, outputVolume: 100, audioBitrate: 96,
|
||||
latencyProfile: 'balanced', includeSystemAudio: false,
|
||||
noiseReduction: false, screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
await alice.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
await bob.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
|
||||
alice.page.on('console', msg => console.log('[Alice]', msg.text()));
|
||||
bob.page.on('console', msg => console.log('[Bob]', msg.text()));
|
||||
@@ -251,6 +287,18 @@ test.describe('Screen sharing', () => {
|
||||
|
||||
await installWebRTCTracking(alice.page);
|
||||
await installWebRTCTracking(bob.page);
|
||||
await installAutoResumeAudioContext(alice.page);
|
||||
await installAutoResumeAudioContext(bob.page);
|
||||
|
||||
const voiceSettings = JSON.stringify({
|
||||
inputVolume: 100, outputVolume: 100, audioBitrate: 96,
|
||||
latencyProfile: 'balanced', includeSystemAudio: false,
|
||||
noiseReduction: false, screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
await alice.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
await bob.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
|
||||
alice.page.on('console', msg => console.log('[Alice]', msg.text()));
|
||||
bob.page.on('console', msg => console.log('[Bob]', msg.text()));
|
||||
@@ -323,6 +371,18 @@ test.describe('Screen sharing', () => {
|
||||
|
||||
await installWebRTCTracking(alice.page);
|
||||
await installWebRTCTracking(bob.page);
|
||||
await installAutoResumeAudioContext(alice.page);
|
||||
await installAutoResumeAudioContext(bob.page);
|
||||
|
||||
const voiceSettings = JSON.stringify({
|
||||
inputVolume: 100, outputVolume: 100, audioBitrate: 96,
|
||||
latencyProfile: 'balanced', includeSystemAudio: false,
|
||||
noiseReduction: false, screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
await alice.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
await bob.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
|
||||
alice.page.on('console', msg => console.log('[Alice]', msg.text()));
|
||||
bob.page.on('console', msg => console.log('[Bob]', msg.text()));
|
||||
|
||||
219
e2e/tests/settings/connectivity-warning.spec.ts
Normal file
219
e2e/tests/settings/connectivity-warning.spec.ts
Normal file
@@ -0,0 +1,219 @@
|
||||
import { test, expect } from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
import {
|
||||
installAutoResumeAudioContext,
|
||||
installWebRTCTracking,
|
||||
waitForConnectedPeerCount
|
||||
} from '../../helpers/webrtc-helpers';
|
||||
|
||||
const VOICE_SETTINGS = JSON.stringify({
|
||||
inputVolume: 100,
|
||||
outputVolume: 100,
|
||||
audioBitrate: 96,
|
||||
latencyProfile: 'balanced',
|
||||
includeSystemAudio: false,
|
||||
noiseReduction: false,
|
||||
screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
/**
|
||||
* Seed deterministic voice settings on a page so noise reduction and
|
||||
* input gating don't interfere with the fake audio tone.
|
||||
*/
|
||||
async function seedVoiceSettings(page: import('@playwright/test').Page): Promise<void> {
|
||||
await page.addInitScript((settings: string) => {
|
||||
localStorage.setItem('metoyou_voice_settings', settings);
|
||||
}, VOICE_SETTINGS);
|
||||
}
|
||||
|
||||
/**
|
||||
* Close all of a client's RTCPeerConnections and prevent any
|
||||
* reconnection by sabotaging the SDP negotiation methods on the
|
||||
* prototype - new connections get created but can never complete ICE.
|
||||
*
|
||||
* Chromium doesn't fire `connectionstatechange` on programmatic
|
||||
* `close()`, so we dispatch the event manually so the app's recovery
|
||||
* code runs and updates the connected-peers signal.
|
||||
*/
|
||||
async function killAndBlockPeerConnections(page: import('@playwright/test').Page): Promise<void> {
|
||||
await page.evaluate(() => {
|
||||
// Sabotage SDP methods so no NEW connections can negotiate.
|
||||
const proto = RTCPeerConnection.prototype;
|
||||
|
||||
proto.createOffer = () => Promise.reject(new DOMException('blocked', 'NotAllowedError'));
|
||||
proto.createAnswer = () => Promise.reject(new DOMException('blocked', 'NotAllowedError'));
|
||||
proto.setLocalDescription = () => Promise.reject(new DOMException('blocked', 'NotAllowedError'));
|
||||
proto.setRemoteDescription = () => Promise.reject(new DOMException('blocked', 'NotAllowedError'));
|
||||
|
||||
// Close every existing connection and manually fire the event
|
||||
// Chromium omits when close() is called from JS.
|
||||
const connections = (window as { __rtcConnections?: RTCPeerConnection[] }).__rtcConnections ?? [];
|
||||
|
||||
for (const pc of connections) {
|
||||
try {
|
||||
pc.close();
|
||||
pc.dispatchEvent(new Event('connectionstatechange'));
|
||||
} catch { /* already closed */ }
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
test.describe('Connectivity warning', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('shows warning icon when a peer loses all connections', async ({ createClient }) => {
|
||||
const suffix = `connwarn_${Date.now()}`;
|
||||
const serverName = `ConnWarn ${suffix}`;
|
||||
const alice = await createClient();
|
||||
const bob = await createClient();
|
||||
const charlie = await createClient();
|
||||
|
||||
// ── Install WebRTC tracking & AudioContext auto-resume ──
|
||||
for (const client of [
|
||||
alice,
|
||||
bob,
|
||||
charlie
|
||||
]) {
|
||||
await installWebRTCTracking(client.page);
|
||||
await installAutoResumeAudioContext(client.page);
|
||||
await seedVoiceSettings(client.page);
|
||||
}
|
||||
|
||||
// ── Register all three users ──
|
||||
await test.step('Register Alice', async () => {
|
||||
const register = new RegisterPage(alice.page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`alice_${suffix}`, 'Alice', 'TestPass123!');
|
||||
await expect(alice.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Bob', async () => {
|
||||
const register = new RegisterPage(bob.page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`bob_${suffix}`, 'Bob', 'TestPass123!');
|
||||
await expect(bob.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Charlie', async () => {
|
||||
const register = new RegisterPage(charlie.page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`charlie_${suffix}`, 'Charlie', 'TestPass123!');
|
||||
await expect(charlie.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
// ── Create server and have everyone join ──
|
||||
await test.step('Alice creates a server', async () => {
|
||||
const search = new ServerSearchPage(alice.page);
|
||||
|
||||
await search.createServer(serverName);
|
||||
});
|
||||
|
||||
await test.step('Bob joins the server', async () => {
|
||||
const search = new ServerSearchPage(bob.page);
|
||||
|
||||
await search.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
});
|
||||
|
||||
await test.step('Charlie joins the server', async () => {
|
||||
const search = new ServerSearchPage(charlie.page);
|
||||
|
||||
await search.joinServerFromSearch(serverName);
|
||||
await expect(charlie.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
});
|
||||
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
const charlieRoom = new ChatRoomPage(charlie.page);
|
||||
|
||||
// ── Everyone joins voice ──
|
||||
await test.step('All three join voice', async () => {
|
||||
await aliceRoom.joinVoiceChannel('General');
|
||||
await bobRoom.joinVoiceChannel('General');
|
||||
await charlieRoom.joinVoiceChannel('General');
|
||||
});
|
||||
|
||||
await test.step('All users see each other in voice', async () => {
|
||||
// Each user should see the other two in the voice channel list.
|
||||
await expect(
|
||||
aliceRoom.channelsSidePanel.getByText('Bob')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
aliceRoom.channelsSidePanel.getByText('Charlie')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
bobRoom.channelsSidePanel.getByText('Alice')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
bobRoom.channelsSidePanel.getByText('Charlie')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
charlieRoom.channelsSidePanel.getByText('Alice')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
charlieRoom.channelsSidePanel.getByText('Bob')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
// ── Wait for full mesh to establish ──
|
||||
await test.step('All peer connections establish', async () => {
|
||||
// Each client should have 2 connected peers (full mesh of 3).
|
||||
await waitForConnectedPeerCount(alice.page, 2, 30_000);
|
||||
await waitForConnectedPeerCount(bob.page, 2, 30_000);
|
||||
await waitForConnectedPeerCount(charlie.page, 2, 30_000);
|
||||
});
|
||||
|
||||
// ── Break Charlie's connections ──
|
||||
await test.step('Kill Charlie peer connections and block reconnection', async () => {
|
||||
await killAndBlockPeerConnections(charlie.page);
|
||||
|
||||
// Give the health service time to detect the desync.
|
||||
// Peer latency pings stop -> connectedPeers updates -> desyncPeerIds recalculates.
|
||||
await alice.page.waitForTimeout(15_000);
|
||||
});
|
||||
|
||||
// ── Assert connectivity warnings ──
|
||||
//
|
||||
// The warning icon (lucideAlertTriangle) is a direct sibling of the
|
||||
// user-name span inside the same voice-row div. Using the CSS
|
||||
// general-sibling combinator (~) avoids accidentally matching a
|
||||
// parent container that holds multiple rows.
|
||||
await test.step('Alice sees warning icon next to Charlie', async () => {
|
||||
const charlieWarning = aliceRoom.channelsSidePanel
|
||||
.locator('span.truncate:has-text("Charlie") ~ ng-icon[name="lucideAlertTriangle"]');
|
||||
|
||||
await expect(charlieWarning).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob sees warning icon next to Charlie', async () => {
|
||||
const charlieWarning = bobRoom.channelsSidePanel
|
||||
.locator('span.truncate:has-text("Charlie") ~ ng-icon[name="lucideAlertTriangle"]');
|
||||
|
||||
await expect(charlieWarning).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Alice does NOT see warning icon next to Bob', async () => {
|
||||
const bobWarning = aliceRoom.channelsSidePanel
|
||||
.locator('span.truncate:has-text("Bob") ~ ng-icon[name="lucideAlertTriangle"]');
|
||||
|
||||
await expect(bobWarning).not.toBeVisible();
|
||||
});
|
||||
|
||||
await test.step('Charlie sees local desync banner', async () => {
|
||||
const desyncBanner = charlie.page.locator('text=You may have connectivity issues');
|
||||
|
||||
await expect(desyncBanner).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
});
|
||||
});
|
||||
127
e2e/tests/settings/ice-server-settings.spec.ts
Normal file
127
e2e/tests/settings/ice-server-settings.spec.ts
Normal file
@@ -0,0 +1,127 @@
|
||||
import { test, expect } from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
|
||||
test.describe('ICE server settings', () => {
|
||||
test.describe.configure({ timeout: 120_000 });
|
||||
|
||||
async function registerAndOpenNetworkSettings(page: import('@playwright/test').Page, suffix: string) {
|
||||
const register = new RegisterPage(page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`user_${suffix}`, 'IceTestUser', 'TestPass123!');
|
||||
await expect(page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await page.getByTitle('Settings').click();
|
||||
await expect(page.getByRole('button', { name: 'Network' })).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { name: 'Network' }).click();
|
||||
await expect(page.getByTestId('ice-server-settings')).toBeVisible({ timeout: 10_000 });
|
||||
}
|
||||
|
||||
test('allows adding, removing, and reordering ICE servers', async ({ createClient }) => {
|
||||
const client = await createClient();
|
||||
const { page } = client;
|
||||
const suffix = `ice_${Date.now()}`;
|
||||
|
||||
await test.step('Register and open Network settings', async () => {
|
||||
await registerAndOpenNetworkSettings(page, suffix);
|
||||
});
|
||||
|
||||
const iceSection = page.getByTestId('ice-server-settings');
|
||||
|
||||
await test.step('Default STUN servers are listed', async () => {
|
||||
await expect(iceSection).toBeVisible({ timeout: 5_000 });
|
||||
const entries = page.getByTestId('ice-server-list').locator('[data-testid^="ice-entry-"]');
|
||||
|
||||
await expect(entries.first()).toBeVisible({ timeout: 5_000 });
|
||||
const count = await entries.count();
|
||||
|
||||
expect(count).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
await test.step('Add a STUN server', async () => {
|
||||
await page.getByTestId('ice-type-select').selectOption('stun');
|
||||
await page.getByTestId('ice-url-input').fill('stun:custom.example.com:3478');
|
||||
await page.getByTestId('ice-add-button').click();
|
||||
await expect(page.getByText('stun:custom.example.com:3478')).toBeVisible({ timeout: 5_000 });
|
||||
});
|
||||
|
||||
await test.step('Add a TURN server with credentials', async () => {
|
||||
await page.getByTestId('ice-type-select').selectOption('turn');
|
||||
await page.getByTestId('ice-url-input').fill('turn:relay.example.com:443');
|
||||
await page.getByTestId('ice-username-input').fill('testuser');
|
||||
await page.getByTestId('ice-credential-input').fill('testpass');
|
||||
await page.getByTestId('ice-add-button').click();
|
||||
await expect(page.getByText('turn:relay.example.com:443')).toBeVisible({ timeout: 5_000 });
|
||||
await expect(page.getByText('User: testuser')).toBeVisible({ timeout: 5_000 });
|
||||
});
|
||||
|
||||
await test.step('Remove first entry and verify count decreases', async () => {
|
||||
const entries = page.getByTestId('ice-server-list').locator('[data-testid^="ice-entry-"]');
|
||||
const countBefore = await entries.count();
|
||||
|
||||
await entries.first().getByTitle('Remove')
|
||||
.click();
|
||||
|
||||
await expect(entries).toHaveCount(countBefore - 1, { timeout: 5_000 });
|
||||
});
|
||||
|
||||
await test.step('Reorder: move second entry up', async () => {
|
||||
const entries = page.getByTestId('ice-server-list').locator('[data-testid^="ice-entry-"]');
|
||||
const count = await entries.count();
|
||||
|
||||
if (count >= 2) {
|
||||
const secondText = await entries.nth(1).locator('p')
|
||||
.first()
|
||||
.textContent();
|
||||
|
||||
if (!secondText) {
|
||||
throw new Error('Expected ICE server entry text before reordering');
|
||||
}
|
||||
|
||||
await entries.nth(1).getByTitle('Move up (higher priority)')
|
||||
.click();
|
||||
|
||||
// Wait for the moved entry text to appear at position 0
|
||||
await expect(entries.first().locator('p')
|
||||
.first()).toHaveText(secondText, { timeout: 5_000 });
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Restore defaults resets list', async () => {
|
||||
await page.getByTestId('ice-restore-defaults').click();
|
||||
await expect(page.getByText('turn:relay.example.com:443')).not.toBeVisible({ timeout: 3_000 });
|
||||
const entries = page.getByTestId('ice-server-list').locator('[data-testid^="ice-entry-"]');
|
||||
|
||||
await expect(entries.first()).toBeVisible({ timeout: 5_000 });
|
||||
});
|
||||
|
||||
await test.step('Settings persist after page reload', async () => {
|
||||
await page.getByTestId('ice-type-select').selectOption('stun');
|
||||
await page.getByTestId('ice-url-input').fill('stun:persist-test.example.com:3478');
|
||||
await page.getByTestId('ice-add-button').click();
|
||||
await expect(page.getByText('stun:persist-test.example.com:3478')).toBeVisible({ timeout: 5_000 });
|
||||
|
||||
await page.reload({ waitUntil: 'domcontentloaded' });
|
||||
await page.getByTitle('Settings').click();
|
||||
await expect(page.getByRole('button', { name: 'Network' })).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { name: 'Network' }).click();
|
||||
await expect(page.getByText('stun:persist-test.example.com:3478')).toBeVisible({ timeout: 10_000 });
|
||||
});
|
||||
});
|
||||
|
||||
test('validates TURN entries require credentials', async ({ createClient }) => {
|
||||
const client = await createClient();
|
||||
const { page } = client;
|
||||
const suffix = `iceval_${Date.now()}`;
|
||||
|
||||
await test.step('Register and open Network settings', async () => {
|
||||
await registerAndOpenNetworkSettings(page, suffix);
|
||||
});
|
||||
|
||||
await test.step('Adding TURN without credentials shows error', async () => {
|
||||
await page.getByTestId('ice-type-select').selectOption('turn');
|
||||
await page.getByTestId('ice-url-input').fill('turn:noncred.example.com:443');
|
||||
await page.getByTestId('ice-add-button').click();
|
||||
await expect(page.getByText('Username is required for TURN servers')).toBeVisible({ timeout: 5_000 });
|
||||
});
|
||||
});
|
||||
});
|
||||
212
e2e/tests/settings/stun-turn-fallback.spec.ts
Normal file
212
e2e/tests/settings/stun-turn-fallback.spec.ts
Normal file
@@ -0,0 +1,212 @@
|
||||
import { test, expect } from '../../fixtures/multi-client';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
import {
|
||||
dumpRtcDiagnostics,
|
||||
installAutoResumeAudioContext,
|
||||
installWebRTCTracking,
|
||||
waitForAllPeerAudioFlow,
|
||||
waitForPeerConnected,
|
||||
waitForConnectedPeerCount,
|
||||
waitForAudioStatsPresent
|
||||
} from '../../helpers/webrtc-helpers';
|
||||
|
||||
const ICE_STORAGE_KEY = 'metoyou_ice_servers';
|
||||
|
||||
interface StoredIceServerEntry {
|
||||
type?: string;
|
||||
urls?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that user-configured ICE servers are persisted and used by peer connections.
|
||||
*
|
||||
* On localhost TURN relay is never needed (direct always succeeds), so this test:
|
||||
* 1. Seeds Bob's browser with an additional TURN entry via localStorage.
|
||||
* 2. Has both users join voice with differing ICE configs.
|
||||
* 3. Verifies both can connect and Bob's TURN entry is still in storage.
|
||||
*/
|
||||
test.describe('STUN/TURN fallback behaviour', () => {
|
||||
test.describe.configure({ timeout: 180_000 });
|
||||
|
||||
test('users with different ICE configs can voice chat together', async ({ createClient }) => {
|
||||
const suffix = `turnfb_${Date.now()}`;
|
||||
const serverName = `Fallback ${suffix}`;
|
||||
const alice = await createClient();
|
||||
const bob = await createClient();
|
||||
|
||||
// Install WebRTC tracking before any navigation so we can inspect
|
||||
// peer connections and audio stats.
|
||||
await installWebRTCTracking(alice.page);
|
||||
await installWebRTCTracking(bob.page);
|
||||
|
||||
// Ensure AudioContexts auto-resume so the input-gain pipeline
|
||||
// (source -> gain -> destination) never stalls in "suspended" state.
|
||||
await installAutoResumeAudioContext(alice.page);
|
||||
await installAutoResumeAudioContext(bob.page);
|
||||
|
||||
// Set deterministic voice settings so noise reduction and input gating
|
||||
// don't swallow the fake audio tone.
|
||||
const voiceSettings = JSON.stringify({
|
||||
inputVolume: 100,
|
||||
outputVolume: 100,
|
||||
audioBitrate: 96,
|
||||
latencyProfile: 'balanced',
|
||||
includeSystemAudio: false,
|
||||
noiseReduction: false,
|
||||
screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
await alice.page.addInitScript((settings: string) => {
|
||||
localStorage.setItem('metoyou_voice_settings', settings);
|
||||
}, voiceSettings);
|
||||
|
||||
await bob.page.addInitScript((settings: string) => {
|
||||
localStorage.setItem('metoyou_voice_settings', settings);
|
||||
}, voiceSettings);
|
||||
|
||||
// Seed Bob with an extra TURN entry before the app reads localStorage.
|
||||
await bob.context.addInitScript((key: string) => {
|
||||
try {
|
||||
const existing = JSON.parse(localStorage.getItem(key) || '[]');
|
||||
|
||||
existing.push({
|
||||
id: 'e2e-turn',
|
||||
type: 'turn',
|
||||
urls: 'turn:localhost:3478',
|
||||
username: 'e2euser',
|
||||
credential: 'e2epass'
|
||||
});
|
||||
|
||||
localStorage.setItem(key, JSON.stringify(existing));
|
||||
} catch { /* noop */ }
|
||||
}, ICE_STORAGE_KEY);
|
||||
|
||||
await test.step('Register Alice', async () => {
|
||||
const register = new RegisterPage(alice.page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`alice_${suffix}`, 'Alice', 'TestPass123!');
|
||||
await expect(alice.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Bob', async () => {
|
||||
const register = new RegisterPage(bob.page);
|
||||
|
||||
await register.goto();
|
||||
await register.register(`bob_${suffix}`, 'Bob', 'TestPass123!');
|
||||
await expect(bob.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Alice creates a server', async () => {
|
||||
const search = new ServerSearchPage(alice.page);
|
||||
|
||||
await search.createServer(serverName);
|
||||
});
|
||||
|
||||
await test.step('Bob joins Alice server', async () => {
|
||||
const search = new ServerSearchPage(bob.page);
|
||||
|
||||
await search.joinServerFromSearch(serverName);
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
});
|
||||
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
|
||||
await test.step('Both join voice', async () => {
|
||||
await aliceRoom.joinVoiceChannel('General');
|
||||
await bobRoom.joinVoiceChannel('General');
|
||||
});
|
||||
|
||||
await test.step('Both users see each other in voice', async () => {
|
||||
await expect(
|
||||
aliceRoom.channelsSidePanel.getByText('Bob')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
bobRoom.channelsSidePanel.getByText('Alice')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Peer connections establish and audio flows bidirectionally', async () => {
|
||||
await waitForPeerConnected(alice.page, 30_000);
|
||||
await waitForPeerConnected(bob.page, 30_000);
|
||||
await waitForConnectedPeerCount(alice.page, 1, 30_000);
|
||||
await waitForConnectedPeerCount(bob.page, 1, 30_000);
|
||||
|
||||
// Wait for audio RTP stats to appear (tracks negotiated)
|
||||
await waitForAudioStatsPresent(alice.page, 30_000);
|
||||
await waitForAudioStatsPresent(bob.page, 30_000);
|
||||
|
||||
// Allow mesh to settle - voice routing and renegotiation can
|
||||
// cause a second offer/answer cycle after the initial connection.
|
||||
await alice.page.waitForTimeout(5_000);
|
||||
|
||||
// Chromium's --use-fake-device-for-media-stream can produce a
|
||||
// silent capture track on the very first getUserMedia call. If
|
||||
// bidirectional audio does not flow within a short window, leave
|
||||
// and rejoin voice to re-acquire the mic (the second getUserMedia
|
||||
// on a warm device always works).
|
||||
let audioFlowing = false;
|
||||
|
||||
try {
|
||||
await Promise.all([waitForAllPeerAudioFlow(alice.page, 1, 15_000), waitForAllPeerAudioFlow(bob.page, 1, 15_000)]);
|
||||
|
||||
audioFlowing = true;
|
||||
} catch {
|
||||
// Silent sender detected - rejoin voice to work around Chromium bug
|
||||
}
|
||||
|
||||
if (!audioFlowing) {
|
||||
// Leave voice
|
||||
await aliceRoom.disconnectButton.click();
|
||||
await bobRoom.disconnectButton.click();
|
||||
await alice.page.waitForTimeout(2_000);
|
||||
|
||||
// Rejoin
|
||||
await aliceRoom.joinVoiceChannel('General');
|
||||
await bobRoom.joinVoiceChannel('General');
|
||||
|
||||
await expect(
|
||||
aliceRoom.channelsSidePanel.getByText('Bob')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await expect(
|
||||
bobRoom.channelsSidePanel.getByText('Alice')
|
||||
).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
await waitForPeerConnected(alice.page, 30_000);
|
||||
await waitForPeerConnected(bob.page, 30_000);
|
||||
await waitForConnectedPeerCount(alice.page, 1, 30_000);
|
||||
await waitForConnectedPeerCount(bob.page, 1, 30_000);
|
||||
await waitForAudioStatsPresent(alice.page, 30_000);
|
||||
await waitForAudioStatsPresent(bob.page, 30_000);
|
||||
await alice.page.waitForTimeout(3_000);
|
||||
}
|
||||
|
||||
// Final assertion - must succeed after the (optional) rejoin.
|
||||
try {
|
||||
await Promise.all([waitForAllPeerAudioFlow(alice.page, 1, 60_000), waitForAllPeerAudioFlow(bob.page, 1, 60_000)]);
|
||||
} catch (error) {
|
||||
console.log('[Alice RTC Diagnostics]\n' + await dumpRtcDiagnostics(alice.page));
|
||||
console.log('[Bob RTC Diagnostics]\n' + await dumpRtcDiagnostics(bob.page));
|
||||
throw error;
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Bob still has TURN entry in localStorage', async () => {
|
||||
const stored: StoredIceServerEntry[] = await bob.page.evaluate(
|
||||
(key) => JSON.parse(localStorage.getItem(key) || '[]') as StoredIceServerEntry[],
|
||||
ICE_STORAGE_KEY
|
||||
);
|
||||
const hasTurn = stored.some(
|
||||
(entry) => entry.type === 'turn' && entry.urls === 'turn:localhost:3478'
|
||||
);
|
||||
|
||||
expect(hasTurn).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
803
e2e/tests/voice/mixed-signal-config-voice.spec.ts
Normal file
803
e2e/tests/voice/mixed-signal-config-voice.spec.ts
Normal file
@@ -0,0 +1,803 @@
|
||||
import { expect, type Page } from '@playwright/test';
|
||||
import { test, type Client } from '../../fixtures/multi-client';
|
||||
import { installTestServerEndpoints, type SeededEndpointInput } from '../../helpers/seed-test-endpoint';
|
||||
import { startTestServer } from '../../helpers/test-server';
|
||||
import {
|
||||
dumpRtcDiagnostics,
|
||||
getConnectedPeerCount,
|
||||
installWebRTCTracking,
|
||||
waitForAllPeerAudioFlow,
|
||||
waitForAudioStatsPresent,
|
||||
waitForConnectedPeerCount,
|
||||
waitForPeerConnected
|
||||
} from '../../helpers/webrtc-helpers';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
import { ChatMessagesPage } from '../../pages/chat-messages.page';
|
||||
|
||||
// ── Signal endpoint identifiers ──────────────────────────────────────
|
||||
const PRIMARY_SIGNAL_ID = 'e2e-mixed-signal-a';
|
||||
const SECONDARY_SIGNAL_ID = 'e2e-mixed-signal-b';
|
||||
// ── Room / channel names ─────────────────────────────────────────────
|
||||
const VOICE_ROOM_NAME = `Mixed Signal Voice ${Date.now()}`;
|
||||
const SECONDARY_ROOM_NAME = `Mixed Signal Chat ${Date.now()}`;
|
||||
const VOICE_CHANNEL = 'General';
|
||||
// ── User constants ───────────────────────────────────────────────────
|
||||
const USER_PASSWORD = 'TestPass123!';
|
||||
const USER_COUNT = 8;
|
||||
const EXPECTED_REMOTE_PEERS = USER_COUNT - 1;
|
||||
const STABILITY_WINDOW_MS = 20_000;
|
||||
|
||||
// ── User signal configuration groups ─────────────────────────────────
|
||||
//
|
||||
// Group A (users 0-1): Both signal servers in network config (normal)
|
||||
// Group B (users 2-3): Only primary signal - secondary NOT in config.
|
||||
// They join the secondary room via invite link,
|
||||
// which auto-adds the endpoint.
|
||||
// Group C (users 4-5): Both signals initially, but secondary is removed
|
||||
// after registration. They still see the room from
|
||||
// search because the primary signal can discover it
|
||||
// via findServerAcrossActiveEndpoints fallback.
|
||||
// Group D (users 6-7): Only secondary signal in config. They join the
|
||||
// primary room via invite link.
|
||||
|
||||
type SignalGroup = 'both' | 'primary-only' | 'both-then-remove-secondary' | 'secondary-only';
|
||||
|
||||
interface TestUser {
|
||||
username: string;
|
||||
displayName: string;
|
||||
password: string;
|
||||
group: SignalGroup;
|
||||
}
|
||||
|
||||
type TestClient = Client & { user: TestUser };
|
||||
|
||||
function endpointsForGroup(
|
||||
group: SignalGroup,
|
||||
primaryUrl: string,
|
||||
secondaryUrl: string
|
||||
): SeededEndpointInput[] {
|
||||
switch (group) {
|
||||
case 'both':
|
||||
return [
|
||||
{
|
||||
id: PRIMARY_SIGNAL_ID,
|
||||
name: 'E2E Signal A',
|
||||
url: primaryUrl,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
},
|
||||
{
|
||||
id: SECONDARY_SIGNAL_ID,
|
||||
name: 'E2E Signal B',
|
||||
url: secondaryUrl,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
}
|
||||
];
|
||||
case 'primary-only':
|
||||
return [{ id: PRIMARY_SIGNAL_ID, name: 'E2E Signal A', url: primaryUrl, isActive: true, status: 'online' }];
|
||||
case 'both-then-remove-secondary':
|
||||
// Seed both initially; test will remove secondary after registration.
|
||||
return [
|
||||
{
|
||||
id: PRIMARY_SIGNAL_ID,
|
||||
name: 'E2E Signal A',
|
||||
url: primaryUrl,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
},
|
||||
{
|
||||
id: SECONDARY_SIGNAL_ID,
|
||||
name: 'E2E Signal B',
|
||||
url: secondaryUrl,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
}
|
||||
];
|
||||
case 'secondary-only':
|
||||
return [{ id: SECONDARY_SIGNAL_ID, name: 'E2E Signal B', url: secondaryUrl, isActive: true, status: 'online' }];
|
||||
}
|
||||
}
|
||||
|
||||
test.describe('Mixed signal-config voice', () => {
|
||||
test('8 users with different signal configs can voice, mute, deafen, and chat concurrently', async ({
|
||||
createClient,
|
||||
testServer
|
||||
}) => {
|
||||
test.setTimeout(720_000);
|
||||
|
||||
const secondaryServer = await startTestServer();
|
||||
|
||||
try {
|
||||
const users = buildUsers();
|
||||
const clients: TestClient[] = [];
|
||||
|
||||
// ── Create clients with per-group endpoint configs ───────────
|
||||
for (const user of users) {
|
||||
const client = await createClient();
|
||||
const groupEndpoints = endpointsForGroup(user.group, testServer.url, secondaryServer.url);
|
||||
|
||||
await installTestServerEndpoints(client.context, groupEndpoints);
|
||||
await installDeterministicVoiceSettings(client.page);
|
||||
await installWebRTCTracking(client.page);
|
||||
|
||||
clients.push({ ...client, user });
|
||||
}
|
||||
|
||||
// ── Register ─────────────────────────────────────────────────
|
||||
await test.step('Register each user on their configured signal endpoint', async () => {
|
||||
for (const client of clients) {
|
||||
const registerPage = new RegisterPage(client.page);
|
||||
const registrationEndpointId =
|
||||
client.user.group === 'secondary-only' ? SECONDARY_SIGNAL_ID : PRIMARY_SIGNAL_ID;
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.serverSelect.selectOption(registrationEndpointId);
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
}
|
||||
});
|
||||
|
||||
// ── Create rooms ────────────────────────────────────────────
|
||||
await test.step('Create voice room on primary and chat room on secondary', async () => {
|
||||
// Use a "both" user (client 0) to create both rooms
|
||||
const searchPage = new ServerSearchPage(clients[0].page);
|
||||
|
||||
await searchPage.createServer(VOICE_ROOM_NAME, {
|
||||
description: 'Voice room on primary signal',
|
||||
sourceId: PRIMARY_SIGNAL_ID
|
||||
});
|
||||
|
||||
await expect(clients[0].page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
|
||||
await searchPage.createServer(SECONDARY_ROOM_NAME, {
|
||||
description: 'Chat room on secondary signal',
|
||||
sourceId: SECONDARY_SIGNAL_ID
|
||||
});
|
||||
|
||||
await expect(clients[0].page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
});
|
||||
|
||||
// ── Create invite links ─────────────────────────────────────
|
||||
//
|
||||
// Group B (primary-only) needs invite to secondary room.
|
||||
// Group D (secondary-only) needs invite to primary room.
|
||||
let primaryRoomInviteUrl: string;
|
||||
let secondaryRoomInviteUrl: string;
|
||||
|
||||
await test.step('Create invite links for cross-signal rooms', async () => {
|
||||
// Navigate to voice room to get its ID
|
||||
await openSavedRoomByName(clients[0].page, VOICE_ROOM_NAME);
|
||||
const primaryRoomId = await getCurrentRoomId(clients[0].page);
|
||||
const userId = await getCurrentUserId(clients[0].page);
|
||||
|
||||
// Navigate to secondary room to get its ID
|
||||
await openSavedRoomByName(clients[0].page, SECONDARY_ROOM_NAME);
|
||||
const secondaryRoomId = await getCurrentRoomId(clients[0].page);
|
||||
// Create invite for primary room (voice) via API
|
||||
const primaryInvite = await createInviteViaApi(
|
||||
testServer.url,
|
||||
primaryRoomId,
|
||||
userId,
|
||||
clients[0].user.displayName
|
||||
);
|
||||
|
||||
primaryRoomInviteUrl = `/invite/${primaryInvite.id}?server=${encodeURIComponent(testServer.url)}`;
|
||||
|
||||
// Create invite for secondary room (chat) via API
|
||||
const secondaryInvite = await createInviteViaApi(
|
||||
secondaryServer.url,
|
||||
secondaryRoomId,
|
||||
userId,
|
||||
clients[0].user.displayName
|
||||
);
|
||||
|
||||
secondaryRoomInviteUrl = `/invite/${secondaryInvite.id}?server=${encodeURIComponent(secondaryServer.url)}`;
|
||||
});
|
||||
|
||||
// ── Remove secondary endpoint for group C ───────────────────
|
||||
await test.step('Remove secondary signal from group C users', async () => {
|
||||
for (const client of clients.filter((clientItem) => clientItem.user.group === 'both-then-remove-secondary')) {
|
||||
await client.page.evaluate((primaryEndpoint) => {
|
||||
localStorage.setItem('metoyou_server_endpoints', JSON.stringify([primaryEndpoint]));
|
||||
}, { id: PRIMARY_SIGNAL_ID, name: 'E2E Signal A', url: testServer.url, isActive: true, isDefault: false, status: 'online' });
|
||||
}
|
||||
});
|
||||
|
||||
// ── Join rooms ──────────────────────────────────────────────
|
||||
await test.step('All users join the voice room (some via search, some via invite)', async () => {
|
||||
for (const client of clients.slice(1)) {
|
||||
if (client.user.group === 'secondary-only') {
|
||||
// Group D: no primary signal -> join voice room via invite
|
||||
await client.page.goto(primaryRoomInviteUrl);
|
||||
await waitForInviteJoin(client.page);
|
||||
} else {
|
||||
// Groups A, B, C: have primary signal -> join via search
|
||||
await joinRoomFromSearch(client.page, VOICE_ROOM_NAME);
|
||||
}
|
||||
}
|
||||
|
||||
// Navigate client 0 back to voice room
|
||||
await openSavedRoomByName(clients[0].page, VOICE_ROOM_NAME);
|
||||
});
|
||||
|
||||
await test.step('All users also join the secondary chat room', async () => {
|
||||
for (const client of clients.slice(1)) {
|
||||
if (client.user.group === 'primary-only') {
|
||||
// Group B: no secondary signal -> join chat room via invite
|
||||
await client.page.goto(secondaryRoomInviteUrl);
|
||||
await waitForInviteJoin(client.page);
|
||||
} else if (client.user.group === 'secondary-only') {
|
||||
// Group D: has secondary -> join via search
|
||||
await openSearchView(client.page);
|
||||
await joinRoomFromSearch(client.page, SECONDARY_ROOM_NAME);
|
||||
} else {
|
||||
// Groups A, C: can search
|
||||
await openSearchView(client.page);
|
||||
await joinRoomFromSearch(client.page, SECONDARY_ROOM_NAME);
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure everyone navigates back to voice room
|
||||
for (const client of clients) {
|
||||
await openSavedRoomByName(client.page, VOICE_ROOM_NAME);
|
||||
}
|
||||
});
|
||||
|
||||
// ── Voice channel ───────────────────────────────────────────
|
||||
await test.step('Create voice channel and join all 8 users', async () => {
|
||||
const hostRoom = new ChatRoomPage(clients[0].page);
|
||||
|
||||
await hostRoom.ensureVoiceChannelExists(VOICE_CHANNEL);
|
||||
|
||||
for (const client of clients) {
|
||||
await joinVoiceChannelUntilConnected(client.page, VOICE_CHANNEL);
|
||||
}
|
||||
|
||||
for (const client of clients) {
|
||||
await waitForVoiceRosterCount(client.page, VOICE_CHANNEL, USER_COUNT);
|
||||
}
|
||||
});
|
||||
|
||||
// ── Audio mesh ──────────────────────────────────────────────
|
||||
await test.step('All users discover peers and audio flows pairwise', async () => {
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForPeerConnected(client.page, 45_000)
|
||||
));
|
||||
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForConnectedPeerCount(client.page, EXPECTED_REMOTE_PEERS, 90_000)
|
||||
));
|
||||
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForAudioStatsPresent(client.page, 30_000)
|
||||
));
|
||||
|
||||
await clients[0].page.waitForTimeout(5_000);
|
||||
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 90_000)
|
||||
));
|
||||
});
|
||||
|
||||
// ── Voice workspace roster ──────────────────────────────────
|
||||
await test.step('Voice workspace shows all 8 users on every client', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await openVoiceWorkspace(client.page);
|
||||
await expect(room.voiceWorkspace).toBeVisible({ timeout: 10_000 });
|
||||
await waitForVoiceWorkspaceUserCount(client.page, USER_COUNT);
|
||||
await waitForVoiceRosterCount(client.page, VOICE_CHANNEL, USER_COUNT);
|
||||
}
|
||||
});
|
||||
|
||||
// ── Stability + concurrent chat ─────────────────────────────
|
||||
await test.step('Voice stays stable 20s while some users navigate and chat on other servers', async () => {
|
||||
// Pick 2 users from different groups to navigate away and chat
|
||||
const chatters = [clients[2], clients[6]]; // group C + group D
|
||||
const stayers = clients.filter((clientItem) => !chatters.includes(clientItem));
|
||||
|
||||
// Chatters navigate to secondary room and send messages
|
||||
for (const chatter of chatters) {
|
||||
await openSavedRoomByName(chatter.page, SECONDARY_ROOM_NAME);
|
||||
await expect(chatter.page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 10_000 });
|
||||
}
|
||||
|
||||
const chatPage0 = new ChatMessagesPage(chatters[0].page);
|
||||
const chatPage1 = new ChatMessagesPage(chatters[1].page);
|
||||
|
||||
await chatPage0.sendMessage(`Hello from ${chatters[0].user.displayName} while in voice!`);
|
||||
await chatPage1.sendMessage(`Reply from ${chatters[1].user.displayName} also in voice!`);
|
||||
|
||||
// Verify messages arrive
|
||||
await expect(
|
||||
chatPage0.getMessageItemByText(`Reply from ${chatters[1].user.displayName}`)
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
await expect(
|
||||
chatPage1.getMessageItemByText(`Hello from ${chatters[0].user.displayName}`)
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
// Meanwhile stability loop on all clients (including chatters - voice still active)
|
||||
const deadline = Date.now() + STABILITY_WINDOW_MS;
|
||||
|
||||
while (Date.now() < deadline) {
|
||||
for (const client of stayers) {
|
||||
await expect.poll(async () => await getConnectedPeerCount(client.page), {
|
||||
timeout: 10_000,
|
||||
intervals: [500, 1_000]
|
||||
}).toBe(EXPECTED_REMOTE_PEERS);
|
||||
}
|
||||
|
||||
// Check chatters still have voice peers even while viewing another room
|
||||
for (const chatter of chatters) {
|
||||
await expect.poll(async () => await getConnectedPeerCount(chatter.page), {
|
||||
timeout: 10_000,
|
||||
intervals: [500, 1_000]
|
||||
}).toBe(EXPECTED_REMOTE_PEERS);
|
||||
}
|
||||
|
||||
if (Date.now() < deadline) {
|
||||
await clients[0].page.waitForTimeout(5_000);
|
||||
}
|
||||
}
|
||||
|
||||
// Navigate chatters back to voice room
|
||||
for (const chatter of chatters) {
|
||||
await openSavedRoomByName(chatter.page, VOICE_ROOM_NAME);
|
||||
}
|
||||
|
||||
// Verify audio still flowing after stability window
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// ── Mute ────────────────────────────────────────────────────
|
||||
await test.step('Mute state propagates for every user across all clients', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: false
|
||||
});
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: false,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Audio still flows on all peers after mute cycling', async () => {
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} post-mute RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// ── Deafen ──────────────────────────────────────────────────
|
||||
await test.step('Deafen state propagates for every user across all clients', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.deafenButton.click();
|
||||
await client.page.waitForTimeout(500);
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: true
|
||||
});
|
||||
|
||||
await room.deafenButton.click();
|
||||
await client.page.waitForTimeout(500);
|
||||
// Un-deafen does NOT restore mute - user stays muted
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Unmute all users and verify audio flows end-to-end', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: false,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} final RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
} finally {
|
||||
await secondaryServer.stop();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// ── User builders ────────────────────────────────────────────────────
|
||||
|
||||
function buildUsers(): TestUser[] {
|
||||
const groups: SignalGroup[] = [
|
||||
'both',
|
||||
'both', // 0-1
|
||||
'primary-only',
|
||||
'primary-only', // 2-3
|
||||
'both-then-remove-secondary',
|
||||
'both-then-remove-secondary', // 4-5
|
||||
'secondary-only',
|
||||
'secondary-only' // 6-7
|
||||
];
|
||||
|
||||
return groups.map((group, index) => ({
|
||||
username: `mixed_sig_${Date.now()}_${index + 1}`,
|
||||
displayName: `Mixed User ${index + 1}`,
|
||||
password: USER_PASSWORD,
|
||||
group
|
||||
}));
|
||||
}
|
||||
|
||||
// ── API helpers ──────────────────────────────────────────────────────
|
||||
|
||||
async function createInviteViaApi(
|
||||
serverBaseUrl: string,
|
||||
roomId: string,
|
||||
userId: string,
|
||||
displayName: string
|
||||
): Promise<{ id: string }> {
|
||||
const response = await fetch(`${serverBaseUrl}/api/servers/${roomId}/invites`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
requesterUserId: userId,
|
||||
requesterDisplayName: displayName
|
||||
})
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`Failed to create invite: ${response.status} ${await response.text()}`);
|
||||
}
|
||||
|
||||
return await response.json() as { id: string };
|
||||
}
|
||||
|
||||
async function getCurrentRoomId(page: Page): Promise<string> {
|
||||
return await page.evaluate(() => {
|
||||
interface RoomShape { id: string }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
throw new Error('Angular debug API unavailable');
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.();
|
||||
|
||||
if (!currentRoom?.id) {
|
||||
throw new Error('No current room');
|
||||
}
|
||||
|
||||
return currentRoom.id;
|
||||
});
|
||||
}
|
||||
|
||||
async function getCurrentUserId(page: Page): Promise<string> {
|
||||
return await page.evaluate(() => {
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
interface UserShape {
|
||||
id: string;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
throw new Error('Angular debug API unavailable');
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const user = (component['currentUser'] as (() => UserShape | null) | undefined)?.();
|
||||
|
||||
if (!user?.id) {
|
||||
throw new Error('Current user not found');
|
||||
}
|
||||
|
||||
return user.id;
|
||||
});
|
||||
}
|
||||
|
||||
// ── Navigation helpers ───────────────────────────────────────────────
|
||||
|
||||
async function installDeterministicVoiceSettings(page: Page): Promise<void> {
|
||||
await page.addInitScript(() => {
|
||||
localStorage.setItem('metoyou_voice_settings', JSON.stringify({
|
||||
inputVolume: 100,
|
||||
outputVolume: 100,
|
||||
audioBitrate: 96,
|
||||
latencyProfile: 'balanced',
|
||||
includeSystemAudio: false,
|
||||
noiseReduction: false,
|
||||
screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
}));
|
||||
});
|
||||
}
|
||||
|
||||
async function openSearchView(page: Page): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
if (await searchInput.isVisible().catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
await page.locator('button[title="Create Server"]').click();
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function joinRoomFromSearch(page: Page, roomName: string): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await searchInput.fill(roomName);
|
||||
|
||||
const roomCard = page.locator('div[title]', { hasText: roomName }).first();
|
||||
|
||||
await expect(roomCard).toBeVisible({ timeout: 20_000 });
|
||||
await roomCard.dblclick();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
await waitForCurrentRoomName(page, roomName);
|
||||
}
|
||||
|
||||
async function openSavedRoomByName(page: Page, roomName: string): Promise<void> {
|
||||
const roomButton = page.locator(`button[title="${roomName}"]`);
|
||||
|
||||
await expect(roomButton).toBeVisible({ timeout: 20_000 });
|
||||
await roomButton.click();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
await waitForCurrentRoomName(page, roomName);
|
||||
}
|
||||
|
||||
async function waitForInviteJoin(page: Page): Promise<void> {
|
||||
// Invite page loads -> auto-joins -> redirects to room
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 30_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function waitForCurrentRoomName(page: Page, roomName: string, timeout = 20_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(expectedRoomName) => {
|
||||
interface RoomShape { name?: string }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
|
||||
return currentRoom?.name === expectedRoomName;
|
||||
},
|
||||
roomName,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
async function openVoiceWorkspace(page: Page): Promise<void> {
|
||||
if (await page.locator('app-voice-workspace').isVisible()
|
||||
.catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
const viewButton = page.locator('app-rooms-side-panel').getByRole('button', { name: /view|open/i })
|
||||
.first();
|
||||
|
||||
await expect(viewButton).toBeVisible({ timeout: 10_000 });
|
||||
await viewButton.click();
|
||||
}
|
||||
|
||||
// ── Voice helpers ────────────────────────────────────────────────────
|
||||
|
||||
async function joinVoiceChannelUntilConnected(page: Page, channelName: string, attempts = 3): Promise<void> {
|
||||
const room = new ChatRoomPage(page);
|
||||
|
||||
let lastError: unknown;
|
||||
|
||||
for (let attempt = 1; attempt <= attempts; attempt++) {
|
||||
await room.joinVoiceChannel(channelName);
|
||||
|
||||
try {
|
||||
await waitForLocalVoiceChannelConnection(page, channelName, 20_000);
|
||||
await expect(room.muteButton).toBeVisible({ timeout: 10_000 });
|
||||
return;
|
||||
} catch (error) {
|
||||
lastError = error;
|
||||
await page.waitForTimeout(1_000);
|
||||
}
|
||||
}
|
||||
|
||||
const lastErrorMessage = lastError instanceof Error
|
||||
? `Last error: ${lastError.message}`
|
||||
: 'Last error: unavailable';
|
||||
|
||||
throw new Error(`Failed to connect ${page.url()} to voice channel ${channelName}.\n${lastErrorMessage}`);
|
||||
}
|
||||
|
||||
async function waitForLocalVoiceChannelConnection(page: Page, channelName: string, timeout = 20_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(name) => {
|
||||
interface VoiceStateShape { isConnected?: boolean; roomId?: string; serverId?: string }
|
||||
interface UserShape { voiceState?: VoiceStateShape }
|
||||
interface ChannelShape { id: string; name: string; type: 'text' | 'voice' }
|
||||
interface RoomShape { id: string; channels?: ChannelShape[] }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const currentUser = (component['currentUser'] as (() => UserShape | null) | undefined)?.() ?? null;
|
||||
const voiceChannel = currentRoom?.channels?.find((ch) => ch.type === 'voice' && ch.name === name);
|
||||
const voiceState = currentUser?.voiceState;
|
||||
|
||||
return !!voiceChannel
|
||||
&& voiceState?.isConnected === true
|
||||
&& voiceState.roomId === voiceChannel.id
|
||||
&& voiceState.serverId === currentRoom.id;
|
||||
},
|
||||
channelName,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
// ── Roster / state helpers ───────────────────────────────────────────
|
||||
|
||||
async function waitForVoiceWorkspaceUserCount(page: Page, expectedCount: number): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(count) => {
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-voice-workspace');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const connectedUsers = (component['connectedVoiceUsers'] as (() => unknown[]) | undefined)?.() ?? [];
|
||||
|
||||
return connectedUsers.length === count;
|
||||
},
|
||||
expectedCount,
|
||||
{ timeout: 45_000 }
|
||||
);
|
||||
}
|
||||
|
||||
async function waitForVoiceRosterCount(page: Page, channelName: string, expectedCount: number): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
({ expected, name }) => {
|
||||
interface ChannelShape { id: string; name: string; type: 'text' | 'voice' }
|
||||
interface RoomShape { channels?: ChannelShape[] }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const channelId = currentRoom?.channels?.find((ch) => ch.type === 'voice' && ch.name === name)?.id;
|
||||
|
||||
if (!channelId) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const roster = (component['voiceUsersInRoom'] as ((roomId: string) => unknown[]) | undefined)?.(channelId) ?? [];
|
||||
|
||||
return roster.length === expected;
|
||||
},
|
||||
{ expected: expectedCount, name: channelName },
|
||||
{ timeout: 30_000 }
|
||||
);
|
||||
}
|
||||
|
||||
async function waitForVoiceStateAcrossPages(
|
||||
clients: readonly TestClient[],
|
||||
displayName: string,
|
||||
expectedState: { isMuted: boolean; isDeafened: boolean }
|
||||
): Promise<void> {
|
||||
for (const client of clients) {
|
||||
await client.page.waitForFunction(
|
||||
({ expectedDisplayName, expectedMuted, expectedDeafened }) => {
|
||||
interface VoiceStateShape { isMuted?: boolean; isDeafened?: boolean }
|
||||
interface ChannelShape { id: string; name: string; type: 'text' | 'voice' }
|
||||
interface UserShape { displayName: string; voiceState?: VoiceStateShape }
|
||||
interface RoomShape { channels?: ChannelShape[] }
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const voiceChannel = currentRoom?.channels?.find((ch) => ch.type === 'voice');
|
||||
|
||||
if (!voiceChannel) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const roster = (component['voiceUsersInRoom'] as ((roomId: string) => UserShape[]) | undefined)?.(voiceChannel.id) ?? [];
|
||||
const entry = roster.find((userEntry) => userEntry.displayName === expectedDisplayName);
|
||||
|
||||
return entry?.voiceState?.isMuted === expectedMuted
|
||||
&& entry?.voiceState?.isDeafened === expectedDeafened;
|
||||
},
|
||||
{
|
||||
expectedDisplayName: displayName,
|
||||
expectedMuted: expectedState.isMuted,
|
||||
expectedDeafened: expectedState.isDeafened
|
||||
},
|
||||
{ timeout: 30_000 }
|
||||
);
|
||||
}
|
||||
}
|
||||
763
e2e/tests/voice/multi-signal-eight-user-voice.spec.ts
Normal file
763
e2e/tests/voice/multi-signal-eight-user-voice.spec.ts
Normal file
@@ -0,0 +1,763 @@
|
||||
import { expect, type Page } from '@playwright/test';
|
||||
import { test, type Client } from '../../fixtures/multi-client';
|
||||
import { installTestServerEndpoints, type SeededEndpointInput } from '../../helpers/seed-test-endpoint';
|
||||
import { startTestServer } from '../../helpers/test-server';
|
||||
import {
|
||||
dumpRtcDiagnostics,
|
||||
getConnectedPeerCount,
|
||||
installWebRTCTracking,
|
||||
waitForAllPeerAudioFlow,
|
||||
waitForAudioStatsPresent,
|
||||
waitForConnectedPeerCount,
|
||||
waitForPeerConnected
|
||||
} from '../../helpers/webrtc-helpers';
|
||||
import { RegisterPage } from '../../pages/register.page';
|
||||
import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
|
||||
const PRIMARY_SIGNAL_ID = 'e2e-test-server-a';
|
||||
const SECONDARY_SIGNAL_ID = 'e2e-test-server-b';
|
||||
const PRIMARY_ROOM_NAME = `Dual Signal Voice A ${Date.now()}`;
|
||||
const SECONDARY_ROOM_NAME = `Dual Signal Voice B ${Date.now()}`;
|
||||
const VOICE_CHANNEL = 'General';
|
||||
const USER_PASSWORD = 'TestPass123!';
|
||||
const USER_COUNT = 8;
|
||||
const EXPECTED_REMOTE_PEERS = USER_COUNT - 1;
|
||||
const STABILITY_WINDOW_MS = 20_000;
|
||||
|
||||
interface TestUser {
|
||||
username: string;
|
||||
displayName: string;
|
||||
password: string;
|
||||
}
|
||||
|
||||
type TestClient = Client & {
|
||||
user: TestUser;
|
||||
};
|
||||
|
||||
test.describe('Dual-signal multi-user voice', () => {
|
||||
test('keeps 8 users on 2 signal apis while voice, mute, and deafen stay consistent for 20+ seconds', async ({
|
||||
createClient,
|
||||
testServer
|
||||
}) => {
|
||||
test.setTimeout(720_000);
|
||||
|
||||
const secondaryServer = await startTestServer();
|
||||
|
||||
try {
|
||||
const endpoints: SeededEndpointInput[] = [
|
||||
{
|
||||
id: PRIMARY_SIGNAL_ID,
|
||||
name: 'E2E Signal A',
|
||||
url: testServer.url,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
},
|
||||
{
|
||||
id: SECONDARY_SIGNAL_ID,
|
||||
name: 'E2E Signal B',
|
||||
url: secondaryServer.url,
|
||||
isActive: true,
|
||||
status: 'online'
|
||||
}
|
||||
];
|
||||
const users = buildUsers();
|
||||
const clients = await createTrackedClients(createClient, users, endpoints);
|
||||
|
||||
await test.step('Register every user with both active endpoints available', async () => {
|
||||
for (const client of clients) {
|
||||
const registerPage = new RegisterPage(client.page);
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.serverSelect.selectOption(PRIMARY_SIGNAL_ID);
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Create primary and secondary rooms on different signal endpoints', async () => {
|
||||
const searchPage = new ServerSearchPage(clients[0].page);
|
||||
|
||||
await searchPage.createServer(PRIMARY_ROOM_NAME, {
|
||||
description: 'Primary signal room for 8-user voice mesh',
|
||||
sourceId: PRIMARY_SIGNAL_ID
|
||||
});
|
||||
|
||||
await expect(clients[0].page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
|
||||
await searchPage.createServer(SECONDARY_ROOM_NAME, {
|
||||
description: 'Secondary signal room for dual-socket coverage',
|
||||
sourceId: SECONDARY_SIGNAL_ID
|
||||
});
|
||||
|
||||
await expect(clients[0].page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
});
|
||||
|
||||
await test.step('Every user joins both rooms to keep 2 signal sockets open', async () => {
|
||||
for (const client of clients.slice(1)) {
|
||||
await joinRoomFromSearch(client.page, PRIMARY_ROOM_NAME);
|
||||
}
|
||||
|
||||
for (const client of clients.slice(1)) {
|
||||
await openSearchView(client.page);
|
||||
await joinRoomFromSearch(client.page, SECONDARY_ROOM_NAME);
|
||||
}
|
||||
|
||||
for (const client of clients) {
|
||||
await openSavedRoomByName(client.page, PRIMARY_ROOM_NAME);
|
||||
await waitForConnectedSignalManagerCount(client.page, 2);
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Create voice channel and join all 8 users', async () => {
|
||||
const hostRoom = new ChatRoomPage(clients[0].page);
|
||||
|
||||
await hostRoom.ensureVoiceChannelExists(VOICE_CHANNEL);
|
||||
|
||||
for (const client of clients) {
|
||||
await joinVoiceChannelUntilConnected(client.page, VOICE_CHANNEL);
|
||||
}
|
||||
|
||||
for (const client of clients) {
|
||||
await waitForVoiceRosterCount(client.page, VOICE_CHANNEL, USER_COUNT);
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('All users discover all peers and audio flows pairwise', async () => {
|
||||
// Wait for all clients to have at least one connected peer (fast)
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForPeerConnected(client.page, 45_000)
|
||||
));
|
||||
|
||||
// Wait for all clients to have all 7 peers connected
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForConnectedPeerCount(client.page, EXPECTED_REMOTE_PEERS, 90_000)
|
||||
));
|
||||
|
||||
// Wait for audio stats to appear on all clients
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForAudioStatsPresent(client.page, 30_000)
|
||||
));
|
||||
|
||||
// Allow the mesh to settle - voice routing, allowed-peer-id
|
||||
// propagation and renegotiation all need time after the last
|
||||
// user joins.
|
||||
await clients[0].page.waitForTimeout(5_000);
|
||||
|
||||
// Check bidirectional audio flow on each client
|
||||
await Promise.all(clients.map((client) =>
|
||||
waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 90_000)
|
||||
));
|
||||
});
|
||||
|
||||
await test.step('Voice workspace and side panel show all 8 users on every client', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await openVoiceWorkspace(client.page);
|
||||
await expect(room.voiceWorkspace).toBeVisible({ timeout: 10_000 });
|
||||
await waitForVoiceWorkspaceUserCount(client.page, USER_COUNT);
|
||||
await waitForVoiceRosterCount(client.page, VOICE_CHANNEL, USER_COUNT);
|
||||
await waitForConnectedSignalManagerCount(client.page, 2);
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Voice stays stable for more than 20 seconds across both signals', async () => {
|
||||
const deadline = Date.now() + STABILITY_WINDOW_MS;
|
||||
|
||||
while (Date.now() < deadline) {
|
||||
for (const client of clients) {
|
||||
await expect.poll(async () => await getConnectedPeerCount(client.page), {
|
||||
timeout: 10_000,
|
||||
intervals: [500, 1_000]
|
||||
}).toBe(EXPECTED_REMOTE_PEERS);
|
||||
|
||||
await expect.poll(async () => await getConnectedSignalManagerCount(client.page), {
|
||||
timeout: 10_000,
|
||||
intervals: [500, 1_000]
|
||||
}).toBe(2);
|
||||
}
|
||||
|
||||
if (Date.now() < deadline) {
|
||||
await clients[0].page.waitForTimeout(5_000);
|
||||
}
|
||||
}
|
||||
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Mute state propagates for every user across all clients', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: false
|
||||
});
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: false,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Audio still flows on all peers after mute cycling', async () => {
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} post-mute RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Deafen state propagates for every user across all clients', async () => {
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.deafenButton.click();
|
||||
await client.page.waitForTimeout(500);
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: true
|
||||
});
|
||||
|
||||
await room.deafenButton.click();
|
||||
await client.page.waitForTimeout(500);
|
||||
// Un-deafen does NOT restore mute - the user stays muted
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: true,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
await test.step('Unmute all users and verify audio flows end-to-end', async () => {
|
||||
// Every user is left muted after deafen cycling - unmute them all
|
||||
for (const client of clients) {
|
||||
const room = new ChatRoomPage(client.page);
|
||||
|
||||
await room.muteButton.click();
|
||||
await waitForVoiceStateAcrossPages(clients, client.user.displayName, {
|
||||
isMuted: false,
|
||||
isDeafened: false
|
||||
});
|
||||
}
|
||||
|
||||
// Final audio flow check on every peer - confirms the full
|
||||
// send/receive pipeline still works after mute+deafen cycling
|
||||
for (const client of clients) {
|
||||
try {
|
||||
await waitForAllPeerAudioFlow(client.page, EXPECTED_REMOTE_PEERS, 30_000);
|
||||
} catch (error) {
|
||||
console.log(`[${client.user.displayName} final RTC]\n${await dumpRtcDiagnostics(client.page)}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
});
|
||||
} finally {
|
||||
await secondaryServer.stop();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
function buildUsers(): TestUser[] {
|
||||
return Array.from({ length: USER_COUNT }, (_value, index) => ({
|
||||
username: `voice8_user_${Date.now()}_${index + 1}`,
|
||||
displayName: `Voice User ${index + 1}`,
|
||||
password: USER_PASSWORD
|
||||
}));
|
||||
}
|
||||
|
||||
async function createTrackedClients(
|
||||
createClient: () => Promise<Client>,
|
||||
users: TestUser[],
|
||||
endpoints: readonly SeededEndpointInput[]
|
||||
): Promise<TestClient[]> {
|
||||
const clients: TestClient[] = [];
|
||||
|
||||
for (const user of users) {
|
||||
const client = await createClient();
|
||||
|
||||
await installTestServerEndpoints(client.context, endpoints);
|
||||
await installDeterministicVoiceSettings(client.page);
|
||||
await installWebRTCTracking(client.page);
|
||||
|
||||
clients.push({
|
||||
...client,
|
||||
user
|
||||
});
|
||||
}
|
||||
|
||||
return clients;
|
||||
}
|
||||
|
||||
async function installDeterministicVoiceSettings(page: Page): Promise<void> {
|
||||
await page.addInitScript(() => {
|
||||
localStorage.setItem('metoyou_voice_settings', JSON.stringify({
|
||||
inputVolume: 100,
|
||||
outputVolume: 100,
|
||||
audioBitrate: 96,
|
||||
latencyProfile: 'balanced',
|
||||
includeSystemAudio: false,
|
||||
noiseReduction: false,
|
||||
screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
}));
|
||||
});
|
||||
}
|
||||
|
||||
async function openSearchView(page: Page): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
if (await searchInput.isVisible().catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
await page.locator('button[title="Create Server"]').click();
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function joinRoomFromSearch(page: Page, roomName: string): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await searchInput.fill(roomName);
|
||||
|
||||
const roomCard = page.locator('div[title]', { hasText: roomName }).first();
|
||||
|
||||
await expect(roomCard).toBeVisible({ timeout: 20_000 });
|
||||
await roomCard.dblclick();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
await waitForCurrentRoomName(page, roomName);
|
||||
}
|
||||
|
||||
async function openSavedRoomByName(page: Page, roomName: string): Promise<void> {
|
||||
const roomButton = page.locator(`button[title="${roomName}"]`);
|
||||
|
||||
await expect(roomButton).toBeVisible({ timeout: 20_000 });
|
||||
await roomButton.click();
|
||||
await expect(page).toHaveURL(/\/room\//, { timeout: 20_000 });
|
||||
await expect(page.locator('app-rooms-side-panel').first()).toBeVisible({ timeout: 20_000 });
|
||||
await waitForCurrentRoomName(page, roomName);
|
||||
}
|
||||
|
||||
async function waitForCurrentRoomName(page: Page, roomName: string, timeout = 20_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(expectedRoomName) => {
|
||||
interface RoomShape {
|
||||
name?: string;
|
||||
}
|
||||
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
|
||||
return currentRoom?.name === expectedRoomName;
|
||||
},
|
||||
roomName,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
async function openVoiceWorkspace(page: Page): Promise<void> {
|
||||
const viewButton = page.locator('app-rooms-side-panel').getByRole('button', { name: /view|open/i })
|
||||
.first();
|
||||
|
||||
if (await page.locator('app-voice-workspace').isVisible()
|
||||
.catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
await expect(viewButton).toBeVisible({ timeout: 10_000 });
|
||||
await viewButton.click();
|
||||
}
|
||||
|
||||
async function joinVoiceChannelUntilConnected(page: Page, channelName: string, attempts = 3): Promise<void> {
|
||||
const room = new ChatRoomPage(page);
|
||||
|
||||
let lastError: unknown;
|
||||
|
||||
for (let attempt = 1; attempt <= attempts; attempt++) {
|
||||
await room.joinVoiceChannel(channelName);
|
||||
|
||||
try {
|
||||
await waitForLocalVoiceChannelConnection(page, channelName, 20_000);
|
||||
await expect(room.muteButton).toBeVisible({ timeout: 10_000 });
|
||||
return;
|
||||
} catch (error) {
|
||||
lastError = error;
|
||||
await page.waitForTimeout(1_000);
|
||||
}
|
||||
}
|
||||
|
||||
const diagnostics = await getVoiceJoinDiagnostics(page, channelName);
|
||||
const displayName = diagnostics.currentUser?.displayName ?? 'Unknown user';
|
||||
|
||||
throw new Error([
|
||||
`Failed to connect ${displayName} to voice channel ${channelName}.`,
|
||||
lastError instanceof Error ? `Last error: ${lastError.message}` : 'Last error: unavailable',
|
||||
`Current room: ${diagnostics.currentRoom?.name ?? 'none'} (${diagnostics.currentRoom?.id ?? 'n/a'})`,
|
||||
`Current user id: ${diagnostics.currentUser?.id ?? 'none'} / ${diagnostics.currentUser?.oderId ?? 'none'}`,
|
||||
`Current user voice state: ${JSON.stringify(diagnostics.currentUser?.voiceState ?? null)}`,
|
||||
`Voice channel id: ${diagnostics.voiceChannel?.id ?? 'missing'}`,
|
||||
`Visible voice roster: ${diagnostics.voiceUsers.join(', ') || 'none'}`,
|
||||
`Connected signaling managers: ${diagnostics.connectedSignalCount}`,
|
||||
`Local voice facade state: ${JSON.stringify(diagnostics.localVoiceState)}`,
|
||||
`Voice connection error: ${diagnostics.connectionErrorMessage ?? 'none'}`
|
||||
].join('\n'));
|
||||
}
|
||||
|
||||
async function waitForLocalVoiceChannelConnection(page: Page, channelName: string, timeout = 20_000): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(name) => {
|
||||
interface VoiceStateShape {
|
||||
isConnected?: boolean;
|
||||
roomId?: string;
|
||||
serverId?: string;
|
||||
}
|
||||
|
||||
interface UserShape {
|
||||
voiceState?: VoiceStateShape;
|
||||
}
|
||||
|
||||
interface ChannelShape {
|
||||
id: string;
|
||||
name: string;
|
||||
type: 'text' | 'voice';
|
||||
}
|
||||
|
||||
interface RoomShape {
|
||||
id: string;
|
||||
channels?: ChannelShape[];
|
||||
}
|
||||
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const currentUser = (component['currentUser'] as (() => UserShape | null) | undefined)?.() ?? null;
|
||||
const voiceChannel = currentRoom?.channels?.find((channel) => channel.type === 'voice' && channel.name === name);
|
||||
const voiceState = currentUser?.voiceState;
|
||||
|
||||
return !!voiceChannel
|
||||
&& voiceState?.isConnected === true
|
||||
&& voiceState.roomId === voiceChannel.id
|
||||
&& voiceState.serverId === currentRoom.id;
|
||||
},
|
||||
channelName,
|
||||
{ timeout }
|
||||
);
|
||||
}
|
||||
|
||||
async function getVoiceJoinDiagnostics(page: Page, channelName: string): Promise<{
|
||||
connectedSignalCount: number;
|
||||
connectionErrorMessage: string | null;
|
||||
currentRoom: { id?: string; name?: string } | null;
|
||||
currentUser: { id?: string; oderId?: string; displayName?: string; voiceState?: Record<string, unknown> } | null;
|
||||
localVoiceState: {
|
||||
isVoiceConnected: boolean;
|
||||
localStreamTracks: number;
|
||||
rawMicTracks: number;
|
||||
};
|
||||
voiceChannel: { id?: string; name?: string } | null;
|
||||
voiceUsers: string[];
|
||||
}> {
|
||||
return await page.evaluate((name) => {
|
||||
interface VoiceStateShape {
|
||||
isConnected?: boolean;
|
||||
isMuted?: boolean;
|
||||
isDeafened?: boolean;
|
||||
roomId?: string;
|
||||
serverId?: string;
|
||||
}
|
||||
|
||||
interface UserShape {
|
||||
id?: string;
|
||||
oderId?: string;
|
||||
displayName?: string;
|
||||
voiceState?: VoiceStateShape;
|
||||
}
|
||||
|
||||
interface ChannelShape {
|
||||
id: string;
|
||||
name: string;
|
||||
type: 'text' | 'voice';
|
||||
}
|
||||
|
||||
interface RoomShape {
|
||||
id?: string;
|
||||
name?: string;
|
||||
channels?: ChannelShape[];
|
||||
}
|
||||
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return {
|
||||
connectedSignalCount: 0,
|
||||
connectionErrorMessage: 'Angular debug API unavailable',
|
||||
currentRoom: null,
|
||||
currentUser: null,
|
||||
localVoiceState: {
|
||||
isVoiceConnected: false,
|
||||
localStreamTracks: 0,
|
||||
rawMicTracks: 0
|
||||
},
|
||||
voiceChannel: null,
|
||||
voiceUsers: []
|
||||
};
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const currentUser = (component['currentUser'] as (() => UserShape | null) | undefined)?.() ?? null;
|
||||
const voiceChannel = currentRoom?.channels?.find((channel) => channel.type === 'voice' && channel.name === name) ?? null;
|
||||
const voiceUsers = voiceChannel
|
||||
? ((component['voiceUsersInRoom'] as ((roomId: string) => UserShape[]) | undefined)?.(voiceChannel.id) ?? [])
|
||||
.map((user) => user.displayName ?? 'Unknown user')
|
||||
: [];
|
||||
const voiceConnection = component['voiceConnection'] as {
|
||||
getLocalStream?: () => MediaStream | null;
|
||||
getRawMicStream?: () => MediaStream | null;
|
||||
isVoiceConnected?: () => boolean;
|
||||
} | undefined;
|
||||
const realtime = component['realtime'] as {
|
||||
connectionErrorMessage?: () => string | null;
|
||||
signalingTransportHandler?: {
|
||||
getConnectedSignalingManagers?: () => { signalUrl: string }[];
|
||||
};
|
||||
} | undefined;
|
||||
|
||||
return {
|
||||
connectedSignalCount: realtime?.signalingTransportHandler?.getConnectedSignalingManagers?.().length ?? 0,
|
||||
connectionErrorMessage: realtime?.connectionErrorMessage?.() ?? null,
|
||||
currentRoom,
|
||||
currentUser,
|
||||
localVoiceState: {
|
||||
isVoiceConnected: voiceConnection?.isVoiceConnected?.() ?? false,
|
||||
localStreamTracks: voiceConnection?.getLocalStream?.()?.getTracks().length ?? 0,
|
||||
rawMicTracks: voiceConnection?.getRawMicStream?.()?.getTracks().length ?? 0
|
||||
},
|
||||
voiceChannel,
|
||||
voiceUsers
|
||||
};
|
||||
}, channelName);
|
||||
}
|
||||
|
||||
async function waitForConnectedSignalManagerCount(page: Page, expectedCount: number): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(count) => {
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const realtime = component['realtime'] as {
|
||||
signalingTransportHandler?: {
|
||||
getConnectedSignalingManagers?: () => { signalUrl: string }[];
|
||||
};
|
||||
} | undefined;
|
||||
const countValue = realtime?.signalingTransportHandler?.getConnectedSignalingManagers?.().length ?? 0;
|
||||
|
||||
return countValue === count;
|
||||
},
|
||||
expectedCount,
|
||||
{ timeout: 30_000 }
|
||||
);
|
||||
}
|
||||
|
||||
async function getConnectedSignalManagerCount(page: Page): Promise<number> {
|
||||
return await page.evaluate(() => {
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const realtime = component['realtime'] as {
|
||||
signalingTransportHandler?: {
|
||||
getConnectedSignalingManagers?: () => { signalUrl: string }[];
|
||||
};
|
||||
} | undefined;
|
||||
|
||||
return realtime?.signalingTransportHandler?.getConnectedSignalingManagers?.().length ?? 0;
|
||||
});
|
||||
}
|
||||
|
||||
async function waitForVoiceWorkspaceUserCount(page: Page, expectedCount: number): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
(count) => {
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-voice-workspace');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const connectedUsers = (component['connectedVoiceUsers'] as (() => unknown[]) | undefined)?.() ?? [];
|
||||
|
||||
return connectedUsers.length === count;
|
||||
},
|
||||
expectedCount,
|
||||
{ timeout: 45_000 }
|
||||
);
|
||||
}
|
||||
|
||||
async function waitForVoiceRosterCount(page: Page, channelName: string, expectedCount: number): Promise<void> {
|
||||
await page.waitForFunction(
|
||||
({ expected, name }) => {
|
||||
interface ChannelShape {
|
||||
id: string;
|
||||
name: string;
|
||||
type: 'text' | 'voice';
|
||||
}
|
||||
|
||||
interface RoomShape {
|
||||
channels?: ChannelShape[];
|
||||
}
|
||||
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const channelId = currentRoom?.channels?.find((channel) => channel.type === 'voice' && channel.name === name)?.id;
|
||||
|
||||
if (!channelId) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const roster = (component['voiceUsersInRoom'] as ((roomId: string) => unknown[]) | undefined)?.(channelId) ?? [];
|
||||
|
||||
return roster.length === expected;
|
||||
},
|
||||
{ expected: expectedCount, name: channelName },
|
||||
{ timeout: 30_000 }
|
||||
);
|
||||
}
|
||||
|
||||
async function waitForVoiceStateAcrossPages(
|
||||
clients: readonly TestClient[],
|
||||
displayName: string,
|
||||
expectedState: { isMuted: boolean; isDeafened: boolean }
|
||||
): Promise<void> {
|
||||
for (const client of clients) {
|
||||
await client.page.waitForFunction(
|
||||
({ expectedDisplayName, expectedMuted, expectedDeafened }) => {
|
||||
interface VoiceStateShape {
|
||||
isMuted?: boolean;
|
||||
isDeafened?: boolean;
|
||||
}
|
||||
|
||||
interface ChannelShape {
|
||||
id: string;
|
||||
name: string;
|
||||
type: 'text' | 'voice';
|
||||
}
|
||||
|
||||
interface UserShape {
|
||||
displayName: string;
|
||||
voiceState?: VoiceStateShape;
|
||||
}
|
||||
|
||||
interface RoomShape {
|
||||
channels?: ChannelShape[];
|
||||
}
|
||||
|
||||
interface AngularDebugApi {
|
||||
getComponent: (element: Element) => Record<string, unknown>;
|
||||
}
|
||||
|
||||
const host = document.querySelector('app-rooms-side-panel');
|
||||
const debugApi = (window as { ng?: AngularDebugApi }).ng;
|
||||
|
||||
if (!host || !debugApi?.getComponent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const component = debugApi.getComponent(host);
|
||||
const currentRoom = (component['currentRoom'] as (() => RoomShape | null) | undefined)?.() ?? null;
|
||||
const voiceChannel = currentRoom?.channels?.find((channel) => channel.type === 'voice');
|
||||
|
||||
if (!voiceChannel) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const roster = (component['voiceUsersInRoom'] as ((roomId: string) => UserShape[]) | undefined)?.(voiceChannel.id) ?? [];
|
||||
const entry = roster.find((user) => user.displayName === expectedDisplayName);
|
||||
|
||||
return entry?.voiceState?.isMuted === expectedMuted
|
||||
&& entry?.voiceState?.isDeafened === expectedDeafened;
|
||||
},
|
||||
{
|
||||
expectedDisplayName: displayName,
|
||||
expectedMuted: expectedState.isMuted,
|
||||
expectedDeafened: expectedState.isDeafened
|
||||
},
|
||||
{ timeout: 30_000 }
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
import { test, expect } from '../../fixtures/multi-client';
|
||||
import {
|
||||
installWebRTCTracking,
|
||||
installAutoResumeAudioContext,
|
||||
waitForPeerConnected,
|
||||
isPeerStillConnected,
|
||||
getAudioStatsDelta,
|
||||
@@ -13,7 +14,7 @@ import { ServerSearchPage } from '../../pages/server-search.page';
|
||||
import { ChatRoomPage } from '../../pages/chat-room.page';
|
||||
|
||||
/**
|
||||
* Full user journey: register → create server → join → voice → verify audio
|
||||
* Full user journey: register -> create server -> join -> voice -> verify audio
|
||||
* for 10+ seconds of stable connectivity.
|
||||
*
|
||||
* Uses two independent browser contexts (Alice & Bob) to simulate real
|
||||
@@ -25,7 +26,7 @@ const BOB = { username: `bob_${Date.now()}`, displayName: 'Bob', password: 'Test
|
||||
const SERVER_NAME = `E2E Test Server ${Date.now()}`;
|
||||
const VOICE_CHANNEL = 'General';
|
||||
|
||||
test.describe('Full user journey: register → server → voice chat', () => {
|
||||
test.describe('Full user journey: register -> server -> voice chat', () => {
|
||||
test('two users register, create server, join voice, and stay connected 10+ seconds with audio', async ({ createClient }) => {
|
||||
test.setTimeout(180_000); // 3 min - covers registration, server creation, voice establishment, and 10s stability check
|
||||
|
||||
@@ -35,6 +36,20 @@ test.describe('Full user journey: register → server → voice chat', () => {
|
||||
// Install WebRTC tracking before any navigation
|
||||
await installWebRTCTracking(alice.page);
|
||||
await installWebRTCTracking(bob.page);
|
||||
await installAutoResumeAudioContext(alice.page);
|
||||
await installAutoResumeAudioContext(bob.page);
|
||||
|
||||
// Seed deterministic voice settings so noise reduction doesn't
|
||||
// swallow the fake audio tone.
|
||||
const voiceSettings = JSON.stringify({
|
||||
inputVolume: 100, outputVolume: 100, audioBitrate: 96,
|
||||
latencyProfile: 'balanced', includeSystemAudio: false,
|
||||
noiseReduction: false, screenShareQuality: 'balanced',
|
||||
askScreenShareQuality: false
|
||||
});
|
||||
|
||||
await alice.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
await bob.page.addInitScript((settingsValue: string) => localStorage.setItem('metoyou_voice_settings', settingsValue), voiceSettings);
|
||||
|
||||
// Forward browser console for debugging
|
||||
alice.page.on('console', msg => console.log('[Alice]', msg.text()));
|
||||
@@ -81,14 +96,7 @@ test.describe('Full user journey: register → server → voice chat', () => {
|
||||
await test.step('Bob finds and joins the server', async () => {
|
||||
const searchPage = new ServerSearchPage(bob.page);
|
||||
|
||||
// Search for the server
|
||||
await searchPage.searchInput.fill(SERVER_NAME);
|
||||
|
||||
// Wait for search results and click the server
|
||||
const serverCard = bob.page.locator('button', { hasText: SERVER_NAME }).first();
|
||||
|
||||
await expect(serverCard).toBeVisible({ timeout: 10_000 });
|
||||
await serverCard.click();
|
||||
await searchPage.joinServerFromSearch(SERVER_NAME);
|
||||
|
||||
// Bob should be in the room now
|
||||
await expect(bob.page).toHaveURL(/\/room\//, { timeout: 15_000 });
|
||||
@@ -146,8 +154,38 @@ test.describe('Full user journey: register → server → voice chat', () => {
|
||||
// ── Step 7: Verify audio is flowing in both directions ───────────
|
||||
|
||||
await test.step('Audio packets are flowing between Alice and Bob', async () => {
|
||||
const aliceDelta = await waitForAudioFlow(alice.page, 30_000);
|
||||
const bobDelta = await waitForAudioFlow(bob.page, 30_000);
|
||||
// Chromium's --use-fake-device-for-media-stream can produce a
|
||||
// silent capture track on the very first getUserMedia call. If
|
||||
// bidirectional audio doesn't flow within a short window, leave
|
||||
// and rejoin voice to re-acquire the mic.
|
||||
let aliceDelta = await waitForAudioFlow(alice.page, 15_000);
|
||||
let bobDelta = await waitForAudioFlow(bob.page, 15_000);
|
||||
|
||||
const isFlowing = (delta: typeof aliceDelta) =>
|
||||
(delta.outboundBytesDelta > 0 || delta.outboundPacketsDelta > 0) &&
|
||||
(delta.inboundBytesDelta > 0 || delta.inboundPacketsDelta > 0);
|
||||
|
||||
if (!isFlowing(aliceDelta) || !isFlowing(bobDelta)) {
|
||||
const aliceRoom = new ChatRoomPage(alice.page);
|
||||
const bobRoom = new ChatRoomPage(bob.page);
|
||||
|
||||
await aliceRoom.disconnectButton.click();
|
||||
await bobRoom.disconnectButton.click();
|
||||
await alice.page.waitForTimeout(2_000);
|
||||
|
||||
await aliceRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(alice.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
await bobRoom.joinVoiceChannel(VOICE_CHANNEL);
|
||||
await expect(bob.page.locator('app-voice-controls')).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
await waitForPeerConnected(alice.page, 30_000);
|
||||
await waitForPeerConnected(bob.page, 30_000);
|
||||
await waitForAudioStatsPresent(alice.page, 20_000);
|
||||
await waitForAudioStatsPresent(bob.page, 20_000);
|
||||
|
||||
aliceDelta = await waitForAudioFlow(alice.page, 30_000);
|
||||
bobDelta = await waitForAudioFlow(bob.page, 30_000);
|
||||
}
|
||||
|
||||
if (aliceDelta.outboundBytesDelta === 0 || aliceDelta.inboundBytesDelta === 0
|
||||
|| bobDelta.outboundBytesDelta === 0 || bobDelta.inboundBytesDelta === 0) {
|
||||
|
||||
33
electron/README.md
Normal file
33
electron/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Electron Shell
|
||||
|
||||
Electron main-process package for MetoYou / Toju. This directory owns desktop bootstrap, the preload bridge, IPC handlers, desktop persistence glue, updater integration, and window-level behavior.
|
||||
|
||||
## Commands
|
||||
|
||||
- `npm run build:electron` builds the Electron TypeScript output to `dist/electron`.
|
||||
- `npm run electron` builds the product client and Electron, then launches the desktop app.
|
||||
- `npm run electron:dev` starts the Angular client and Electron together.
|
||||
- `npm run dev` starts the full desktop stack: server, Angular client, and Electron.
|
||||
- `npm run electron:build`, `npm run electron:build:win`, `npm run electron:build:mac`, and `npm run electron:build:linux` create packaged desktop builds.
|
||||
|
||||
## Structure
|
||||
|
||||
| Path | Description |
|
||||
| --- | --- |
|
||||
| `main.ts` | Electron app bootstrap and process entry point |
|
||||
| `preload.ts` | Typed renderer-facing preload bridge |
|
||||
| `process-list.ts` | Linux/Windows process-name scan used by now-playing game detection |
|
||||
| `app/` | App lifecycle and startup composition |
|
||||
| `ipc/` | Renderer-invoked IPC handlers |
|
||||
| `cqrs/` | Local database command/query handlers and mappings |
|
||||
| `db/`, `entities/`, `migrations/` | Desktop persistence and schema evolution |
|
||||
| `audio/` | Desktop audio integrations |
|
||||
| `update/` | Desktop updater flow |
|
||||
| `window/` | Window creation and window-level behavior |
|
||||
|
||||
## Notes
|
||||
|
||||
- When adding a renderer-facing capability, update the Electron implementation, `preload.ts`, and the renderer bridge in `toju-app/` together.
|
||||
- Plugin client data is stored in the local Electron SQLite database in the dedicated `plugin_data` table. Renderer plugins reach it through CQRS commands/queries exposed by the preload bridge; the signal server must not be used for arbitrary plugin data persistence.
|
||||
- Treat `dist/electron/` and `dist-electron/` as generated output.
|
||||
- See [AGENTS.md](AGENTS.md) for package-level editing rules.
|
||||
@@ -5,6 +5,7 @@ import { createWindow, getMainWindow } from '../window/create-window';
|
||||
const CUSTOM_PROTOCOL = 'toju';
|
||||
const DEEP_LINK_PREFIX = `${CUSTOM_PROTOCOL}://`;
|
||||
const DEV_SINGLE_INSTANCE_EXIT_CODE_ENV = 'METOYOU_SINGLE_INSTANCE_EXIT_CODE';
|
||||
const DEV_RELOAD_EXISTING_ARG = '--metoyou-dev-reload-existing';
|
||||
|
||||
let pendingDeepLink: string | null = null;
|
||||
|
||||
@@ -95,6 +96,12 @@ export function initializeDeepLinkHandling(): boolean {
|
||||
}
|
||||
|
||||
app.on('second-instance', (_event, argv) => {
|
||||
if (resolveDevSingleInstanceExitCode() != null && argv.includes(DEV_RELOAD_EXISTING_ARG)) {
|
||||
app.relaunch();
|
||||
app.exit(0);
|
||||
return;
|
||||
}
|
||||
|
||||
focusMainWindow();
|
||||
|
||||
const deepLink = extractDeepLink(argv);
|
||||
|
||||
@@ -11,7 +11,8 @@ import {
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
} from '../../../entities';
|
||||
|
||||
export async function handleClearAllData(dataSource: DataSource): Promise<void> {
|
||||
@@ -27,4 +28,5 @@ export async function handleClearAllData(dataSource: DataSource): Promise<void>
|
||||
await dataSource.getRepository(BanEntity).clear();
|
||||
await dataSource.getRepository(AttachmentEntity).clear();
|
||||
await dataSource.getRepository(MetaEntity).clear();
|
||||
await dataSource.getRepository(PluginDataEntity).clear();
|
||||
}
|
||||
|
||||
14
electron/cqrs/commands/handlers/deletePluginData.ts
Normal file
14
electron/cqrs/commands/handlers/deletePluginData.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { PluginDataEntity } from '../../../entities';
|
||||
import { DeletePluginDataCommand } from '../../types';
|
||||
|
||||
export async function handleDeletePluginData(command: DeletePluginDataCommand, dataSource: DataSource): Promise<void> {
|
||||
const { payload } = command;
|
||||
|
||||
await dataSource.getRepository(PluginDataEntity).delete({
|
||||
key: payload.key,
|
||||
pluginId: payload.pluginId,
|
||||
scope: payload.scope,
|
||||
serverId: payload.serverId ?? ''
|
||||
});
|
||||
}
|
||||
10
electron/cqrs/commands/handlers/saveMeta.ts
Normal file
10
electron/cqrs/commands/handlers/saveMeta.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { MetaEntity } from '../../../entities';
|
||||
import { SaveMetaCommand } from '../../types';
|
||||
|
||||
export async function handleSaveMeta(command: SaveMetaCommand, dataSource: DataSource): Promise<void> {
|
||||
await dataSource.getRepository(MetaEntity).save({
|
||||
key: command.payload.key,
|
||||
value: command.payload.value
|
||||
});
|
||||
}
|
||||
16
electron/cqrs/commands/handlers/savePluginData.ts
Normal file
16
electron/cqrs/commands/handlers/savePluginData.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { PluginDataEntity } from '../../../entities';
|
||||
import { SavePluginDataCommand } from '../../types';
|
||||
|
||||
export async function handleSavePluginData(command: SavePluginDataCommand, dataSource: DataSource): Promise<void> {
|
||||
const { payload } = command;
|
||||
|
||||
await dataSource.getRepository(PluginDataEntity).save({
|
||||
key: payload.key,
|
||||
pluginId: payload.pluginId,
|
||||
scope: payload.scope,
|
||||
serverId: payload.serverId ?? '',
|
||||
updatedAt: Date.now(),
|
||||
valueJson: JSON.stringify(payload.value ?? null)
|
||||
});
|
||||
}
|
||||
@@ -18,7 +18,10 @@ import {
|
||||
SaveBanCommand,
|
||||
RemoveBanCommand,
|
||||
SaveAttachmentCommand,
|
||||
DeleteAttachmentsForMessageCommand
|
||||
DeleteAttachmentsForMessageCommand,
|
||||
SavePluginDataCommand,
|
||||
DeletePluginDataCommand,
|
||||
SaveMetaCommand
|
||||
} from '../types';
|
||||
import { handleSaveMessage } from './handlers/saveMessage';
|
||||
import { handleDeleteMessage } from './handlers/deleteMessage';
|
||||
@@ -36,6 +39,9 @@ import { handleSaveBan } from './handlers/saveBan';
|
||||
import { handleRemoveBan } from './handlers/removeBan';
|
||||
import { handleSaveAttachment } from './handlers/saveAttachment';
|
||||
import { handleDeleteAttachmentsForMessage } from './handlers/deleteAttachmentsForMessage';
|
||||
import { handleSavePluginData } from './handlers/savePluginData';
|
||||
import { handleDeletePluginData } from './handlers/deletePluginData';
|
||||
import { handleSaveMeta } from './handlers/saveMeta';
|
||||
import { handleClearAllData } from './handlers/clearAllData';
|
||||
|
||||
export const buildCommandHandlers = (dataSource: DataSource): Record<CommandTypeKey, (command: Command) => Promise<unknown>> => ({
|
||||
@@ -55,5 +61,8 @@ export const buildCommandHandlers = (dataSource: DataSource): Record<CommandType
|
||||
[CommandType.RemoveBan]: (cmd) => handleRemoveBan(cmd as RemoveBanCommand, dataSource),
|
||||
[CommandType.SaveAttachment]: (cmd) => handleSaveAttachment(cmd as SaveAttachmentCommand, dataSource),
|
||||
[CommandType.DeleteAttachmentsForMessage]: (cmd) => handleDeleteAttachmentsForMessage(cmd as DeleteAttachmentsForMessageCommand, dataSource),
|
||||
[CommandType.SavePluginData]: (cmd) => handleSavePluginData(cmd as SavePluginDataCommand, dataSource),
|
||||
[CommandType.DeletePluginData]: (cmd) => handleDeletePluginData(cmd as DeletePluginDataCommand, dataSource),
|
||||
[CommandType.SaveMeta]: (cmd) => handleSaveMeta(cmd as SaveMetaCommand, dataSource),
|
||||
[CommandType.ClearAllData]: () => handleClearAllData(dataSource)
|
||||
});
|
||||
|
||||
9
electron/cqrs/queries/handlers/getCurrentUserId.ts
Normal file
9
electron/cqrs/queries/handlers/getCurrentUserId.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { MetaEntity } from '../../../entities';
|
||||
|
||||
export async function handleGetCurrentUserId(dataSource: DataSource): Promise<string | null> {
|
||||
const metaRepo = dataSource.getRepository(MetaEntity);
|
||||
const metaRow = await metaRepo.findOne({ where: { key: 'currentUserId' } });
|
||||
|
||||
return metaRow?.value?.trim() || null;
|
||||
}
|
||||
11
electron/cqrs/queries/handlers/getMeta.ts
Normal file
11
electron/cqrs/queries/handlers/getMeta.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { MetaEntity } from '../../../entities';
|
||||
import { GetMetaQuery } from '../../types';
|
||||
|
||||
export async function handleGetMeta(query: GetMetaQuery, dataSource: DataSource): Promise<string | null> {
|
||||
const meta = await dataSource.getRepository(MetaEntity).findOne({
|
||||
where: { key: query.payload.key }
|
||||
});
|
||||
|
||||
return meta?.value ?? null;
|
||||
}
|
||||
25
electron/cqrs/queries/handlers/getPluginData.ts
Normal file
25
electron/cqrs/queries/handlers/getPluginData.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { PluginDataEntity } from '../../../entities';
|
||||
import { GetPluginDataQuery } from '../../types';
|
||||
|
||||
export async function handleGetPluginData(query: GetPluginDataQuery, dataSource: DataSource): Promise<unknown> {
|
||||
const { payload } = query;
|
||||
const record = await dataSource.getRepository(PluginDataEntity).findOne({
|
||||
where: {
|
||||
key: payload.key,
|
||||
pluginId: payload.pluginId,
|
||||
scope: payload.scope,
|
||||
serverId: payload.serverId ?? ''
|
||||
}
|
||||
});
|
||||
|
||||
if (!record) {
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
return JSON.parse(record.valueJson) as unknown;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,9 @@ import {
|
||||
GetRoomQuery,
|
||||
GetBansForRoomQuery,
|
||||
IsUserBannedQuery,
|
||||
GetAttachmentsForMessageQuery
|
||||
GetAttachmentsForMessageQuery,
|
||||
GetPluginDataQuery,
|
||||
GetMetaQuery
|
||||
} from '../types';
|
||||
import { handleGetMessages } from './handlers/getMessages';
|
||||
import { handleGetMessagesSince } from './handlers/getMessagesSince';
|
||||
@@ -19,6 +21,7 @@ import { handleGetMessageById } from './handlers/getMessageById';
|
||||
import { handleGetReactionsForMessage } from './handlers/getReactionsForMessage';
|
||||
import { handleGetUser } from './handlers/getUser';
|
||||
import { handleGetCurrentUser } from './handlers/getCurrentUser';
|
||||
import { handleGetCurrentUserId } from './handlers/getCurrentUserId';
|
||||
import { handleGetUsersByRoom } from './handlers/getUsersByRoom';
|
||||
import { handleGetRoom } from './handlers/getRoom';
|
||||
import { handleGetAllRooms } from './handlers/getAllRooms';
|
||||
@@ -26,6 +29,8 @@ import { handleGetBansForRoom } from './handlers/getBansForRoom';
|
||||
import { handleIsUserBanned } from './handlers/isUserBanned';
|
||||
import { handleGetAttachmentsForMessage } from './handlers/getAttachmentsForMessage';
|
||||
import { handleGetAllAttachments } from './handlers/getAllAttachments';
|
||||
import { handleGetPluginData } from './handlers/getPluginData';
|
||||
import { handleGetMeta } from './handlers/getMeta';
|
||||
|
||||
export const buildQueryHandlers = (dataSource: DataSource): Record<QueryTypeKey, (query: Query) => Promise<unknown>> => ({
|
||||
[QueryType.GetMessages]: (query) => handleGetMessages(query as GetMessagesQuery, dataSource),
|
||||
@@ -34,11 +39,14 @@ export const buildQueryHandlers = (dataSource: DataSource): Record<QueryTypeKey,
|
||||
[QueryType.GetReactionsForMessage]: (query) => handleGetReactionsForMessage(query as GetReactionsForMessageQuery, dataSource),
|
||||
[QueryType.GetUser]: (query) => handleGetUser(query as GetUserQuery, dataSource),
|
||||
[QueryType.GetCurrentUser]: () => handleGetCurrentUser(dataSource),
|
||||
[QueryType.GetCurrentUserId]: () => handleGetCurrentUserId(dataSource),
|
||||
[QueryType.GetUsersByRoom]: () => handleGetUsersByRoom(dataSource),
|
||||
[QueryType.GetRoom]: (query) => handleGetRoom(query as GetRoomQuery, dataSource),
|
||||
[QueryType.GetAllRooms]: () => handleGetAllRooms(dataSource),
|
||||
[QueryType.GetBansForRoom]: (query) => handleGetBansForRoom(query as GetBansForRoomQuery, dataSource),
|
||||
[QueryType.IsUserBanned]: (query) => handleIsUserBanned(query as IsUserBannedQuery, dataSource),
|
||||
[QueryType.GetAttachmentsForMessage]: (query) => handleGetAttachmentsForMessage(query as GetAttachmentsForMessageQuery, dataSource),
|
||||
[QueryType.GetAllAttachments]: () => handleGetAllAttachments(dataSource)
|
||||
[QueryType.GetAllAttachments]: () => handleGetAllAttachments(dataSource),
|
||||
[QueryType.GetPluginData]: (query) => handleGetPluginData(query as GetPluginDataQuery, dataSource),
|
||||
[QueryType.GetMeta]: (query) => handleGetMeta(query as GetMetaQuery, dataSource)
|
||||
});
|
||||
|
||||
@@ -15,6 +15,9 @@ export const CommandType = {
|
||||
RemoveBan: 'remove-ban',
|
||||
SaveAttachment: 'save-attachment',
|
||||
DeleteAttachmentsForMessage: 'delete-attachments-for-message',
|
||||
SavePluginData: 'save-plugin-data',
|
||||
DeletePluginData: 'delete-plugin-data',
|
||||
SaveMeta: 'save-meta',
|
||||
ClearAllData: 'clear-all-data'
|
||||
} as const;
|
||||
|
||||
@@ -27,13 +30,16 @@ export const QueryType = {
|
||||
GetReactionsForMessage: 'get-reactions-for-message',
|
||||
GetUser: 'get-user',
|
||||
GetCurrentUser: 'get-current-user',
|
||||
GetCurrentUserId: 'get-current-user-id',
|
||||
GetUsersByRoom: 'get-users-by-room',
|
||||
GetRoom: 'get-room',
|
||||
GetAllRooms: 'get-all-rooms',
|
||||
GetBansForRoom: 'get-bans-for-room',
|
||||
IsUserBanned: 'is-user-banned',
|
||||
GetAttachmentsForMessage: 'get-attachments-for-message',
|
||||
GetAllAttachments: 'get-all-attachments'
|
||||
GetAllAttachments: 'get-all-attachments',
|
||||
GetPluginData: 'get-plugin-data',
|
||||
GetMeta: 'get-meta'
|
||||
} as const;
|
||||
|
||||
export type QueryTypeKey = typeof QueryType[keyof typeof QueryType];
|
||||
@@ -171,6 +177,16 @@ export interface AttachmentPayload {
|
||||
savedPath?: string;
|
||||
}
|
||||
|
||||
export type PluginDataScopePayload = 'local' | 'server';
|
||||
|
||||
export interface PluginDataPayload {
|
||||
key: string;
|
||||
pluginId: string;
|
||||
scope: PluginDataScopePayload;
|
||||
serverId?: string;
|
||||
value: unknown;
|
||||
}
|
||||
|
||||
export interface SaveMessageCommand { type: typeof CommandType.SaveMessage; payload: { message: MessagePayload } }
|
||||
export interface DeleteMessageCommand { type: typeof CommandType.DeleteMessage; payload: { messageId: string } }
|
||||
export interface UpdateMessageCommand { type: typeof CommandType.UpdateMessage; payload: { messageId: string; updates: Partial<MessagePayload> } }
|
||||
@@ -187,6 +203,9 @@ export interface SaveBanCommand { type: typeof CommandType.SaveBan; payload: { b
|
||||
export interface RemoveBanCommand { type: typeof CommandType.RemoveBan; payload: { oderId: string } }
|
||||
export interface SaveAttachmentCommand { type: typeof CommandType.SaveAttachment; payload: { attachment: AttachmentPayload } }
|
||||
export interface DeleteAttachmentsForMessageCommand { type: typeof CommandType.DeleteAttachmentsForMessage; payload: { messageId: string } }
|
||||
export interface SavePluginDataCommand { type: typeof CommandType.SavePluginData; payload: PluginDataPayload }
|
||||
export interface DeletePluginDataCommand { type: typeof CommandType.DeletePluginData; payload: Omit<PluginDataPayload, 'value'> }
|
||||
export interface SaveMetaCommand { type: typeof CommandType.SaveMeta; payload: { key: string; value: string | null } }
|
||||
export interface ClearAllDataCommand { type: typeof CommandType.ClearAllData; payload: Record<string, never> }
|
||||
|
||||
export type Command =
|
||||
@@ -206,6 +225,9 @@ export type Command =
|
||||
| RemoveBanCommand
|
||||
| SaveAttachmentCommand
|
||||
| DeleteAttachmentsForMessageCommand
|
||||
| SavePluginDataCommand
|
||||
| DeletePluginDataCommand
|
||||
| SaveMetaCommand
|
||||
| ClearAllDataCommand;
|
||||
|
||||
export interface GetMessagesQuery { type: typeof QueryType.GetMessages; payload: { roomId: string; limit?: number; offset?: number } }
|
||||
@@ -214,6 +236,7 @@ export interface GetMessageByIdQuery { type: typeof QueryType.GetMessageById; pa
|
||||
export interface GetReactionsForMessageQuery { type: typeof QueryType.GetReactionsForMessage; payload: { messageId: string } }
|
||||
export interface GetUserQuery { type: typeof QueryType.GetUser; payload: { userId: string } }
|
||||
export interface GetCurrentUserQuery { type: typeof QueryType.GetCurrentUser; payload: Record<string, never> }
|
||||
export interface GetCurrentUserIdQuery { type: typeof QueryType.GetCurrentUserId; payload: Record<string, never> }
|
||||
export interface GetUsersByRoomQuery { type: typeof QueryType.GetUsersByRoom; payload: { roomId: string } }
|
||||
export interface GetRoomQuery { type: typeof QueryType.GetRoom; payload: { roomId: string } }
|
||||
export interface GetAllRoomsQuery { type: typeof QueryType.GetAllRooms; payload: Record<string, never> }
|
||||
@@ -221,6 +244,8 @@ export interface GetBansForRoomQuery { type: typeof QueryType.GetBansForRoom; pa
|
||||
export interface IsUserBannedQuery { type: typeof QueryType.IsUserBanned; payload: { userId: string; roomId: string } }
|
||||
export interface GetAttachmentsForMessageQuery { type: typeof QueryType.GetAttachmentsForMessage; payload: { messageId: string } }
|
||||
export interface GetAllAttachmentsQuery { type: typeof QueryType.GetAllAttachments; payload: Record<string, never> }
|
||||
export interface GetPluginDataQuery { type: typeof QueryType.GetPluginData; payload: Omit<PluginDataPayload, 'value'> }
|
||||
export interface GetMetaQuery { type: typeof QueryType.GetMeta; payload: { key: string } }
|
||||
|
||||
export type Query =
|
||||
| GetMessagesQuery
|
||||
@@ -229,10 +254,13 @@ export type Query =
|
||||
| GetReactionsForMessageQuery
|
||||
| GetUserQuery
|
||||
| GetCurrentUserQuery
|
||||
| GetCurrentUserIdQuery
|
||||
| GetUsersByRoomQuery
|
||||
| GetRoomQuery
|
||||
| GetAllRoomsQuery
|
||||
| GetBansForRoomQuery
|
||||
| IsUserBannedQuery
|
||||
| GetAttachmentsForMessageQuery
|
||||
| GetAllAttachmentsQuery;
|
||||
| GetAllAttachmentsQuery
|
||||
| GetPluginDataQuery
|
||||
| GetMetaQuery;
|
||||
|
||||
229
electron/data-archive.ts
Normal file
229
electron/data-archive.ts
Normal file
@@ -0,0 +1,229 @@
|
||||
import * as fsp from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
|
||||
export interface ZipArchiveEntry {
|
||||
data: Buffer;
|
||||
path: string;
|
||||
}
|
||||
|
||||
interface CentralDirectoryEntry {
|
||||
compressedSize: number;
|
||||
crc: number;
|
||||
data: Buffer;
|
||||
localHeaderOffset: number;
|
||||
name: Buffer;
|
||||
uncompressedSize: number;
|
||||
}
|
||||
|
||||
const ZIP_LOCAL_FILE_HEADER_SIGNATURE = 0x04034b50;
|
||||
const ZIP_CENTRAL_DIRECTORY_SIGNATURE = 0x02014b50;
|
||||
const ZIP_END_OF_CENTRAL_DIRECTORY_SIGNATURE = 0x06054b50;
|
||||
const ZIP_UTF8_FLAG = 0x0800;
|
||||
const ZIP_STORE_METHOD = 0;
|
||||
const ZIP_VERSION = 20;
|
||||
const MAX_UINT32 = 0xffffffff;
|
||||
|
||||
const crcTable = buildCrcTable();
|
||||
|
||||
export function createZipArchive(entries: ZipArchiveEntry[]): Buffer {
|
||||
const localParts: Buffer[] = [];
|
||||
const centralEntries: CentralDirectoryEntry[] = [];
|
||||
let offset = 0;
|
||||
|
||||
for (const entry of entries) {
|
||||
const normalizedPath = normalizeZipPath(entry.path);
|
||||
const name = Buffer.from(normalizedPath, 'utf8');
|
||||
const data = entry.data;
|
||||
|
||||
if (name.length > 0xffff || data.length > MAX_UINT32 || offset > MAX_UINT32) {
|
||||
throw new Error('Data archive is too large for the portable ZIP format.');
|
||||
}
|
||||
|
||||
const crc = crc32(data);
|
||||
const localHeader = Buffer.alloc(30);
|
||||
|
||||
localHeader.writeUInt32LE(ZIP_LOCAL_FILE_HEADER_SIGNATURE, 0);
|
||||
localHeader.writeUInt16LE(ZIP_VERSION, 4);
|
||||
localHeader.writeUInt16LE(ZIP_UTF8_FLAG, 6);
|
||||
localHeader.writeUInt16LE(ZIP_STORE_METHOD, 8);
|
||||
localHeader.writeUInt16LE(0, 10);
|
||||
localHeader.writeUInt16LE(0, 12);
|
||||
localHeader.writeUInt32LE(crc, 14);
|
||||
localHeader.writeUInt32LE(data.length, 18);
|
||||
localHeader.writeUInt32LE(data.length, 22);
|
||||
localHeader.writeUInt16LE(name.length, 26);
|
||||
localHeader.writeUInt16LE(0, 28);
|
||||
|
||||
localParts.push(localHeader, name, data);
|
||||
centralEntries.push({
|
||||
compressedSize: data.length,
|
||||
crc,
|
||||
data,
|
||||
localHeaderOffset: offset,
|
||||
name,
|
||||
uncompressedSize: data.length
|
||||
});
|
||||
|
||||
offset += localHeader.length + name.length + data.length;
|
||||
}
|
||||
|
||||
const centralDirectoryOffset = offset;
|
||||
const centralParts = centralEntries.map((entry) => {
|
||||
const header = Buffer.alloc(46);
|
||||
|
||||
header.writeUInt32LE(ZIP_CENTRAL_DIRECTORY_SIGNATURE, 0);
|
||||
header.writeUInt16LE(ZIP_VERSION, 4);
|
||||
header.writeUInt16LE(ZIP_VERSION, 6);
|
||||
header.writeUInt16LE(ZIP_UTF8_FLAG, 8);
|
||||
header.writeUInt16LE(ZIP_STORE_METHOD, 10);
|
||||
header.writeUInt16LE(0, 12);
|
||||
header.writeUInt16LE(0, 14);
|
||||
header.writeUInt32LE(entry.crc, 16);
|
||||
header.writeUInt32LE(entry.compressedSize, 20);
|
||||
header.writeUInt32LE(entry.uncompressedSize, 24);
|
||||
header.writeUInt16LE(entry.name.length, 28);
|
||||
header.writeUInt16LE(0, 30);
|
||||
header.writeUInt16LE(0, 32);
|
||||
header.writeUInt16LE(0, 34);
|
||||
header.writeUInt16LE(0, 36);
|
||||
header.writeUInt32LE(0, 38);
|
||||
header.writeUInt32LE(entry.localHeaderOffset, 42);
|
||||
|
||||
offset += header.length + entry.name.length;
|
||||
|
||||
return Buffer.concat([header, entry.name]);
|
||||
});
|
||||
|
||||
const centralDirectorySize = offset - centralDirectoryOffset;
|
||||
|
||||
if (centralEntries.length > 0xffff || centralDirectoryOffset > MAX_UINT32 || centralDirectorySize > MAX_UINT32) {
|
||||
throw new Error('Data archive is too large for the portable ZIP format.');
|
||||
}
|
||||
|
||||
const end = Buffer.alloc(22);
|
||||
|
||||
end.writeUInt32LE(ZIP_END_OF_CENTRAL_DIRECTORY_SIGNATURE, 0);
|
||||
end.writeUInt16LE(0, 4);
|
||||
end.writeUInt16LE(0, 6);
|
||||
end.writeUInt16LE(centralEntries.length, 8);
|
||||
end.writeUInt16LE(centralEntries.length, 10);
|
||||
end.writeUInt32LE(centralDirectorySize, 12);
|
||||
end.writeUInt32LE(centralDirectoryOffset, 16);
|
||||
end.writeUInt16LE(0, 20);
|
||||
|
||||
return Buffer.concat([...localParts, ...centralParts, end]);
|
||||
}
|
||||
|
||||
export function readZipArchive(data: Buffer): ZipArchiveEntry[] {
|
||||
const endOffset = findEndOfCentralDirectory(data);
|
||||
|
||||
if (endOffset < 0) {
|
||||
throw new Error('The selected file is not a supported data archive.');
|
||||
}
|
||||
|
||||
const entryCount = data.readUInt16LE(endOffset + 10);
|
||||
const centralDirectoryOffset = data.readUInt32LE(endOffset + 16);
|
||||
const entries: ZipArchiveEntry[] = [];
|
||||
let offset = centralDirectoryOffset;
|
||||
|
||||
for (let index = 0; index < entryCount; index += 1) {
|
||||
if (data.readUInt32LE(offset) !== ZIP_CENTRAL_DIRECTORY_SIGNATURE) {
|
||||
throw new Error('The data archive directory is invalid.');
|
||||
}
|
||||
|
||||
const method = data.readUInt16LE(offset + 10);
|
||||
const compressedSize = data.readUInt32LE(offset + 20);
|
||||
const uncompressedSize = data.readUInt32LE(offset + 24);
|
||||
const nameLength = data.readUInt16LE(offset + 28);
|
||||
const extraLength = data.readUInt16LE(offset + 30);
|
||||
const commentLength = data.readUInt16LE(offset + 32);
|
||||
const localHeaderOffset = data.readUInt32LE(offset + 42);
|
||||
const entryPath = normalizeZipPath(data.subarray(offset + 46, offset + 46 + nameLength).toString('utf8'));
|
||||
|
||||
if (method !== ZIP_STORE_METHOD || compressedSize !== uncompressedSize) {
|
||||
throw new Error('Compressed data archives are not supported by this build.');
|
||||
}
|
||||
|
||||
if (data.readUInt32LE(localHeaderOffset) !== ZIP_LOCAL_FILE_HEADER_SIGNATURE) {
|
||||
throw new Error('The data archive contains an invalid file entry.');
|
||||
}
|
||||
|
||||
const localNameLength = data.readUInt16LE(localHeaderOffset + 26);
|
||||
const localExtraLength = data.readUInt16LE(localHeaderOffset + 28);
|
||||
const dataOffset = localHeaderOffset + 30 + localNameLength + localExtraLength;
|
||||
|
||||
entries.push({
|
||||
data: Buffer.from(data.subarray(dataOffset, dataOffset + compressedSize)),
|
||||
path: entryPath
|
||||
});
|
||||
|
||||
offset += 46 + nameLength + extraLength + commentLength;
|
||||
}
|
||||
|
||||
return entries;
|
||||
}
|
||||
|
||||
export async function extractZipEntries(entries: ZipArchiveEntry[], destinationPath: string): Promise<void> {
|
||||
const destinationRoot = path.resolve(destinationPath);
|
||||
|
||||
for (const entry of entries) {
|
||||
const targetPath = path.resolve(destinationRoot, entry.path);
|
||||
|
||||
if (!targetPath.startsWith(destinationRoot + path.sep) && targetPath !== destinationRoot) {
|
||||
throw new Error('The data archive contains an unsafe path.');
|
||||
}
|
||||
|
||||
await fsp.mkdir(path.dirname(targetPath), { recursive: true });
|
||||
await fsp.writeFile(targetPath, entry.data);
|
||||
}
|
||||
}
|
||||
|
||||
function findEndOfCentralDirectory(data: Buffer): number {
|
||||
const minimumOffset = Math.max(0, data.length - 0xffff - 22);
|
||||
|
||||
for (let offset = data.length - 22; offset >= minimumOffset; offset -= 1) {
|
||||
if (data.readUInt32LE(offset) === ZIP_END_OF_CENTRAL_DIRECTORY_SIGNATURE) {
|
||||
return offset;
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
function normalizeZipPath(value: string): string {
|
||||
const normalized = value.replace(/\\/g, '/').replace(/^\/+/, '');
|
||||
|
||||
if (!normalized || normalized.split('/').some((part) => part === '..' || part === '')) {
|
||||
throw new Error('The data archive contains an unsafe path.');
|
||||
}
|
||||
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function buildCrcTable(): number[] {
|
||||
const table: number[] = [];
|
||||
|
||||
for (let index = 0; index < 256; index += 1) {
|
||||
let value = index;
|
||||
|
||||
for (let bit = 0; bit < 8; bit += 1) {
|
||||
value = (value & 1) !== 0
|
||||
? 0xedb88320 ^ (value >>> 1)
|
||||
: value >>> 1;
|
||||
}
|
||||
|
||||
table[index] = value >>> 0;
|
||||
}
|
||||
|
||||
return table;
|
||||
}
|
||||
|
||||
function crc32(data: Buffer): number {
|
||||
let crc = 0xffffffff;
|
||||
|
||||
for (const byte of data) {
|
||||
crc = crcTable[(crc ^ byte) & 0xff] ^ (crc >>> 8);
|
||||
}
|
||||
|
||||
return (crc ^ 0xffffffff) >>> 0;
|
||||
}
|
||||
257
electron/data-management.ts
Normal file
257
electron/data-management.ts
Normal file
@@ -0,0 +1,257 @@
|
||||
import {
|
||||
app,
|
||||
dialog,
|
||||
shell
|
||||
} from 'electron';
|
||||
import * as fsp from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
import { destroyDatabase, initializeDatabase } from './db/database';
|
||||
import {
|
||||
createZipArchive,
|
||||
extractZipEntries,
|
||||
readZipArchive,
|
||||
type ZipArchiveEntry
|
||||
} from './data-archive';
|
||||
|
||||
export interface ExportUserDataResult {
|
||||
cancelled: boolean;
|
||||
exported: boolean;
|
||||
filePath?: string;
|
||||
}
|
||||
|
||||
export interface ImportUserDataResult {
|
||||
backupPath?: string;
|
||||
cancelled: boolean;
|
||||
imported: boolean;
|
||||
restartRequired: boolean;
|
||||
}
|
||||
|
||||
export interface EraseUserDataResult {
|
||||
erased: boolean;
|
||||
restartRequired: boolean;
|
||||
}
|
||||
|
||||
const ARCHIVE_MANIFEST_PATH = 'metoyou-data-manifest.json';
|
||||
const ARCHIVE_DATA_PREFIX = 'data/';
|
||||
const BACKUP_DIRECTORY_NAME = 'metoyou-data-backups';
|
||||
|
||||
export async function openCurrentDataFolder(): Promise<boolean> {
|
||||
const error = await shell.openPath(app.getPath('userData'));
|
||||
|
||||
return error.length === 0;
|
||||
}
|
||||
|
||||
export async function exportUserData(): Promise<ExportUserDataResult> {
|
||||
const dataPath = app.getPath('userData');
|
||||
const defaultFileName = `metoyou-data-${new Date().toISOString().slice(0, 10)}.dat`;
|
||||
const { canceled, filePath } = await dialog.showSaveDialog({
|
||||
defaultPath: path.join(app.getPath('documents'), defaultFileName),
|
||||
filters: [
|
||||
{ extensions: ['dat'], name: 'MetoYou data archive' }
|
||||
],
|
||||
title: 'Export MetoYou data'
|
||||
});
|
||||
|
||||
if (canceled || !filePath) {
|
||||
return { cancelled: true, exported: false };
|
||||
}
|
||||
|
||||
const entries: ZipArchiveEntry[] = [
|
||||
{
|
||||
data: Buffer.from(JSON.stringify({
|
||||
appVersion: app.getVersion(),
|
||||
exportedAt: new Date().toISOString(),
|
||||
format: 'metoyou-user-data',
|
||||
version: 1
|
||||
}, null, 2)),
|
||||
path: ARCHIVE_MANIFEST_PATH
|
||||
}
|
||||
];
|
||||
|
||||
for (const file of await collectDataFiles(dataPath)) {
|
||||
const relativePath = toArchivePath(path.relative(dataPath, file));
|
||||
|
||||
entries.push({
|
||||
data: await fsp.readFile(file),
|
||||
path: `${ARCHIVE_DATA_PREFIX}${relativePath}`
|
||||
});
|
||||
}
|
||||
|
||||
await fsp.writeFile(ensureDatExtension(filePath), createZipArchive(entries));
|
||||
|
||||
return {
|
||||
cancelled: false,
|
||||
exported: true,
|
||||
filePath: ensureDatExtension(filePath)
|
||||
};
|
||||
}
|
||||
|
||||
export async function importUserData(): Promise<ImportUserDataResult> {
|
||||
const { canceled, filePaths } = await dialog.showOpenDialog({
|
||||
filters: [
|
||||
{ extensions: ['dat', 'zip'], name: 'MetoYou data archive' }
|
||||
],
|
||||
properties: ['openFile'],
|
||||
title: 'Import MetoYou data'
|
||||
});
|
||||
|
||||
if (canceled || filePaths.length === 0) {
|
||||
return {
|
||||
cancelled: true,
|
||||
imported: false,
|
||||
restartRequired: false
|
||||
};
|
||||
}
|
||||
|
||||
const archiveEntries = readZipArchive(await fsp.readFile(filePaths[0]));
|
||||
|
||||
validateArchiveManifest(archiveEntries);
|
||||
|
||||
const importRoot = path.join(app.getPath('temp'), `metoyou-import-${Date.now()}`);
|
||||
const importDataPath = path.join(importRoot, 'data');
|
||||
|
||||
try {
|
||||
await extractZipEntries(
|
||||
archiveEntries
|
||||
.filter((entry) => entry.path.startsWith(ARCHIVE_DATA_PREFIX))
|
||||
.map((entry) => ({
|
||||
data: entry.data,
|
||||
path: entry.path.slice(ARCHIVE_DATA_PREFIX.length)
|
||||
})),
|
||||
importDataPath
|
||||
);
|
||||
|
||||
await destroyDatabase();
|
||||
|
||||
const backupPath = await moveCurrentDataAside();
|
||||
|
||||
await copyDirectory(importDataPath, app.getPath('userData'));
|
||||
await initializeDatabase();
|
||||
|
||||
return {
|
||||
backupPath,
|
||||
cancelled: false,
|
||||
imported: true,
|
||||
restartRequired: true
|
||||
};
|
||||
} catch (error) {
|
||||
await initializeDatabase().catch(() => {});
|
||||
throw error;
|
||||
} finally {
|
||||
await fsp.rm(importRoot, { force: true, recursive: true }).catch(() => {});
|
||||
}
|
||||
}
|
||||
|
||||
export async function eraseUserData(): Promise<EraseUserDataResult> {
|
||||
const dataPath = app.getPath('userData');
|
||||
|
||||
await destroyDatabase();
|
||||
|
||||
for (const entry of await fsp.readdir(dataPath, { withFileTypes: true }).catch(() => [])) {
|
||||
await fsp.rm(path.join(dataPath, entry.name), { force: true, recursive: true });
|
||||
}
|
||||
|
||||
await fsp.mkdir(dataPath, { recursive: true });
|
||||
await initializeDatabase();
|
||||
|
||||
return {
|
||||
erased: true,
|
||||
restartRequired: true
|
||||
};
|
||||
}
|
||||
|
||||
async function collectDataFiles(directoryPath: string): Promise<string[]> {
|
||||
const files: string[] = [];
|
||||
const entries = await fsp.readdir(directoryPath, { withFileTypes: true }).catch(() => []);
|
||||
|
||||
for (const entry of entries) {
|
||||
if (entry.name === BACKUP_DIRECTORY_NAME) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const entryPath = path.join(directoryPath, entry.name);
|
||||
|
||||
if (entry.isDirectory()) {
|
||||
files.push(...await collectDataFiles(entryPath));
|
||||
} else if (entry.isFile()) {
|
||||
files.push(entryPath);
|
||||
}
|
||||
}
|
||||
|
||||
return files;
|
||||
}
|
||||
|
||||
async function moveCurrentDataAside(): Promise<string | undefined> {
|
||||
const dataPath = app.getPath('userData');
|
||||
const backupRoot = path.join(dataPath, BACKUP_DIRECTORY_NAME);
|
||||
const backupPath = path.join(backupRoot, `before-import-${new Date().toISOString().replace(/[:.]/g, '-')}`);
|
||||
const entries = await fsp.readdir(dataPath, { withFileTypes: true }).catch(() => []);
|
||||
|
||||
await fsp.mkdir(backupPath, { recursive: true });
|
||||
|
||||
let movedAny = false;
|
||||
|
||||
for (const entry of entries) {
|
||||
if (entry.name === BACKUP_DIRECTORY_NAME) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const sourcePath = path.join(dataPath, entry.name);
|
||||
const targetPath = path.join(backupPath, entry.name);
|
||||
|
||||
await fsp.mkdir(path.dirname(targetPath), { recursive: true });
|
||||
await fsp.rename(sourcePath, targetPath).catch(async () => {
|
||||
await copyPath(sourcePath, targetPath);
|
||||
await fsp.rm(sourcePath, { force: true, recursive: true });
|
||||
});
|
||||
movedAny = true;
|
||||
}
|
||||
|
||||
return movedAny ? backupPath : undefined;
|
||||
}
|
||||
|
||||
async function copyDirectory(sourcePath: string, targetPath: string): Promise<void> {
|
||||
await fsp.mkdir(targetPath, { recursive: true });
|
||||
|
||||
for (const entry of await fsp.readdir(sourcePath, { withFileTypes: true }).catch(() => [])) {
|
||||
await copyPath(path.join(sourcePath, entry.name), path.join(targetPath, entry.name));
|
||||
}
|
||||
}
|
||||
|
||||
async function copyPath(sourcePath: string, targetPath: string): Promise<void> {
|
||||
const stats = await fsp.stat(sourcePath);
|
||||
|
||||
if (stats.isDirectory()) {
|
||||
await copyDirectory(sourcePath, targetPath);
|
||||
return;
|
||||
}
|
||||
|
||||
if (stats.isFile()) {
|
||||
await fsp.mkdir(path.dirname(targetPath), { recursive: true });
|
||||
await fsp.copyFile(sourcePath, targetPath);
|
||||
}
|
||||
}
|
||||
|
||||
function validateArchiveManifest(entries: ZipArchiveEntry[]): void {
|
||||
const manifest = entries.find((entry) => entry.path === ARCHIVE_MANIFEST_PATH);
|
||||
|
||||
if (!manifest) {
|
||||
throw new Error('The selected file is missing a MetoYou data manifest.');
|
||||
}
|
||||
|
||||
const parsed = JSON.parse(manifest.data.toString('utf8')) as { format?: string; version?: number };
|
||||
|
||||
if (parsed.format !== 'metoyou-user-data' || parsed.version !== 1) {
|
||||
throw new Error('The selected file uses an unsupported data archive format.');
|
||||
}
|
||||
}
|
||||
|
||||
function ensureDatExtension(filePath: string): string {
|
||||
return path.extname(filePath).toLowerCase() === '.dat'
|
||||
? filePath
|
||||
: `${filePath}.dat`;
|
||||
}
|
||||
|
||||
function toArchivePath(filePath: string): string {
|
||||
return filePath.split(path.sep).join('/');
|
||||
}
|
||||
@@ -25,7 +25,8 @@ import {
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
} from './entities';
|
||||
|
||||
const projectRootDatabaseFilePath = path.join(__dirname, '..', '..', settings.databaseName);
|
||||
@@ -51,7 +52,8 @@ export const AppDataSource = new DataSource({
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
],
|
||||
migrations: [path.join(__dirname, 'migrations', '*.{ts,js}')],
|
||||
synchronize: false,
|
||||
|
||||
@@ -16,7 +16,8 @@ import {
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
} from '../entities';
|
||||
import { settings } from '../settings';
|
||||
|
||||
@@ -26,6 +27,24 @@ let dbBackupPath = '';
|
||||
|
||||
// SQLite files start with this 16-byte header string.
|
||||
const SQLITE_MAGIC = 'SQLite format 3\0';
|
||||
const SAVE_RETRY_DELAYS_MS = [25, 75, 150, 300, 600];
|
||||
const RETRYABLE_SAVE_ERROR_CODES = new Set(['EPERM', 'EACCES', 'EBUSY']);
|
||||
|
||||
let saveQueue: Promise<void> = Promise.resolve();
|
||||
|
||||
function wait(ms: number): Promise<void> {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
}
|
||||
|
||||
function isRetryableSaveError(error: unknown): boolean {
|
||||
if (!error || typeof error !== 'object') {
|
||||
return false;
|
||||
}
|
||||
|
||||
const code = (error as NodeJS.ErrnoException).code;
|
||||
|
||||
return typeof code === 'string' && RETRYABLE_SAVE_ERROR_CODES.has(code);
|
||||
}
|
||||
|
||||
export function getDataSource(): DataSource | undefined {
|
||||
return applicationDataSource;
|
||||
@@ -87,18 +106,47 @@ function safeguardDbFile(): Uint8Array | undefined {
|
||||
* then rename it over the real file. rename() is atomic on the same
|
||||
* filesystem, so a crash mid-write can never leave a half-written DB.
|
||||
*/
|
||||
async function atomicSave(data: Uint8Array): Promise<void> {
|
||||
async function replaceDatabaseFile(tmpPath: string): Promise<void> {
|
||||
for (let attempt = 0; ; attempt++) {
|
||||
try {
|
||||
await fsp.rename(tmpPath, dbFilePath);
|
||||
return;
|
||||
} catch (error) {
|
||||
const delay = SAVE_RETRY_DELAYS_MS[attempt];
|
||||
|
||||
if (!isRetryableSaveError(error) || delay === undefined) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
await wait(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function writeDatabaseSnapshot(snapshot: Buffer): Promise<void> {
|
||||
const tmpPath = dbFilePath + '.tmp-' + randomBytes(6).toString('hex');
|
||||
|
||||
try {
|
||||
await fsp.writeFile(tmpPath, Buffer.from(data));
|
||||
await fsp.rename(tmpPath, dbFilePath);
|
||||
await fsp.writeFile(tmpPath, snapshot);
|
||||
await replaceDatabaseFile(tmpPath);
|
||||
} catch (err) {
|
||||
await fsp.unlink(tmpPath).catch(() => {});
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
async function atomicSave(data: Uint8Array): Promise<void> {
|
||||
const snapshot = Buffer.from(data);
|
||||
const saveTask = saveQueue.then(
|
||||
() => writeDatabaseSnapshot(snapshot),
|
||||
() => writeDatabaseSnapshot(snapshot)
|
||||
);
|
||||
|
||||
saveQueue = saveTask.catch(() => {});
|
||||
|
||||
return saveTask;
|
||||
}
|
||||
|
||||
export async function initializeDatabase(): Promise<void> {
|
||||
const userDataPath = app.getPath('userData');
|
||||
const dbDir = path.join(userDataPath, 'metoyou');
|
||||
@@ -124,7 +172,8 @@ export async function initializeDatabase(): Promise<void> {
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
],
|
||||
migrations: [path.join(__dirname, '..', 'migrations', '*.js'), path.join(__dirname, '..', 'migrations', '*.ts')],
|
||||
synchronize: false,
|
||||
|
||||
26
electron/entities/PluginDataEntity.ts
Normal file
26
electron/entities/PluginDataEntity.ts
Normal file
@@ -0,0 +1,26 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('plugin_data')
|
||||
export class PluginDataEntity {
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
scope!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
key!: string;
|
||||
|
||||
@Column('text')
|
||||
valueJson!: string;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
@@ -10,3 +10,4 @@ export { ReactionEntity } from './ReactionEntity';
|
||||
export { BanEntity } from './BanEntity';
|
||||
export { AttachmentEntity } from './AttachmentEntity';
|
||||
export { MetaEntity } from './MetaEntity';
|
||||
export { PluginDataEntity } from './PluginDataEntity';
|
||||
|
||||
@@ -49,6 +49,14 @@ import {
|
||||
readSavedTheme,
|
||||
writeSavedTheme
|
||||
} from '../theme-library';
|
||||
import { getLocalPluginsPath, listLocalPluginManifests } from '../plugin-library';
|
||||
import {
|
||||
eraseUserData,
|
||||
exportUserData,
|
||||
importUserData,
|
||||
openCurrentDataFolder
|
||||
} from '../data-management';
|
||||
import { listRunningProcessNames } from '../process-list';
|
||||
|
||||
const DEFAULT_MIME_TYPE = 'application/octet-stream';
|
||||
const FILE_CLIPBOARD_FORMATS = [
|
||||
@@ -314,6 +322,8 @@ export function setupSystemHandlers(): void {
|
||||
}
|
||||
});
|
||||
|
||||
ipcMain.handle('get-running-process-names', async () => await listRunningProcessNames());
|
||||
|
||||
ipcMain.handle('prepare-linux-screen-share-audio-routing', async () => {
|
||||
return await prepareLinuxScreenShareAudioRouting();
|
||||
});
|
||||
@@ -335,7 +345,13 @@ export function setupSystemHandlers(): void {
|
||||
});
|
||||
|
||||
ipcMain.handle('get-app-data-path', () => app.getPath('userData'));
|
||||
ipcMain.handle('open-current-data-folder', async () => await openCurrentDataFolder());
|
||||
ipcMain.handle('export-user-data', async () => await exportUserData());
|
||||
ipcMain.handle('import-user-data', async () => await importUserData());
|
||||
ipcMain.handle('erase-user-data', async () => await eraseUserData());
|
||||
ipcMain.handle('get-saved-themes-path', async () => await getSavedThemesPath());
|
||||
ipcMain.handle('get-local-plugins-path', async () => await getLocalPluginsPath());
|
||||
ipcMain.handle('list-local-plugin-manifests', async () => await listLocalPluginManifests());
|
||||
ipcMain.handle('list-saved-themes', async () => await listSavedThemes());
|
||||
ipcMain.handle('read-saved-theme', async (_event, fileName: string) => await readSavedTheme(fileName));
|
||||
ipcMain.handle('write-saved-theme', async (_event, fileName: string, text: string) => {
|
||||
|
||||
25
electron/migrations/1000000000008-AddPluginData.ts
Normal file
25
electron/migrations/1000000000008-AddPluginData.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class AddPluginData1000000000008 implements MigrationInterface {
|
||||
name = 'AddPluginData1000000000008';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "plugin_data" (
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"scope" TEXT NOT NULL,
|
||||
"serverId" TEXT NOT NULL DEFAULT '',
|
||||
"key" TEXT NOT NULL,
|
||||
"valueJson" TEXT NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("pluginId", "scope", "serverId", "key")
|
||||
)
|
||||
`);
|
||||
await queryRunner.query(`CREATE INDEX IF NOT EXISTS "idx_plugin_data_plugin_scope" ON "plugin_data" ("pluginId", "scope")`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`DROP INDEX IF EXISTS "idx_plugin_data_plugin_scope"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "plugin_data"`);
|
||||
}
|
||||
}
|
||||
126
electron/plugin-library.spec.ts
Normal file
126
electron/plugin-library.spec.ts
Normal file
@@ -0,0 +1,126 @@
|
||||
import {
|
||||
afterEach,
|
||||
beforeEach,
|
||||
describe,
|
||||
expect,
|
||||
it,
|
||||
vi
|
||||
} from 'vitest';
|
||||
import {
|
||||
cp,
|
||||
mkdtemp,
|
||||
mkdir,
|
||||
rm,
|
||||
writeFile
|
||||
} from 'fs/promises';
|
||||
import { join } from 'path';
|
||||
import { tmpdir } from 'os';
|
||||
import { TEST_PLUGIN_FIXTURE_DIR, TEST_PLUGIN_ID } from '../e2e/helpers/plugin-api-test-fixture';
|
||||
|
||||
const { mockGetPath } = vi.hoisted(() => ({
|
||||
mockGetPath: vi.fn()
|
||||
}));
|
||||
|
||||
vi.mock('electron', () => ({
|
||||
app: {
|
||||
getPath: mockGetPath
|
||||
}
|
||||
}));
|
||||
|
||||
import { getLocalPluginsPath, listLocalPluginManifests } from './plugin-library';
|
||||
|
||||
describe('plugin-library', () => {
|
||||
let userDataPath: string;
|
||||
|
||||
beforeEach(async () => {
|
||||
userDataPath = await mkdtemp(join(tmpdir(), 'metoyou-plugin-library-'));
|
||||
mockGetPath.mockReturnValue(userDataPath);
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await rm(userDataPath, { recursive: true, force: true });
|
||||
mockGetPath.mockReset();
|
||||
});
|
||||
|
||||
it('creates and reports the local plugins folder', async () => {
|
||||
const pluginsPath = await getLocalPluginsPath();
|
||||
const result = await listLocalPluginManifests();
|
||||
|
||||
expect(pluginsPath).toBe(join(userDataPath, 'plugins'));
|
||||
expect(result).toEqual({
|
||||
errors: [],
|
||||
plugins: [],
|
||||
pluginsPath
|
||||
});
|
||||
});
|
||||
|
||||
it('discovers immediate child plugin manifests and safe relative files', async () => {
|
||||
const pluginRoot = join(userDataPath, 'plugins', 'api-test-plugin');
|
||||
|
||||
await cp(TEST_PLUGIN_FIXTURE_DIR, pluginRoot, { recursive: true });
|
||||
|
||||
const result = await listLocalPluginManifests();
|
||||
|
||||
expect(result.errors).toEqual([]);
|
||||
expect(result.plugins).toHaveLength(1);
|
||||
expect(result.plugins[0]).toEqual(expect.objectContaining({
|
||||
entrypointPath: join(pluginRoot, 'dist', 'main.js'),
|
||||
manifestPath: join(pluginRoot, 'toju-plugin.json'),
|
||||
pluginRoot,
|
||||
readmePath: join(pluginRoot, 'README.md')
|
||||
}));
|
||||
|
||||
expect(result.plugins[0]?.manifest).toEqual(expect.objectContaining({ id: TEST_PLUGIN_ID }));
|
||||
});
|
||||
|
||||
it('reports invalid JSON and keeps scanning other plugins', async () => {
|
||||
const invalidRoot = join(userDataPath, 'plugins', 'invalid-plugin');
|
||||
const validRoot = join(userDataPath, 'plugins', 'valid-plugin');
|
||||
|
||||
await mkdir(invalidRoot, { recursive: true });
|
||||
await mkdir(validRoot, { recursive: true });
|
||||
await writeFile(join(invalidRoot, 'plugin.json'), '{', 'utf8');
|
||||
await writeFile(join(validRoot, 'plugin.json'), JSON.stringify({
|
||||
apiVersion: '1.0.0',
|
||||
compatibility: { minimumTojuVersion: '1.0.0' },
|
||||
description: 'Valid plugin',
|
||||
entrypoint: './main.js',
|
||||
id: 'valid.plugin',
|
||||
kind: 'client',
|
||||
schemaVersion: 1,
|
||||
title: 'Valid Plugin',
|
||||
version: '1.0.0'
|
||||
}), 'utf8');
|
||||
|
||||
const result = await listLocalPluginManifests();
|
||||
|
||||
expect(result.plugins.map((plugin) => plugin.pluginRoot)).toEqual([validRoot]);
|
||||
expect(result.errors).toHaveLength(1);
|
||||
expect(result.errors[0]).toEqual(expect.objectContaining({
|
||||
manifestPath: join(invalidRoot, 'plugin.json'),
|
||||
pluginRoot: invalidRoot
|
||||
}));
|
||||
});
|
||||
|
||||
it('does not resolve entrypoints outside the plugin folder', async () => {
|
||||
const pluginRoot = join(userDataPath, 'plugins', 'unsafe-plugin');
|
||||
|
||||
await mkdir(pluginRoot, { recursive: true });
|
||||
await writeFile(join(userDataPath, 'plugins', 'outside.js'), 'export default {};', 'utf8');
|
||||
await writeFile(join(pluginRoot, 'plugin.json'), JSON.stringify({
|
||||
apiVersion: '1.0.0',
|
||||
compatibility: { minimumTojuVersion: '1.0.0' },
|
||||
description: 'Unsafe plugin',
|
||||
entrypoint: '../outside.js',
|
||||
id: 'unsafe.plugin',
|
||||
kind: 'client',
|
||||
schemaVersion: 1,
|
||||
title: 'Unsafe Plugin',
|
||||
version: '1.0.0'
|
||||
}), 'utf8');
|
||||
|
||||
const result = await listLocalPluginManifests();
|
||||
|
||||
expect(result.plugins[0]?.entrypointPath).toBeUndefined();
|
||||
});
|
||||
});
|
||||
165
electron/plugin-library.ts
Normal file
165
electron/plugin-library.ts
Normal file
@@ -0,0 +1,165 @@
|
||||
import { app } from 'electron';
|
||||
import * as fsp from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
import { pathToFileURL } from 'url';
|
||||
|
||||
const PLUGINS_FOLDER_NAME = 'plugins';
|
||||
const MANIFEST_FILE_NAMES = ['toju-plugin.json', 'plugin.json'] as const;
|
||||
|
||||
export interface LocalPluginManifestDescriptor {
|
||||
discoveredAt: number;
|
||||
entrypointPath?: string;
|
||||
pluginRootUrl: string;
|
||||
manifest: unknown;
|
||||
manifestPath: string;
|
||||
pluginRoot: string;
|
||||
readmePath?: string;
|
||||
}
|
||||
|
||||
export interface LocalPluginDiscoveryError {
|
||||
manifestPath?: string;
|
||||
message: string;
|
||||
pluginRoot?: string;
|
||||
}
|
||||
|
||||
export interface LocalPluginDiscoveryResult {
|
||||
errors: LocalPluginDiscoveryError[];
|
||||
plugins: LocalPluginManifestDescriptor[];
|
||||
pluginsPath: string;
|
||||
}
|
||||
|
||||
function resolvePluginsPath(): string {
|
||||
return path.join(app.getPath('userData'), PLUGINS_FOLDER_NAME);
|
||||
}
|
||||
|
||||
async function ensurePluginsPath(): Promise<string> {
|
||||
const pluginsPath = resolvePluginsPath();
|
||||
|
||||
await fsp.mkdir(pluginsPath, { recursive: true });
|
||||
|
||||
return pluginsPath;
|
||||
}
|
||||
|
||||
async function realpathOrSelf(filePath: string): Promise<string> {
|
||||
try {
|
||||
return await fsp.realpath(filePath);
|
||||
} catch {
|
||||
return filePath;
|
||||
}
|
||||
}
|
||||
|
||||
function isPathInside(parentPath: string, candidatePath: string): boolean {
|
||||
const relativePath = path.relative(parentPath, candidatePath);
|
||||
|
||||
return !!relativePath && !relativePath.startsWith('..') && !path.isAbsolute(relativePath);
|
||||
}
|
||||
|
||||
function readManifestPath(manifestRecord: Record<string, unknown>, key: string): string | undefined {
|
||||
const value = manifestRecord[key];
|
||||
|
||||
return typeof value === 'string' && value.trim()
|
||||
? value.trim()
|
||||
: undefined;
|
||||
}
|
||||
|
||||
async function resolveManifestRelativeFile(pluginRoot: string, relativeFilePath: string | undefined): Promise<string | undefined> {
|
||||
if (!relativeFilePath || path.isAbsolute(relativeFilePath)) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const normalizedPath = path.normalize(relativeFilePath);
|
||||
|
||||
if (normalizedPath.startsWith('..')) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const candidatePath = path.join(pluginRoot, normalizedPath);
|
||||
const [realPluginRoot, realCandidatePath] = await Promise.all([realpathOrSelf(pluginRoot), realpathOrSelf(candidatePath)]);
|
||||
|
||||
if (!isPathInside(realPluginRoot, realCandidatePath)) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
try {
|
||||
const stats = await fsp.stat(realCandidatePath);
|
||||
|
||||
return stats.isFile() ? realCandidatePath : undefined;
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
async function findManifestPath(pluginRoot: string): Promise<string | undefined> {
|
||||
for (const fileName of MANIFEST_FILE_NAMES) {
|
||||
const manifestPath = path.join(pluginRoot, fileName);
|
||||
|
||||
try {
|
||||
const stats = await fsp.stat(manifestPath);
|
||||
|
||||
if (stats.isFile()) {
|
||||
return manifestPath;
|
||||
}
|
||||
} catch {
|
||||
// Missing manifest candidates are expected while scanning folders.
|
||||
}
|
||||
}
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
async function readPluginManifest(pluginRoot: string, manifestPath: string): Promise<LocalPluginManifestDescriptor> {
|
||||
const text = await fsp.readFile(manifestPath, 'utf8');
|
||||
const manifest = JSON.parse(text) as unknown;
|
||||
const manifestRecord = manifest && typeof manifest === 'object' && !Array.isArray(manifest)
|
||||
? manifest as Record<string, unknown>
|
||||
: {};
|
||||
const entrypointPromise = resolveManifestRelativeFile(pluginRoot, readManifestPath(manifestRecord, 'entrypoint'));
|
||||
const readmePromise = resolveManifestRelativeFile(pluginRoot, readManifestPath(manifestRecord, 'readme'));
|
||||
const [entrypointPath, readmePath] = await Promise.all([entrypointPromise, readmePromise]);
|
||||
|
||||
return {
|
||||
discoveredAt: Date.now(),
|
||||
entrypointPath,
|
||||
pluginRootUrl: pathToFileURL(pluginRoot + path.sep).toString(),
|
||||
manifest,
|
||||
manifestPath,
|
||||
pluginRoot,
|
||||
readmePath
|
||||
};
|
||||
}
|
||||
|
||||
export async function getLocalPluginsPath(): Promise<string> {
|
||||
return await ensurePluginsPath();
|
||||
}
|
||||
|
||||
export async function listLocalPluginManifests(): Promise<LocalPluginDiscoveryResult> {
|
||||
const pluginsPath = await ensurePluginsPath();
|
||||
const entries = await fsp.readdir(pluginsPath, { withFileTypes: true });
|
||||
const plugins: LocalPluginManifestDescriptor[] = [];
|
||||
const errors: LocalPluginDiscoveryError[] = [];
|
||||
|
||||
for (const entry of entries.filter((candidate) => candidate.isDirectory())) {
|
||||
const pluginRoot = path.join(pluginsPath, entry.name);
|
||||
const manifestPath = await findManifestPath(pluginRoot);
|
||||
|
||||
if (!manifestPath) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
plugins.push(await readPluginManifest(pluginRoot, manifestPath));
|
||||
} catch (error) {
|
||||
errors.push({
|
||||
manifestPath,
|
||||
message: error instanceof Error ? error.message : 'Unable to read plugin manifest',
|
||||
pluginRoot
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
errors,
|
||||
plugins: plugins.sort((left, right) => left.pluginRoot.localeCompare(right.pluginRoot)),
|
||||
pluginsPath
|
||||
};
|
||||
}
|
||||
@@ -109,6 +109,46 @@ export interface SavedThemeFileDescriptor {
|
||||
path: string;
|
||||
}
|
||||
|
||||
export interface LocalPluginManifestDescriptor {
|
||||
discoveredAt: number;
|
||||
entrypointPath?: string;
|
||||
pluginRootUrl: string;
|
||||
manifest: unknown;
|
||||
manifestPath: string;
|
||||
pluginRoot: string;
|
||||
readmePath?: string;
|
||||
}
|
||||
|
||||
export interface LocalPluginDiscoveryError {
|
||||
manifestPath?: string;
|
||||
message: string;
|
||||
pluginRoot?: string;
|
||||
}
|
||||
|
||||
export interface LocalPluginDiscoveryResult {
|
||||
errors: LocalPluginDiscoveryError[];
|
||||
plugins: LocalPluginManifestDescriptor[];
|
||||
pluginsPath: string;
|
||||
}
|
||||
|
||||
export interface ExportUserDataResult {
|
||||
cancelled: boolean;
|
||||
exported: boolean;
|
||||
filePath?: string;
|
||||
}
|
||||
|
||||
export interface ImportUserDataResult {
|
||||
backupPath?: string;
|
||||
cancelled: boolean;
|
||||
imported: boolean;
|
||||
restartRequired: boolean;
|
||||
}
|
||||
|
||||
export interface EraseUserDataResult {
|
||||
erased: boolean;
|
||||
restartRequired: boolean;
|
||||
}
|
||||
|
||||
function readLinuxDisplayServer(): string {
|
||||
if (process.platform !== 'linux') {
|
||||
return 'N/A';
|
||||
@@ -149,6 +189,7 @@ export interface ElectronAPI {
|
||||
|
||||
openExternal: (url: string) => Promise<boolean>;
|
||||
getSources: () => Promise<{ id: string; name: string; thumbnail: string }[]>;
|
||||
getRunningProcessNames: () => Promise<string[]>;
|
||||
prepareLinuxScreenShareAudioRouting: () => Promise<LinuxScreenShareAudioRoutingInfo>;
|
||||
activateLinuxScreenShareAudioRouting: () => Promise<LinuxScreenShareAudioRoutingInfo>;
|
||||
deactivateLinuxScreenShareAudioRouting: () => Promise<boolean>;
|
||||
@@ -157,7 +198,13 @@ export interface ElectronAPI {
|
||||
onLinuxScreenShareMonitorAudioChunk: (listener: (payload: LinuxScreenShareMonitorAudioChunkPayload) => void) => () => void;
|
||||
onLinuxScreenShareMonitorAudioEnded: (listener: (payload: LinuxScreenShareMonitorAudioEndedPayload) => void) => () => void;
|
||||
getAppDataPath: () => Promise<string>;
|
||||
openCurrentDataFolder: () => Promise<boolean>;
|
||||
exportUserData: () => Promise<ExportUserDataResult>;
|
||||
importUserData: () => Promise<ImportUserDataResult>;
|
||||
eraseUserData: () => Promise<EraseUserDataResult>;
|
||||
getSavedThemesPath: () => Promise<string>;
|
||||
getLocalPluginsPath: () => Promise<string>;
|
||||
listLocalPluginManifests: () => Promise<LocalPluginDiscoveryResult>;
|
||||
listSavedThemes: () => Promise<SavedThemeFileDescriptor[]>;
|
||||
readSavedTheme: (fileName: string) => Promise<string>;
|
||||
writeSavedTheme: (fileName: string, text: string) => Promise<boolean>;
|
||||
@@ -230,6 +277,7 @@ const electronAPI: ElectronAPI = {
|
||||
|
||||
openExternal: (url) => ipcRenderer.invoke('open-external', url),
|
||||
getSources: () => ipcRenderer.invoke('get-sources'),
|
||||
getRunningProcessNames: () => ipcRenderer.invoke('get-running-process-names'),
|
||||
prepareLinuxScreenShareAudioRouting: () => ipcRenderer.invoke('prepare-linux-screen-share-audio-routing'),
|
||||
activateLinuxScreenShareAudioRouting: () => ipcRenderer.invoke('activate-linux-screen-share-audio-routing'),
|
||||
deactivateLinuxScreenShareAudioRouting: () => ipcRenderer.invoke('deactivate-linux-screen-share-audio-routing'),
|
||||
@@ -265,7 +313,13 @@ const electronAPI: ElectronAPI = {
|
||||
};
|
||||
},
|
||||
getAppDataPath: () => ipcRenderer.invoke('get-app-data-path'),
|
||||
openCurrentDataFolder: () => ipcRenderer.invoke('open-current-data-folder'),
|
||||
exportUserData: () => ipcRenderer.invoke('export-user-data'),
|
||||
importUserData: () => ipcRenderer.invoke('import-user-data'),
|
||||
eraseUserData: () => ipcRenderer.invoke('erase-user-data'),
|
||||
getSavedThemesPath: () => ipcRenderer.invoke('get-saved-themes-path'),
|
||||
getLocalPluginsPath: () => ipcRenderer.invoke('get-local-plugins-path'),
|
||||
listLocalPluginManifests: () => ipcRenderer.invoke('list-local-plugin-manifests'),
|
||||
listSavedThemes: () => ipcRenderer.invoke('list-saved-themes'),
|
||||
readSavedTheme: (fileName) => ipcRenderer.invoke('read-saved-theme', fileName),
|
||||
writeSavedTheme: (fileName, text) => ipcRenderer.invoke('write-saved-theme', fileName, text),
|
||||
|
||||
85
electron/process-list.ts
Normal file
85
electron/process-list.ts
Normal file
@@ -0,0 +1,85 @@
|
||||
import { execFile } from 'child_process';
|
||||
import * as path from 'path';
|
||||
import { promisify } from 'util';
|
||||
|
||||
const execFileAsync = promisify(execFile);
|
||||
const MAX_PROCESS_NAMES = 512;
|
||||
|
||||
export async function listRunningProcessNames(): Promise<string[]> {
|
||||
if (process.platform === 'win32') {
|
||||
return normalizeProcessNames(await listWindowsProcessNames());
|
||||
}
|
||||
|
||||
if (process.platform === 'linux') {
|
||||
return normalizeProcessNames(await listLinuxProcessNames());
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
async function listLinuxProcessNames(): Promise<string[]> {
|
||||
const { stdout } = await execFileAsync('ps', ['-eo', 'comm='], {
|
||||
maxBuffer: 1024 * 1024,
|
||||
timeout: 5_000
|
||||
});
|
||||
|
||||
return stdout.split('\n');
|
||||
}
|
||||
|
||||
async function listWindowsProcessNames(): Promise<string[]> {
|
||||
const { stdout } = await execFileAsync('tasklist', [
|
||||
'/FO',
|
||||
'CSV',
|
||||
'/NH'
|
||||
], {
|
||||
maxBuffer: 1024 * 1024,
|
||||
timeout: 5_000,
|
||||
windowsHide: true
|
||||
});
|
||||
|
||||
return stdout
|
||||
.split(/\r?\n/)
|
||||
.map((line) => parseCsvFirstColumn(line));
|
||||
}
|
||||
|
||||
function parseCsvFirstColumn(line: string): string {
|
||||
const trimmed = line.trim();
|
||||
|
||||
if (!trimmed) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if (!trimmed.startsWith('"')) {
|
||||
return trimmed.split(',')[0] ?? '';
|
||||
}
|
||||
|
||||
const endQuoteIndex = trimmed.indexOf('"', 1);
|
||||
|
||||
return endQuoteIndex > 1 ? trimmed.slice(1, endQuoteIndex) : '';
|
||||
}
|
||||
|
||||
function normalizeProcessNames(names: string[]): string[] {
|
||||
const normalized = new Set<string>();
|
||||
|
||||
for (const rawName of names) {
|
||||
const name = normalizeProcessName(rawName);
|
||||
|
||||
if (name) {
|
||||
normalized.add(name);
|
||||
}
|
||||
}
|
||||
|
||||
return Array.from(normalized)
|
||||
.sort()
|
||||
.slice(0, MAX_PROCESS_NAMES);
|
||||
}
|
||||
|
||||
function normalizeProcessName(rawName: string): string {
|
||||
const baseName = path.basename(rawName.trim()).trim();
|
||||
|
||||
if (!baseName || baseName.length > 96) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return baseName;
|
||||
}
|
||||
@@ -500,7 +500,7 @@ async function performUpdateCheck(
|
||||
setDesktopUpdateState({
|
||||
lastCheckedAt: Date.now(),
|
||||
status: 'checking',
|
||||
statusMessage: `Checking for MetoYou ${targetRelease.version}…`,
|
||||
statusMessage: `Checking for MetoYou ${targetRelease.version}...`,
|
||||
targetVersion: targetRelease.version
|
||||
});
|
||||
|
||||
@@ -687,7 +687,7 @@ export function initializeDesktopUpdater(): void {
|
||||
|
||||
setDesktopUpdateState({
|
||||
status: 'checking',
|
||||
statusMessage: 'Checking for desktop updates…'
|
||||
statusMessage: 'Checking for desktop updates...'
|
||||
});
|
||||
});
|
||||
|
||||
@@ -698,7 +698,7 @@ export function initializeDesktopUpdater(): void {
|
||||
setDesktopUpdateState({
|
||||
lastCheckedAt: Date.now(),
|
||||
status: 'downloading',
|
||||
statusMessage: `Downloading MetoYou ${nextVersion ?? 'update'}…`,
|
||||
statusMessage: `Downloading MetoYou ${nextVersion ?? 'update'}...`,
|
||||
targetVersion: nextVersion
|
||||
});
|
||||
});
|
||||
|
||||
@@ -5,41 +5,7 @@ const angular = require('angular-eslint');
|
||||
const stylisticTs = require('@stylistic/eslint-plugin-ts');
|
||||
const stylisticJs = require('@stylistic/eslint-plugin-js');
|
||||
const newlines = require('eslint-plugin-import-newlines');
|
||||
|
||||
// Inline plugin: ban en dash (–, U+2013) and em dash (—, U+2014) from source files
|
||||
const noDashPlugin = {
|
||||
rules: {
|
||||
'no-unicode-dashes': {
|
||||
meta: { fixable: 'code' },
|
||||
create(context) {
|
||||
const BANNED = [
|
||||
{ char: '\u2013', name: 'en dash (–)' },
|
||||
{ char: '\u2014', name: 'em dash (—)' }
|
||||
];
|
||||
return {
|
||||
Program() {
|
||||
const src = context.getSourceCode().getText();
|
||||
for (const { char, name } of BANNED) {
|
||||
let idx = src.indexOf(char);
|
||||
while (idx !== -1) {
|
||||
const start = idx;
|
||||
const end = idx + char.length;
|
||||
context.report({
|
||||
loc: context.getSourceCode().getLocFromIndex(idx),
|
||||
message: `Unicode ${name} is not allowed. Use a regular hyphen (-) instead.`,
|
||||
fix(fixer) {
|
||||
return fixer.replaceTextRange([start, end], '-');
|
||||
}
|
||||
});
|
||||
idx = src.indexOf(char, idx + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
const metoyouEslintRules = require('./tools/eslint-rules');
|
||||
|
||||
module.exports = tseslint.config(
|
||||
{
|
||||
@@ -51,7 +17,7 @@ module.exports = tseslint.config(
|
||||
'@stylistic/ts': stylisticTs,
|
||||
'@stylistic/js': stylisticJs,
|
||||
'import-newlines': newlines,
|
||||
'no-dashes': noDashPlugin
|
||||
'metoyou': metoyouEslintRules
|
||||
},
|
||||
extends: [
|
||||
eslint.configs.recommended,
|
||||
@@ -69,7 +35,7 @@ module.exports = tseslint.config(
|
||||
styles: 0
|
||||
}
|
||||
],
|
||||
'no-dashes/no-unicode-dashes': 'error',
|
||||
'metoyou/no-unicode-symbols': 'error',
|
||||
'@typescript-eslint/no-extraneous-class': 'off',
|
||||
'@angular-eslint/component-class-suffix': [ 'error', { suffixes: ['Component','Page','Stub'] } ],
|
||||
'@angular-eslint/directive-class-suffix': 'error',
|
||||
@@ -200,10 +166,10 @@ module.exports = tseslint.config(
|
||||
// HTML template formatting rules (external Angular templates only)
|
||||
{
|
||||
files: ['toju-app/src/app/**/*.html'],
|
||||
plugins: { 'no-dashes': noDashPlugin },
|
||||
plugins: { 'metoyou': metoyouEslintRules },
|
||||
extends: [...angular.configs.templateRecommended, ...angular.configs.templateAccessibility],
|
||||
rules: {
|
||||
'no-dashes/no-unicode-dashes': 'error',
|
||||
'metoyou/no-unicode-symbols': 'error',
|
||||
// Angular template best practices
|
||||
'@angular-eslint/template/button-has-type': 'warn',
|
||||
'@angular-eslint/template/cyclomatic-complexity': ['warn', { maxComplexity: 10 }],
|
||||
|
||||
26
package-lock.json
generated
26
package-lock.json
generated
@@ -15,8 +15,10 @@
|
||||
"@angular/platform-browser": "^21.0.0",
|
||||
"@angular/router": "^21.0.0",
|
||||
"@codemirror/commands": "^6.10.3",
|
||||
"@codemirror/lang-css": "^6.3.1",
|
||||
"@codemirror/lang-json": "^6.0.2",
|
||||
"@codemirror/language": "^6.12.3",
|
||||
"@codemirror/lint": "^6.9.5",
|
||||
"@codemirror/state": "^6.6.0",
|
||||
"@codemirror/theme-one-dark": "^6.1.3",
|
||||
"@codemirror/view": "^6.41.0",
|
||||
@@ -2731,6 +2733,19 @@
|
||||
"@lezer/common": "^1.1.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@codemirror/lang-css": {
|
||||
"version": "6.3.1",
|
||||
"resolved": "https://registry.npmjs.org/@codemirror/lang-css/-/lang-css-6.3.1.tgz",
|
||||
"integrity": "sha512-kr5fwBGiGtmz6l0LSJIbno9QrifNMUusivHbnA1H6Dmqy4HZFte3UAICix1VuKo0lMPKQr2rqB+0BkKi/S3Ejg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@codemirror/autocomplete": "^6.0.0",
|
||||
"@codemirror/language": "^6.0.0",
|
||||
"@codemirror/state": "^6.0.0",
|
||||
"@lezer/common": "^1.0.2",
|
||||
"@lezer/css": "^1.1.7"
|
||||
}
|
||||
},
|
||||
"node_modules/@codemirror/lang-json": {
|
||||
"version": "6.0.2",
|
||||
"resolved": "https://registry.npmjs.org/@codemirror/lang-json/-/lang-json-6.0.2.tgz",
|
||||
@@ -5791,6 +5806,17 @@
|
||||
"integrity": "sha512-6YRVG9vBkaY7p1IVxL4s44n5nUnaNnGM2/AckNgYOnxTG2kWh1vR8BMxPseWPjRNpb5VtXnMpeYAEAADoRV1Iw==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@lezer/css": {
|
||||
"version": "1.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@lezer/css/-/css-1.3.3.tgz",
|
||||
"integrity": "sha512-RzBo8r+/6QJeow7aPHIpGVIH59xTcJXp399820gZoMo9noQDRVpJLheIBUicYwKcsbOYoBRoLZlf2720dG/4Tg==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@lezer/common": "^1.2.0",
|
||||
"@lezer/highlight": "^1.0.0",
|
||||
"@lezer/lr": "^1.3.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@lezer/highlight": {
|
||||
"version": "1.2.3",
|
||||
"resolved": "https://registry.npmjs.org/@lezer/highlight/-/highlight-1.2.3.tgz",
|
||||
|
||||
@@ -65,8 +65,10 @@
|
||||
"@angular/platform-browser": "^21.0.0",
|
||||
"@angular/router": "^21.0.0",
|
||||
"@codemirror/commands": "^6.10.3",
|
||||
"@codemirror/lang-css": "^6.3.1",
|
||||
"@codemirror/lang-json": "^6.0.2",
|
||||
"@codemirror/language": "^6.12.3",
|
||||
"@codemirror/lint": "^6.9.5",
|
||||
"@codemirror/state": "^6.6.0",
|
||||
"@codemirror/theme-one-dark": "^6.1.3",
|
||||
"@codemirror/view": "^6.41.0",
|
||||
|
||||
44
server/README.md
Normal file
44
server/README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Server
|
||||
|
||||
Node/TypeScript signaling server for MetoYou / Toju. This package owns the public server-directory API, join-request flows, websocket runtime, and server-side persistence.
|
||||
|
||||
## Install
|
||||
|
||||
1. Run `cd server`.
|
||||
2. Run `npm install`.
|
||||
|
||||
## Commands
|
||||
|
||||
- `npm run dev` starts the server with `ts-node-dev` reload.
|
||||
- `npm run build` compiles TypeScript to `dist/`.
|
||||
- `npm run start` runs the compiled server.
|
||||
- From the repository root, `npm run server:dev`, `npm run server:build`, and `npm run server:start` call the same package commands.
|
||||
|
||||
## Runtime Config
|
||||
|
||||
- The server loads the repository-root `.env` file on startup.
|
||||
- `SSL` can override the effective HTTP protocol, and `PORT` can override the effective port.
|
||||
- `DB_PATH` can override the SQLite database file location.
|
||||
- `data/variables.json` is normalized on startup and stores `klipyApiKey`, `rawgApiKey`, `releaseManifestUrl`, `serverPort`, `serverProtocol`, `serverHost`, and `linkPreview`.
|
||||
- `openApiDocs.enabled` in `data/variables.json`, or `OPENAPI_DOCS_ENABLED=true`, exposes the plugin support OpenAPI document at `/api/openapi.json` and a small docs page at `/api/docs`. It is disabled by default. Plugin support is metadata-only: the server stores install requirements and event definitions, but arbitrary plugin data persistence is disabled.
|
||||
- `RAWG_API_KEY` can override `rawgApiKey` for the `/api/games/match` now-playing metadata resolver. Successful matches include a preferred store link from RAWG store metadata, with Steam selected first when available. Negative game-match results are stored in the SQLite `game_match_misses` table so non-game process names do not repeatedly consume RAWG quota.
|
||||
- Packaged server builds store `metoyou.sqlite` in the OS app-data directory by default so upgrades do not overwrite runtime data. On first start, the server copies forward legacy packaged databases that still live beside the executable.
|
||||
- When HTTPS is enabled, certificates are read from the repository `.certs/` directory.
|
||||
|
||||
## Structure
|
||||
|
||||
| Path | Description |
|
||||
| --- | --- |
|
||||
| `src/index.ts` | Bootstrap and server startup |
|
||||
| `src/app/` | Express app composition |
|
||||
| `src/routes/` | REST API routes |
|
||||
| `src/websocket/` | WebSocket runtime and signaling transport |
|
||||
| `src/cqrs/` | Command/query handlers |
|
||||
| `src/config/` | Runtime config loading and normalization |
|
||||
| `src/db/`, `src/entities/`, `src/migrations/` | Persistence layer |
|
||||
| `data/` | Runtime data files such as `variables.json` |
|
||||
|
||||
## Notes
|
||||
|
||||
- `dist/` and `../dist-server/` are generated output.
|
||||
- See [AGENTS.md](AGENTS.md) for package-specific editing guidance.
|
||||
Binary file not shown.
@@ -10,13 +10,19 @@ export interface LinkPreviewConfig {
|
||||
maxCacheSizeMb: number;
|
||||
}
|
||||
|
||||
export interface OpenApiDocsConfig {
|
||||
enabled: boolean;
|
||||
}
|
||||
|
||||
export interface ServerVariablesConfig {
|
||||
klipyApiKey: string;
|
||||
rawgApiKey: string;
|
||||
releaseManifestUrl: string;
|
||||
serverPort: number;
|
||||
serverProtocol: ServerHttpProtocol;
|
||||
serverHost: string;
|
||||
linkPreview: LinkPreviewConfig;
|
||||
openApiDocs: OpenApiDocsConfig;
|
||||
}
|
||||
|
||||
const DATA_DIR = resolveRuntimePath('data');
|
||||
@@ -31,6 +37,10 @@ function normalizeKlipyApiKey(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
|
||||
function normalizeRawgApiKey(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
|
||||
function normalizeReleaseManifestUrl(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
@@ -97,6 +107,14 @@ function normalizeLinkPreviewConfig(value: unknown): LinkPreviewConfig {
|
||||
return { enabled, cacheTtlMinutes: cacheTtl, maxCacheSizeMb: maxSize };
|
||||
}
|
||||
|
||||
function normalizeOpenApiDocsConfig(value: unknown): OpenApiDocsConfig {
|
||||
const raw = (value && typeof value === 'object' && !Array.isArray(value))
|
||||
? value as Record<string, unknown>
|
||||
: {};
|
||||
|
||||
return { enabled: raw.enabled === true };
|
||||
}
|
||||
|
||||
function hasEnvironmentOverride(value: string | undefined): value is string {
|
||||
return typeof value === 'string' && value.trim().length > 0;
|
||||
}
|
||||
@@ -139,11 +157,13 @@ export function ensureVariablesConfig(): ServerVariablesConfig {
|
||||
const normalized = {
|
||||
...remainingParsed,
|
||||
klipyApiKey: normalizeKlipyApiKey(remainingParsed.klipyApiKey),
|
||||
rawgApiKey: normalizeRawgApiKey(remainingParsed.rawgApiKey),
|
||||
releaseManifestUrl: normalizeReleaseManifestUrl(remainingParsed.releaseManifestUrl),
|
||||
serverPort: normalizeServerPort(remainingParsed.serverPort),
|
||||
serverProtocol: normalizeServerProtocol(remainingParsed.serverProtocol),
|
||||
serverHost: normalizeServerHost(remainingParsed.serverHost ?? legacyServerIpAddress),
|
||||
linkPreview: normalizeLinkPreviewConfig(remainingParsed.linkPreview)
|
||||
linkPreview: normalizeLinkPreviewConfig(remainingParsed.linkPreview),
|
||||
openApiDocs: normalizeOpenApiDocsConfig(remainingParsed.openApiDocs)
|
||||
};
|
||||
const nextContents = JSON.stringify(normalized, null, 2) + '\n';
|
||||
|
||||
@@ -153,11 +173,13 @@ export function ensureVariablesConfig(): ServerVariablesConfig {
|
||||
|
||||
return {
|
||||
klipyApiKey: normalized.klipyApiKey,
|
||||
rawgApiKey: normalized.rawgApiKey,
|
||||
releaseManifestUrl: normalized.releaseManifestUrl,
|
||||
serverPort: normalized.serverPort,
|
||||
serverProtocol: normalized.serverProtocol,
|
||||
serverHost: normalized.serverHost,
|
||||
linkPreview: normalized.linkPreview
|
||||
linkPreview: normalized.linkPreview,
|
||||
openApiDocs: normalized.openApiDocs
|
||||
};
|
||||
}
|
||||
|
||||
@@ -169,6 +191,14 @@ export function getKlipyApiKey(): string {
|
||||
return getVariablesConfig().klipyApiKey;
|
||||
}
|
||||
|
||||
export function getRawgApiKey(): string {
|
||||
if (hasEnvironmentOverride(process.env.RAWG_API_KEY)) {
|
||||
return process.env.RAWG_API_KEY.trim();
|
||||
}
|
||||
|
||||
return getVariablesConfig().rawgApiKey;
|
||||
}
|
||||
|
||||
export function hasKlipyApiKey(): boolean {
|
||||
return getKlipyApiKey().length > 0;
|
||||
}
|
||||
@@ -203,6 +233,31 @@ export function isHttpsServerEnabled(): boolean {
|
||||
return getServerProtocol() === 'https';
|
||||
}
|
||||
|
||||
export function areOpenApiDocsEnabled(): boolean {
|
||||
if (hasEnvironmentOverride(process.env.OPENAPI_DOCS_ENABLED)) {
|
||||
return process.env.OPENAPI_DOCS_ENABLED.trim().toLowerCase() === 'true';
|
||||
}
|
||||
|
||||
return getVariablesConfig().openApiDocs.enabled;
|
||||
}
|
||||
|
||||
export function setOpenApiDocsEnabled(enabled: boolean): OpenApiDocsConfig {
|
||||
if (!fs.existsSync(DATA_DIR)) {
|
||||
fs.mkdirSync(DATA_DIR, { recursive: true });
|
||||
}
|
||||
|
||||
const { parsed } = readRawVariables();
|
||||
const next = {
|
||||
...parsed,
|
||||
openApiDocs: { enabled }
|
||||
};
|
||||
|
||||
fs.writeFileSync(VARIABLES_FILE, JSON.stringify(next, null, 2) + '\n', 'utf8');
|
||||
ensureVariablesConfig();
|
||||
|
||||
return { enabled };
|
||||
}
|
||||
|
||||
export function getLinkPreviewConfig(): LinkPreviewConfig {
|
||||
return getVariablesConfig().linkPreview;
|
||||
}
|
||||
|
||||
@@ -14,10 +14,30 @@ import {
|
||||
JoinRequestEntity,
|
||||
ServerMembershipEntity,
|
||||
ServerInviteEntity,
|
||||
ServerBanEntity
|
||||
ServerBanEntity,
|
||||
GameMatchMissEntity,
|
||||
ServerPluginRequirementEntity,
|
||||
ServerPluginEventDefinitionEntity,
|
||||
PluginDataEntity,
|
||||
ServerPluginSettingsEntity,
|
||||
PluginUserMetadataEntity
|
||||
} from '../entities';
|
||||
import { serverMigrations } from '../migrations';
|
||||
import { findExistingPath, resolveRuntimePath } from '../runtime-paths';
|
||||
import {
|
||||
findExistingPath,
|
||||
isPackagedRuntime,
|
||||
resolvePersistentDataPath,
|
||||
resolveRuntimePath
|
||||
} from '../runtime-paths';
|
||||
|
||||
const LEGACY_PACKAGED_DB_FILE = path.join(resolveRuntimePath('data'), 'metoyou.sqlite');
|
||||
const LEGACY_PACKAGED_DB_BACKUP = LEGACY_PACKAGED_DB_FILE + '.bak';
|
||||
|
||||
function resolveDefaultDbFile(): string {
|
||||
return isPackagedRuntime()
|
||||
? resolvePersistentDataPath('metoyou.sqlite')
|
||||
: LEGACY_PACKAGED_DB_FILE;
|
||||
}
|
||||
|
||||
function resolveDbFile(): string {
|
||||
const envPath = process.env.DB_PATH;
|
||||
@@ -26,7 +46,7 @@ function resolveDbFile(): string {
|
||||
return path.resolve(envPath);
|
||||
}
|
||||
|
||||
return path.join(resolveRuntimePath('data'), 'metoyou.sqlite');
|
||||
return resolveDefaultDbFile();
|
||||
}
|
||||
|
||||
const DB_FILE = resolveDbFile();
|
||||
@@ -34,8 +54,84 @@ const DB_BACKUP = DB_FILE + '.bak';
|
||||
const DATA_DIR = path.dirname(DB_FILE);
|
||||
// SQLite files start with this 16-byte header string.
|
||||
const SQLITE_MAGIC = 'SQLite format 3\0';
|
||||
const SAVE_RETRY_DELAYS_MS = [
|
||||
25,
|
||||
75,
|
||||
150,
|
||||
300,
|
||||
600
|
||||
];
|
||||
const RETRYABLE_SAVE_ERROR_CODES = new Set([
|
||||
'EPERM',
|
||||
'EACCES',
|
||||
'EBUSY'
|
||||
]);
|
||||
|
||||
let applicationDataSource: DataSource | undefined;
|
||||
let saveQueue: Promise<void> = Promise.resolve();
|
||||
|
||||
function wait(ms: number): Promise<void> {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
}
|
||||
|
||||
function isRetryableSaveError(error: unknown): boolean {
|
||||
if (!error || typeof error !== 'object') {
|
||||
return false;
|
||||
}
|
||||
|
||||
const code = (error as NodeJS.ErrnoException).code;
|
||||
|
||||
return typeof code === 'string' && RETRYABLE_SAVE_ERROR_CODES.has(code);
|
||||
}
|
||||
|
||||
function restoreFromBackup(reason: string): Uint8Array | undefined {
|
||||
if (!fs.existsSync(DB_BACKUP)) {
|
||||
console.error(`[DB] ${reason}. No backup available - starting with a fresh database`);
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const backup = new Uint8Array(fs.readFileSync(DB_BACKUP));
|
||||
|
||||
if (!isValidSqlite(backup)) {
|
||||
console.error(`[DB] ${reason}. Backup is also invalid - starting with a fresh database`);
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
fs.copyFileSync(DB_BACKUP, DB_FILE);
|
||||
console.warn('[DB] Restored database from backup', DB_BACKUP);
|
||||
|
||||
return backup;
|
||||
}
|
||||
|
||||
async function migrateLegacyPackagedDatabase(): Promise<void> {
|
||||
if (process.env.DB_PATH || !isPackagedRuntime() || path.resolve(DB_FILE) === path.resolve(LEGACY_PACKAGED_DB_FILE)) {
|
||||
return;
|
||||
}
|
||||
|
||||
let migrated = false;
|
||||
|
||||
if (!fs.existsSync(DB_FILE)) {
|
||||
if (fs.existsSync(LEGACY_PACKAGED_DB_FILE)) {
|
||||
await fsp.copyFile(LEGACY_PACKAGED_DB_FILE, DB_FILE);
|
||||
migrated = true;
|
||||
} else if (fs.existsSync(LEGACY_PACKAGED_DB_BACKUP)) {
|
||||
await fsp.copyFile(LEGACY_PACKAGED_DB_BACKUP, DB_FILE);
|
||||
migrated = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (!fs.existsSync(DB_BACKUP) && fs.existsSync(LEGACY_PACKAGED_DB_BACKUP)) {
|
||||
await fsp.copyFile(LEGACY_PACKAGED_DB_BACKUP, DB_BACKUP);
|
||||
migrated = true;
|
||||
}
|
||||
|
||||
if (migrated) {
|
||||
console.log('[DB] Migrated packaged database files to:', DATA_DIR);
|
||||
console.log('[DB] Legacy packaged database location was:', LEGACY_PACKAGED_DB_FILE);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true when `data` looks like a valid SQLite file
|
||||
@@ -56,8 +152,11 @@ function isValidSqlite(data: Uint8Array): boolean {
|
||||
* restore the backup before the server loads the database.
|
||||
*/
|
||||
function safeguardDbFile(): Uint8Array | undefined {
|
||||
if (!fs.existsSync(DB_FILE))
|
||||
return undefined;
|
||||
if (!fs.existsSync(DB_FILE)) {
|
||||
console.warn(`[DB] ${DB_FILE} is missing - checking backup`);
|
||||
|
||||
return restoreFromBackup('Database file missing');
|
||||
}
|
||||
|
||||
const data = new Uint8Array(fs.readFileSync(DB_FILE));
|
||||
|
||||
@@ -72,22 +171,7 @@ function safeguardDbFile(): Uint8Array | undefined {
|
||||
// The main file is corrupt or empty.
|
||||
console.warn(`[DB] ${DB_FILE} appears corrupt (${data.length} bytes) - checking backup`);
|
||||
|
||||
if (fs.existsSync(DB_BACKUP)) {
|
||||
const backup = new Uint8Array(fs.readFileSync(DB_BACKUP));
|
||||
|
||||
if (isValidSqlite(backup)) {
|
||||
fs.copyFileSync(DB_BACKUP, DB_FILE);
|
||||
console.warn('[DB] Restored database from backup', DB_BACKUP);
|
||||
|
||||
return backup;
|
||||
}
|
||||
|
||||
console.error('[DB] Backup is also invalid - starting with a fresh database');
|
||||
} else {
|
||||
console.error('[DB] No backup available - starting with a fresh database');
|
||||
}
|
||||
|
||||
return undefined;
|
||||
return restoreFromBackup(`Database file is invalid (${data.length} bytes)`);
|
||||
}
|
||||
|
||||
function resolveSqlJsConfig(): { locateFile: (file: string) => string } {
|
||||
@@ -108,18 +192,47 @@ function resolveSqlJsConfig(): { locateFile: (file: string) => string } {
|
||||
* then rename it over the real file. rename() is atomic on the same
|
||||
* filesystem, so a crash mid-write can never leave a half-written DB.
|
||||
*/
|
||||
async function atomicSave(data: Uint8Array): Promise<void> {
|
||||
async function replaceDatabaseFile(tmpPath: string): Promise<void> {
|
||||
for (let attempt = 0; ; attempt++) {
|
||||
try {
|
||||
await fsp.rename(tmpPath, DB_FILE);
|
||||
return;
|
||||
} catch (error) {
|
||||
const delay = SAVE_RETRY_DELAYS_MS[attempt];
|
||||
|
||||
if (!isRetryableSaveError(error) || delay === undefined) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
await wait(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function writeDatabaseSnapshot(snapshot: Buffer): Promise<void> {
|
||||
const tmpPath = DB_FILE + '.tmp-' + randomBytes(6).toString('hex');
|
||||
|
||||
try {
|
||||
await fsp.writeFile(tmpPath, Buffer.from(data));
|
||||
await fsp.rename(tmpPath, DB_FILE);
|
||||
await fsp.writeFile(tmpPath, snapshot);
|
||||
await replaceDatabaseFile(tmpPath);
|
||||
} catch (err) {
|
||||
await fsp.unlink(tmpPath).catch(() => {});
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
async function atomicSave(data: Uint8Array): Promise<void> {
|
||||
const snapshot = Buffer.from(data);
|
||||
const saveTask = saveQueue.then(
|
||||
() => writeDatabaseSnapshot(snapshot),
|
||||
() => writeDatabaseSnapshot(snapshot)
|
||||
);
|
||||
|
||||
saveQueue = saveTask.catch(() => {});
|
||||
|
||||
return saveTask;
|
||||
}
|
||||
|
||||
export function getDataSource(): DataSource {
|
||||
if (!applicationDataSource?.isInitialized) {
|
||||
throw new Error('DataSource not initialised');
|
||||
@@ -132,6 +245,8 @@ export async function initDatabase(): Promise<void> {
|
||||
if (!fs.existsSync(DATA_DIR))
|
||||
fs.mkdirSync(DATA_DIR, { recursive: true });
|
||||
|
||||
await migrateLegacyPackagedDatabase();
|
||||
|
||||
const database = safeguardDbFile();
|
||||
|
||||
try {
|
||||
@@ -149,7 +264,13 @@ export async function initDatabase(): Promise<void> {
|
||||
JoinRequestEntity,
|
||||
ServerMembershipEntity,
|
||||
ServerInviteEntity,
|
||||
ServerBanEntity
|
||||
ServerBanEntity,
|
||||
GameMatchMissEntity,
|
||||
ServerPluginRequirementEntity,
|
||||
ServerPluginEventDefinitionEntity,
|
||||
PluginDataEntity,
|
||||
ServerPluginSettingsEntity,
|
||||
PluginUserMetadataEntity
|
||||
],
|
||||
migrations: serverMigrations,
|
||||
synchronize: process.env.DB_SYNCHRONIZE === 'true',
|
||||
|
||||
22
server/src/entities/GameMatchMissEntity.ts
Normal file
22
server/src/entities/GameMatchMissEntity.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
Index,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('game_match_misses')
|
||||
export class GameMatchMissEntity {
|
||||
@PrimaryColumn('text')
|
||||
processKey!: string;
|
||||
|
||||
@Column('text')
|
||||
processName!: string;
|
||||
|
||||
@Column('integer')
|
||||
missedAt!: number;
|
||||
|
||||
@Index()
|
||||
@Column('integer')
|
||||
expiresAt!: number;
|
||||
}
|
||||
35
server/src/entities/PluginDataEntity.ts
Normal file
35
server/src/entities/PluginDataEntity.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('plugin_data')
|
||||
export class PluginDataEntity {
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
scope!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
ownerId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
key!: string;
|
||||
|
||||
@Column('text')
|
||||
valueJson!: string;
|
||||
|
||||
@Column('integer', { default: 1 })
|
||||
schemaVersion!: number;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
updatedBy!: string | null;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
38
server/src/entities/PluginUserMetadataEntity.ts
Normal file
38
server/src/entities/PluginUserMetadataEntity.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('plugin_user_metadata')
|
||||
export class PluginUserMetadataEntity {
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginUserId!: string;
|
||||
|
||||
@Column('text')
|
||||
displayName!: string;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
avatarHash!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
avatarMime!: string | null;
|
||||
|
||||
@Column('integer', { nullable: true })
|
||||
avatarUpdatedAt!: number | null;
|
||||
|
||||
@Column('text')
|
||||
roleIdsJson!: string;
|
||||
|
||||
@Column('integer')
|
||||
createdAt!: number;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
41
server/src/entities/ServerPluginEventDefinitionEntity.ts
Normal file
41
server/src/entities/ServerPluginEventDefinitionEntity.ts
Normal file
@@ -0,0 +1,41 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
export type ServerPluginEventDirection = 'clientToServer' | 'serverRelay' | 'p2pHint';
|
||||
export type ServerPluginEventScope = 'server' | 'channel' | 'user' | 'plugin';
|
||||
|
||||
@Entity('server_plugin_event_definitions')
|
||||
export class ServerPluginEventDefinitionEntity {
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
eventName!: string;
|
||||
|
||||
@Column('text')
|
||||
direction!: ServerPluginEventDirection;
|
||||
|
||||
@Column('text')
|
||||
scope!: ServerPluginEventScope;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
schemaJson!: string | null;
|
||||
|
||||
@Column('integer')
|
||||
maxPayloadBytes!: number;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
rateLimitJson!: string | null;
|
||||
|
||||
@Column('integer')
|
||||
createdAt!: number;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
45
server/src/entities/ServerPluginRequirementEntity.ts
Normal file
45
server/src/entities/ServerPluginRequirementEntity.ts
Normal file
@@ -0,0 +1,45 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
Index,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
export type ServerPluginRequirementStatus = 'required' | 'optional' | 'recommended' | 'blocked' | 'incompatible';
|
||||
|
||||
@Entity('server_plugin_requirements')
|
||||
export class ServerPluginRequirementEntity {
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@Index()
|
||||
@Column('text')
|
||||
status!: ServerPluginRequirementStatus;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
versionRange!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
reason!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
installUrl!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
sourceUrl!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
manifestJson!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
configuredBy!: string | null;
|
||||
|
||||
@Column('integer')
|
||||
createdAt!: number;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
26
server/src/entities/ServerPluginSettingsEntity.ts
Normal file
26
server/src/entities/ServerPluginSettingsEntity.ts
Normal file
@@ -0,0 +1,26 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('server_plugin_settings')
|
||||
export class ServerPluginSettingsEntity {
|
||||
@PrimaryColumn('text')
|
||||
serverId!: string;
|
||||
|
||||
@PrimaryColumn('text')
|
||||
pluginId!: string;
|
||||
|
||||
@Column('text')
|
||||
settingsJson!: string;
|
||||
|
||||
@Column('integer', { default: 1 })
|
||||
schemaVersion!: number;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
updatedBy!: string | null;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
@@ -9,3 +9,11 @@ export { JoinRequestEntity } from './JoinRequestEntity';
|
||||
export { ServerMembershipEntity } from './ServerMembershipEntity';
|
||||
export { ServerInviteEntity } from './ServerInviteEntity';
|
||||
export { ServerBanEntity } from './ServerBanEntity';
|
||||
export { GameMatchMissEntity } from './GameMatchMissEntity';
|
||||
export { ServerPluginRequirementEntity } from './ServerPluginRequirementEntity';
|
||||
export type { ServerPluginRequirementStatus } from './ServerPluginRequirementEntity';
|
||||
export { ServerPluginEventDefinitionEntity } from './ServerPluginEventDefinitionEntity';
|
||||
export type { ServerPluginEventDirection, ServerPluginEventScope } from './ServerPluginEventDefinitionEntity';
|
||||
export { PluginDataEntity } from './PluginDataEntity';
|
||||
export { ServerPluginSettingsEntity } from './ServerPluginSettingsEntity';
|
||||
export { PluginUserMetadataEntity } from './PluginUserMetadataEntity';
|
||||
|
||||
@@ -137,7 +137,7 @@ async function gracefulShutdown(signal: string): Promise<void> {
|
||||
staleJoinRequestInterval = null;
|
||||
}
|
||||
|
||||
console.log(`\n[Shutdown] ${signal} received - closing database…`);
|
||||
console.log(`\n[Shutdown] ${signal} received - closing database...`);
|
||||
|
||||
if (listeningServer?.listening) {
|
||||
try {
|
||||
|
||||
24
server/src/migrations/1000000000006-GameMatchMisses.ts
Normal file
24
server/src/migrations/1000000000006-GameMatchMisses.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class GameMatchMisses1000000000006 implements MigrationInterface {
|
||||
name = 'GameMatchMisses1000000000006';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "game_match_misses" (
|
||||
"processKey" TEXT PRIMARY KEY NOT NULL,
|
||||
"processName" TEXT NOT NULL,
|
||||
"missedAt" INTEGER NOT NULL,
|
||||
"expiresAt" INTEGER NOT NULL
|
||||
)
|
||||
`);
|
||||
await queryRunner.query(`
|
||||
CREATE INDEX IF NOT EXISTS "idx_game_match_misses_expiresAt"
|
||||
ON "game_match_misses" ("expiresAt")
|
||||
`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "game_match_misses"`);
|
||||
}
|
||||
}
|
||||
92
server/src/migrations/1000000000007-PluginSupport.ts
Normal file
92
server/src/migrations/1000000000007-PluginSupport.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class PluginSupport1000000000007 implements MigrationInterface {
|
||||
name = 'PluginSupport1000000000007';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "server_plugin_requirements" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"status" TEXT NOT NULL,
|
||||
"versionRange" TEXT,
|
||||
"reason" TEXT,
|
||||
"configuredBy" TEXT,
|
||||
"createdAt" INTEGER NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId")
|
||||
)
|
||||
`);
|
||||
await queryRunner.query(`
|
||||
CREATE INDEX IF NOT EXISTS "idx_server_plugin_requirements_status"
|
||||
ON "server_plugin_requirements" ("status")
|
||||
`);
|
||||
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "server_plugin_event_definitions" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"eventName" TEXT NOT NULL,
|
||||
"direction" TEXT NOT NULL,
|
||||
"scope" TEXT NOT NULL,
|
||||
"schemaJson" TEXT,
|
||||
"maxPayloadBytes" INTEGER NOT NULL,
|
||||
"rateLimitJson" TEXT,
|
||||
"createdAt" INTEGER NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId", "eventName")
|
||||
)
|
||||
`);
|
||||
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "plugin_data" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"scope" TEXT NOT NULL,
|
||||
"ownerId" TEXT NOT NULL,
|
||||
"key" TEXT NOT NULL,
|
||||
"valueJson" TEXT NOT NULL,
|
||||
"schemaVersion" INTEGER NOT NULL DEFAULT 1,
|
||||
"updatedBy" TEXT,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId", "scope", "ownerId", "key")
|
||||
)
|
||||
`);
|
||||
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "server_plugin_settings" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"settingsJson" TEXT NOT NULL,
|
||||
"schemaVersion" INTEGER NOT NULL DEFAULT 1,
|
||||
"updatedBy" TEXT,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId")
|
||||
)
|
||||
`);
|
||||
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "plugin_user_metadata" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"pluginUserId" TEXT NOT NULL,
|
||||
"displayName" TEXT NOT NULL,
|
||||
"avatarHash" TEXT,
|
||||
"avatarMime" TEXT,
|
||||
"avatarUpdatedAt" INTEGER,
|
||||
"roleIdsJson" TEXT NOT NULL,
|
||||
"createdAt" INTEGER NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId", "pluginUserId")
|
||||
)
|
||||
`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "plugin_user_metadata"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "server_plugin_settings"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "plugin_data"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "server_plugin_event_definitions"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "server_plugin_requirements"`);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class ServerPluginInstallMetadata1000000000008 implements MigrationInterface {
|
||||
name = 'ServerPluginInstallMetadata1000000000008';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`ALTER TABLE "server_plugin_requirements" ADD COLUMN "installUrl" TEXT`);
|
||||
await queryRunner.query(`ALTER TABLE "server_plugin_requirements" ADD COLUMN "sourceUrl" TEXT`);
|
||||
await queryRunner.query(`ALTER TABLE "server_plugin_requirements" ADD COLUMN "manifestJson" TEXT`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`CREATE TABLE "temporary_server_plugin_requirements" (
|
||||
"serverId" TEXT NOT NULL,
|
||||
"pluginId" TEXT NOT NULL,
|
||||
"status" TEXT NOT NULL,
|
||||
"versionRange" TEXT,
|
||||
"reason" TEXT,
|
||||
"configuredBy" TEXT,
|
||||
"createdAt" INTEGER NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL,
|
||||
PRIMARY KEY ("serverId", "pluginId")
|
||||
)`);
|
||||
await queryRunner.query(`INSERT INTO "temporary_server_plugin_requirements" ("serverId", "pluginId", "status", "versionRange", "reason", "configuredBy", "createdAt", "updatedAt")
|
||||
SELECT "serverId", "pluginId", "status", "versionRange", "reason", "configuredBy", "createdAt", "updatedAt" FROM "server_plugin_requirements"`);
|
||||
await queryRunner.query(`DROP TABLE "server_plugin_requirements"`);
|
||||
await queryRunner.query(`ALTER TABLE "temporary_server_plugin_requirements" RENAME TO "server_plugin_requirements"`);
|
||||
await queryRunner.query(`CREATE INDEX IF NOT EXISTS "idx_server_plugin_requirements_status" ON "server_plugin_requirements" ("status")`);
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,9 @@ import { ServerChannels1000000000002 } from './1000000000002-ServerChannels';
|
||||
import { RepairLegacyVoiceChannels1000000000003 } from './1000000000003-RepairLegacyVoiceChannels';
|
||||
import { NormalizeServerArrays1000000000004 } from './1000000000004-NormalizeServerArrays';
|
||||
import { ServerRoleAccessControl1000000000005 } from './1000000000005-ServerRoleAccessControl';
|
||||
import { GameMatchMisses1000000000006 } from './1000000000006-GameMatchMisses';
|
||||
import { PluginSupport1000000000007 } from './1000000000007-PluginSupport';
|
||||
import { ServerPluginInstallMetadata1000000000008 } from './1000000000008-ServerPluginInstallMetadata';
|
||||
|
||||
export const serverMigrations = [
|
||||
InitialSchema1000000000000,
|
||||
@@ -11,5 +14,8 @@ export const serverMigrations = [
|
||||
ServerChannels1000000000002,
|
||||
RepairLegacyVoiceChannels1000000000003,
|
||||
NormalizeServerArrays1000000000004,
|
||||
ServerRoleAccessControl1000000000005
|
||||
ServerRoleAccessControl1000000000005,
|
||||
GameMatchMisses1000000000006,
|
||||
PluginSupport1000000000007,
|
||||
ServerPluginInstallMetadata1000000000008
|
||||
];
|
||||
|
||||
17
server/src/routes/games.ts
Normal file
17
server/src/routes/games.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { Router } from 'express';
|
||||
import { matchRunningGames } from '../services/game-matching.service';
|
||||
|
||||
const router = Router();
|
||||
|
||||
router.post('/match', async (req, res) => {
|
||||
try {
|
||||
const result = await matchRunningGames(req.body?.processes, req.body?.userId ?? req.ip);
|
||||
|
||||
res.json(result);
|
||||
} catch (error) {
|
||||
console.error('[Games] Failed to match running games', error);
|
||||
res.status(500).json({ error: 'Failed to match running games' });
|
||||
}
|
||||
});
|
||||
|
||||
export default router;
|
||||
@@ -2,9 +2,12 @@ import { Express } from 'express';
|
||||
import healthRouter from './health';
|
||||
import klipyRouter from './klipy';
|
||||
import linkMetadataRouter from './link-metadata';
|
||||
import gamesRouter from './games';
|
||||
import proxyRouter from './proxy';
|
||||
import usersRouter from './users';
|
||||
import serversRouter from './servers';
|
||||
import pluginSupportRouter from './plugin-support';
|
||||
import openApiDocsRouter from './openapi-docs';
|
||||
import joinRequestsRouter from './join-requests';
|
||||
import { invitesApiRouter, invitePageRouter } from './invites';
|
||||
|
||||
@@ -12,8 +15,11 @@ export function registerRoutes(app: Express): void {
|
||||
app.use('/api', healthRouter);
|
||||
app.use('/api', klipyRouter);
|
||||
app.use('/api', linkMetadataRouter);
|
||||
app.use('/api/games', gamesRouter);
|
||||
app.use('/api', proxyRouter);
|
||||
app.use('/api/users', usersRouter);
|
||||
app.use('/api', openApiDocsRouter);
|
||||
app.use('/api/servers', pluginSupportRouter);
|
||||
app.use('/api/servers', serversRouter);
|
||||
app.use('/api/invites', invitesApiRouter);
|
||||
app.use('/api/requests', joinRequestsRouter);
|
||||
|
||||
106
server/src/routes/openapi-docs.ts
Normal file
106
server/src/routes/openapi-docs.ts
Normal file
@@ -0,0 +1,106 @@
|
||||
import { Router } from 'express';
|
||||
import { areOpenApiDocsEnabled, setOpenApiDocsEnabled } from '../config/variables';
|
||||
|
||||
const router = Router();
|
||||
|
||||
function createOpenApiDocument(baseUrl: string) {
|
||||
return {
|
||||
openapi: '3.1.0',
|
||||
info: {
|
||||
title: 'MetoYou Plugin Support API',
|
||||
version: '1.0.0',
|
||||
description: 'Official HTTP endpoints for plugin install metadata and event definitions. '
|
||||
+ 'Plugin code is never executed by the signal server.'
|
||||
},
|
||||
servers: [{ url: `${baseUrl}/api` }],
|
||||
paths: {
|
||||
'/servers/{serverId}/plugins': {
|
||||
get: {
|
||||
summary: 'Read plugin requirement snapshot',
|
||||
parameters: [{ name: 'serverId', in: 'path', required: true, schema: { type: 'string' } }],
|
||||
responses: { '200': { description: 'Plugin requirements and event definitions' } }
|
||||
}
|
||||
},
|
||||
'/servers/{serverId}/plugins/{pluginId}/requirement': {
|
||||
put: {
|
||||
summary: 'Create or update a server plugin requirement',
|
||||
responses: { '200': { description: 'Requirement saved' }, '403': { description: 'Not authorized' } }
|
||||
},
|
||||
delete: {
|
||||
summary: 'Delete a server plugin requirement',
|
||||
responses: { '200': { description: 'Requirement deleted' }, '403': { description: 'Not authorized' } }
|
||||
}
|
||||
},
|
||||
'/servers/{serverId}/plugins/{pluginId}/events/{eventName}': {
|
||||
put: {
|
||||
summary: 'Create or update a plugin event definition',
|
||||
responses: { '200': { description: 'Event definition saved' }, '403': { description: 'Not authorized' } }
|
||||
},
|
||||
delete: {
|
||||
summary: 'Delete a plugin event definition',
|
||||
responses: { '200': { description: 'Event definition deleted' }, '403': { description: 'Not authorized' } }
|
||||
}
|
||||
},
|
||||
'/servers/{serverId}/plugins/{pluginId}/data': {
|
||||
get: {
|
||||
summary: 'Plugin data persistence disabled',
|
||||
responses: { '410': { description: 'Plugin data persistence is disabled on the signal server' } }
|
||||
}
|
||||
},
|
||||
'/servers/{serverId}/plugins/{pluginId}/data/{key}': {
|
||||
put: {
|
||||
summary: 'Plugin data persistence disabled',
|
||||
responses: { '410': { description: 'Plugin data persistence is disabled on the signal server' } }
|
||||
},
|
||||
delete: {
|
||||
summary: 'Plugin data persistence disabled',
|
||||
responses: { '410': { description: 'Plugin data persistence is disabled on the signal server' } }
|
||||
}
|
||||
},
|
||||
'/openapi/settings': {
|
||||
get: { summary: 'Read OpenAPI docs setting', responses: { '200': { description: 'Setting value' } } },
|
||||
put: { summary: 'Toggle OpenAPI docs exposure', responses: { '200': { description: 'Setting value' } } }
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function docsDisabledResponse() {
|
||||
return { error: 'OpenAPI docs are disabled', errorCode: 'OPENAPI_DOCS_DISABLED' };
|
||||
}
|
||||
|
||||
router.get('/openapi/settings', (_req, res) => {
|
||||
res.json({ enabled: areOpenApiDocsEnabled() });
|
||||
});
|
||||
|
||||
router.put('/openapi/settings', (req, res) => {
|
||||
res.json(setOpenApiDocsEnabled(req.body?.enabled === true));
|
||||
});
|
||||
|
||||
router.get('/openapi.json', (req, res) => {
|
||||
if (!areOpenApiDocsEnabled()) {
|
||||
res.status(404).json(docsDisabledResponse());
|
||||
return;
|
||||
}
|
||||
|
||||
res.json(createOpenApiDocument(`${req.protocol}://${req.get('host') ?? 'localhost'}`));
|
||||
});
|
||||
|
||||
router.get('/docs', (_req, res) => {
|
||||
if (!areOpenApiDocsEnabled()) {
|
||||
res.status(404).json(docsDisabledResponse());
|
||||
return;
|
||||
}
|
||||
|
||||
res.type('html').send(`<!doctype html>
|
||||
<html lang="en">
|
||||
<head><meta charset="utf-8"><title>MetoYou Plugin API Docs</title></head>
|
||||
<body style="font-family:system-ui;margin:2rem;line-height:1.5">
|
||||
<h1>MetoYou Plugin Support API</h1>
|
||||
<p>Plugin support endpoints are available at <a href="/api/openapi.json">/api/openapi.json</a>.</p>
|
||||
<p>The signal server stores plugin install metadata and event definitions only. It never executes plugin code or stores arbitrary plugin data.</p>
|
||||
</body>
|
||||
</html>`);
|
||||
});
|
||||
|
||||
export default router;
|
||||
148
server/src/routes/plugin-support.ts
Normal file
148
server/src/routes/plugin-support.ts
Normal file
@@ -0,0 +1,148 @@
|
||||
import { Response, Router } from 'express';
|
||||
import {
|
||||
deletePluginEventDefinition,
|
||||
deletePluginRequirement,
|
||||
getPluginRequirementsSnapshot,
|
||||
PluginSupportError,
|
||||
upsertPluginEventDefinition,
|
||||
upsertPluginRequirement
|
||||
} from '../services/plugin-support.service';
|
||||
import { broadcastToServer } from '../websocket/broadcast';
|
||||
|
||||
const router = Router();
|
||||
|
||||
function sendPluginSupportError(error: unknown, res: Response): void {
|
||||
if (error instanceof PluginSupportError) {
|
||||
res.status(error.status).json({ error: error.message, errorCode: error.code });
|
||||
return;
|
||||
}
|
||||
|
||||
console.error('Unhandled plugin support error:', error);
|
||||
res.status(500).json({ error: 'Internal server error', errorCode: 'INTERNAL_ERROR' });
|
||||
}
|
||||
|
||||
function readActorUserId(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
|
||||
async function broadcastRequirementsSnapshot(serverId: string): Promise<void> {
|
||||
const snapshot = await getPluginRequirementsSnapshot(serverId);
|
||||
|
||||
broadcastToServer(serverId, {
|
||||
type: 'plugin_requirements_changed',
|
||||
serverId,
|
||||
snapshot
|
||||
});
|
||||
}
|
||||
|
||||
router.get('/:serverId/plugins', async (req, res) => {
|
||||
try {
|
||||
res.json(await getPluginRequirementsSnapshot(req.params.serverId));
|
||||
} catch (error) {
|
||||
sendPluginSupportError(error, res);
|
||||
}
|
||||
});
|
||||
|
||||
router.put('/:serverId/plugins/:pluginId/requirement', async (req, res) => {
|
||||
const { serverId, pluginId } = req.params;
|
||||
|
||||
try {
|
||||
const requirement = await upsertPluginRequirement({
|
||||
actorUserId: readActorUserId(req.body.actorUserId),
|
||||
installUrl: req.body.installUrl,
|
||||
manifest: req.body.manifest,
|
||||
pluginId,
|
||||
reason: req.body.reason,
|
||||
serverId,
|
||||
sourceUrl: req.body.sourceUrl,
|
||||
status: req.body.status,
|
||||
versionRange: req.body.versionRange
|
||||
});
|
||||
|
||||
await broadcastRequirementsSnapshot(serverId);
|
||||
res.json({ requirement });
|
||||
} catch (error) {
|
||||
sendPluginSupportError(error, res);
|
||||
}
|
||||
});
|
||||
|
||||
router.delete('/:serverId/plugins/:pluginId/requirement', async (req, res) => {
|
||||
const { serverId, pluginId } = req.params;
|
||||
|
||||
try {
|
||||
await deletePluginRequirement({
|
||||
actorUserId: readActorUserId(req.body.actorUserId),
|
||||
pluginId,
|
||||
serverId
|
||||
});
|
||||
|
||||
await broadcastRequirementsSnapshot(serverId);
|
||||
res.json({ ok: true });
|
||||
} catch (error) {
|
||||
sendPluginSupportError(error, res);
|
||||
}
|
||||
});
|
||||
|
||||
router.put('/:serverId/plugins/:pluginId/events/:eventName', async (req, res) => {
|
||||
const { serverId, pluginId, eventName } = req.params;
|
||||
|
||||
try {
|
||||
const eventDefinition = await upsertPluginEventDefinition({
|
||||
actorUserId: readActorUserId(req.body.actorUserId),
|
||||
direction: req.body.direction,
|
||||
eventName,
|
||||
maxPayloadBytes: req.body.maxPayloadBytes,
|
||||
pluginId,
|
||||
rateLimitJson: req.body.rateLimitJson,
|
||||
schemaJson: req.body.schemaJson,
|
||||
scope: req.body.scope,
|
||||
serverId
|
||||
});
|
||||
|
||||
await broadcastRequirementsSnapshot(serverId);
|
||||
res.json({ eventDefinition });
|
||||
} catch (error) {
|
||||
sendPluginSupportError(error, res);
|
||||
}
|
||||
});
|
||||
|
||||
router.delete('/:serverId/plugins/:pluginId/events/:eventName', async (req, res) => {
|
||||
const { serverId, pluginId, eventName } = req.params;
|
||||
|
||||
try {
|
||||
await deletePluginEventDefinition({
|
||||
actorUserId: readActorUserId(req.body.actorUserId),
|
||||
eventName,
|
||||
pluginId,
|
||||
serverId
|
||||
});
|
||||
|
||||
await broadcastRequirementsSnapshot(serverId);
|
||||
res.json({ ok: true });
|
||||
} catch (error) {
|
||||
sendPluginSupportError(error, res);
|
||||
}
|
||||
});
|
||||
|
||||
router.get('/:serverId/plugins/:pluginId/data', (_req, res) => {
|
||||
res.status(410).json({
|
||||
error: 'Plugin data persistence is disabled on the signal server',
|
||||
errorCode: 'PLUGIN_DATA_DISABLED'
|
||||
});
|
||||
});
|
||||
|
||||
router.put('/:serverId/plugins/:pluginId/data/:key', (_req, res) => {
|
||||
res.status(410).json({
|
||||
error: 'Plugin data persistence is disabled on the signal server',
|
||||
errorCode: 'PLUGIN_DATA_DISABLED'
|
||||
});
|
||||
});
|
||||
|
||||
router.delete('/:serverId/plugins/:pluginId/data/:key', (_req, res) => {
|
||||
res.status(410).json({
|
||||
error: 'Plugin data persistence is disabled on the signal server',
|
||||
errorCode: 'PLUGIN_DATA_DISABLED'
|
||||
});
|
||||
});
|
||||
|
||||
export default router;
|
||||
@@ -19,7 +19,8 @@ import {
|
||||
ServerAccessError,
|
||||
kickServerUser,
|
||||
ensureServerMembership,
|
||||
unbanServerUser
|
||||
unbanServerUser,
|
||||
countServerMemberships
|
||||
} from '../services/server-access.service';
|
||||
import {
|
||||
buildAppInviteUrl,
|
||||
@@ -78,6 +79,7 @@ function normalizeServerChannels(value: unknown): ServerChannelPayload[] {
|
||||
|
||||
async function enrichServer(server: ServerPayload, sourceUrl?: string) {
|
||||
const owner = await getUserById(server.ownerId);
|
||||
const userCount = await countServerMemberships(server.id);
|
||||
const { passwordHash, ...publicServer } = server;
|
||||
|
||||
return {
|
||||
@@ -85,7 +87,8 @@ async function enrichServer(server: ServerPayload, sourceUrl?: string) {
|
||||
hasPassword: server.hasPassword ?? !!passwordHash,
|
||||
ownerName: owner?.displayName,
|
||||
sourceUrl,
|
||||
userCount: server.currentUsers
|
||||
currentUsers: userCount,
|
||||
userCount
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
import fs from 'fs';
|
||||
import os from 'os';
|
||||
import path from 'path';
|
||||
|
||||
const PACKAGED_DATA_DIRECTORY_NAME = 'MetoYou Server';
|
||||
|
||||
type PackagedProcess = NodeJS.Process & { pkg?: unknown };
|
||||
|
||||
function uniquePaths(paths: string[]): string[] {
|
||||
@@ -21,6 +24,33 @@ export function resolveRuntimePath(...segments: string[]): string {
|
||||
return path.join(getRuntimeBaseDir(), ...segments);
|
||||
}
|
||||
|
||||
function resolvePackagedDataDirectory(): string {
|
||||
const homeDirectory = os.homedir();
|
||||
|
||||
switch (process.platform) {
|
||||
case 'win32':
|
||||
return path.join(
|
||||
process.env.APPDATA || path.join(homeDirectory, 'AppData', 'Roaming'),
|
||||
PACKAGED_DATA_DIRECTORY_NAME
|
||||
);
|
||||
case 'darwin':
|
||||
return path.join(homeDirectory, 'Library', 'Application Support', PACKAGED_DATA_DIRECTORY_NAME);
|
||||
default:
|
||||
return path.join(
|
||||
process.env.XDG_DATA_HOME || path.join(homeDirectory, '.local', 'share'),
|
||||
PACKAGED_DATA_DIRECTORY_NAME
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
export function resolvePersistentDataPath(...segments: string[]): string {
|
||||
if (!isPackagedRuntime()) {
|
||||
return resolveRuntimePath(...segments);
|
||||
}
|
||||
|
||||
return path.join(resolvePackagedDataDirectory(), ...segments);
|
||||
}
|
||||
|
||||
export function resolveProjectRootPath(...segments: string[]): string {
|
||||
return path.resolve(__dirname, '..', '..', ...segments);
|
||||
}
|
||||
|
||||
591
server/src/services/game-matching.service.ts
Normal file
591
server/src/services/game-matching.service.ts
Normal file
@@ -0,0 +1,591 @@
|
||||
import { getRawgApiKey } from '../config/variables';
|
||||
import { getDataSource } from '../db/database';
|
||||
import { GameMatchMissEntity } from '../entities';
|
||||
|
||||
export interface MatchedGame {
|
||||
id: string;
|
||||
name: string;
|
||||
iconUrl?: string;
|
||||
store?: GameStoreLink;
|
||||
processName: string;
|
||||
}
|
||||
|
||||
export interface GameStoreLink {
|
||||
id?: string;
|
||||
name: string;
|
||||
slug?: string;
|
||||
domain?: string;
|
||||
url: string;
|
||||
}
|
||||
|
||||
interface CacheEntry {
|
||||
expiresAt: number;
|
||||
game: Omit<MatchedGame, 'processName'> | null;
|
||||
}
|
||||
|
||||
interface RawgSearchResponse {
|
||||
results?: RawgGameResult[];
|
||||
}
|
||||
|
||||
interface RawgGameResult {
|
||||
id?: number;
|
||||
name?: string;
|
||||
background_image?: string | null;
|
||||
slug?: string;
|
||||
stores?: RawgStoreEntry[] | null;
|
||||
}
|
||||
|
||||
interface RawgStoreEntry {
|
||||
url?: string | null;
|
||||
store?: RawgStore | null;
|
||||
}
|
||||
|
||||
interface RawgStore {
|
||||
id?: number;
|
||||
name?: string;
|
||||
slug?: string;
|
||||
domain?: string | null;
|
||||
}
|
||||
|
||||
interface CandidateProcess {
|
||||
processName: string;
|
||||
score: number;
|
||||
}
|
||||
|
||||
interface GameMatchResult {
|
||||
games: MatchedGame[];
|
||||
rateLimited?: boolean;
|
||||
}
|
||||
|
||||
interface RawgLookupBudget {
|
||||
used: number;
|
||||
windowStartedAt: number;
|
||||
}
|
||||
|
||||
const CACHE_TTL_MS = 24 * 60 * 60 * 1000;
|
||||
const PERSISTED_MISS_TTL_MS = 30 * 24 * 60 * 60 * 1000;
|
||||
const RAWG_LOOKUP_WINDOW_MS = 60 * 60 * 1000;
|
||||
const RAWG_SEARCH_TIMEOUT_MS = 4_000;
|
||||
const MAX_INCOMING_PROCESSES = 256;
|
||||
const MAX_CANDIDATE_PROCESSES = 24;
|
||||
const MAX_UNCACHED_LOOKUPS_PER_REQUEST = 4;
|
||||
const MAX_RAWG_LOOKUPS_PER_USER_PER_WINDOW = 8;
|
||||
const RAWG_SEARCH_URL = 'https://api.rawg.io/api/games';
|
||||
const MIN_SEARCH_QUERY_LENGTH = 4;
|
||||
const IGNORED_PROCESS_NAMES = new Set([
|
||||
'agent',
|
||||
'bash',
|
||||
'baloorunner',
|
||||
'chrome',
|
||||
'code',
|
||||
'conhost',
|
||||
'cursor',
|
||||
'csrss',
|
||||
'dbus-daemon',
|
||||
'discord',
|
||||
'dwm',
|
||||
'electron',
|
||||
'explorer',
|
||||
'firefox',
|
||||
'gameoverlayui',
|
||||
'gamemoded',
|
||||
'gamescopereaper',
|
||||
'gnome-shell',
|
||||
'init',
|
||||
'kernel_task',
|
||||
'metoyou',
|
||||
'nvidia-settings',
|
||||
'node',
|
||||
'npm',
|
||||
'obs',
|
||||
'powershell',
|
||||
'pulseaudio',
|
||||
'services',
|
||||
'steam',
|
||||
'steamwebhelper',
|
||||
'system',
|
||||
'systemd',
|
||||
'taskhostw',
|
||||
'wininit',
|
||||
'winlogon',
|
||||
'xorg'
|
||||
]);
|
||||
const IGNORED_PROCESS_PATTERNS = [
|
||||
new RegExp('(^|\\s)(agent|browser|daemon|desktop|helper|indexer|launcher|monitor|renderer|runner)(\\s|$)'),
|
||||
new RegExp('(^|\\s)(service|settings|shell|tray|updater|utility|watcher|worker)(\\s|$)'),
|
||||
new RegExp('(^|\\s)(audio|bluetooth|clipboard|crash|dbus|file|gpu|input|network|notification)(\\s|$)'),
|
||||
new RegExp('(^|\\s)(portal|proxy|screen|session|sync|system|tracker|web|window)(\\s|$)'),
|
||||
/^(appimage|at-spi|baloo|dconf|gvfs|ibus|kde|kworker)/,
|
||||
/^(pipewire|plasmashell|pulseaudio|xdg|xwayland|zeitgeist)/,
|
||||
/(helper|service|daemon|runner|tracker|portal|updater|worker)$/
|
||||
];
|
||||
const STORE_SEARCH_URL_BUILDERS: Record<string, (query: string) => string> = {
|
||||
steam: (query) => `https://store.steampowered.com/search/?term=${query}`,
|
||||
'epic-games': (query) => `https://store.epicgames.com/en-US/browse?q=${query}`,
|
||||
gog: (query) => `https://www.gog.com/en/games?query=${query}`,
|
||||
itch: (query) => `https://itch.io/search?q=${query}`,
|
||||
'xbox-store': (query) => `https://www.xbox.com/search?q=${query}`,
|
||||
'playstation-store': (query) => `https://store.playstation.com/search/${query}`,
|
||||
nintendo: (query) => `https://www.nintendo.com/search/#q=${query}`,
|
||||
'apple-appstore': (query) => `https://apps.apple.com/us/search?term=${query}`,
|
||||
'google-play': (query) => `https://play.google.com/store/search?q=${query}&c=apps`
|
||||
};
|
||||
const STORE_SEARCH_ALIASES = new Map<string, string>([
|
||||
['steam', 'steam'],
|
||||
['store.steampowered.com', 'steam'],
|
||||
['epic-games', 'epic-games'],
|
||||
['store.epicgames.com', 'epic-games'],
|
||||
['gog', 'gog'],
|
||||
['www.gog.com', 'gog'],
|
||||
['gog.com', 'gog'],
|
||||
['itch', 'itch'],
|
||||
['itch.io', 'itch'],
|
||||
['xbox-store', 'xbox-store'],
|
||||
['www.xbox.com', 'xbox-store'],
|
||||
['xbox.com', 'xbox-store'],
|
||||
['playstation-store', 'playstation-store'],
|
||||
['store.playstation.com', 'playstation-store'],
|
||||
['nintendo', 'nintendo'],
|
||||
['www.nintendo.com', 'nintendo'],
|
||||
['nintendo.com', 'nintendo'],
|
||||
['apple-appstore', 'apple-appstore'],
|
||||
['apps.apple.com', 'apple-appstore'],
|
||||
['google-play', 'google-play'],
|
||||
['play.google.com', 'google-play']
|
||||
]);
|
||||
const STORE_PRIORITY = new Map<string, number>([
|
||||
['steam', 0],
|
||||
['gog', 10],
|
||||
['epic-games', 20],
|
||||
['itch', 30],
|
||||
['xbox-store', 80],
|
||||
['playstation-store', 90]
|
||||
]);
|
||||
const cache = new Map<string, CacheEntry>();
|
||||
const rawgLookupBudgets = new Map<string, RawgLookupBudget>();
|
||||
|
||||
export async function matchRunningGames(
|
||||
processNames: unknown,
|
||||
requester: unknown = 'anonymous'
|
||||
): Promise<GameMatchResult> {
|
||||
const candidates = normalizeProcessList(processNames).slice(0, MAX_CANDIDATE_PROCESSES);
|
||||
const matches: MatchedGame[] = [];
|
||||
const seenGameIds = new Set<string>();
|
||||
const requesterKey = normalizeRequesterKey(requester);
|
||||
const persistedMisses = await loadPersistedMissKeys(candidates.map((candidate) => candidate.processName));
|
||||
|
||||
let uncachedLookups = 0;
|
||||
let rateLimited = false;
|
||||
|
||||
for (const { processName } of candidates) {
|
||||
const cacheKey = normalizeCacheKey(processName);
|
||||
const cached = getCachedGame(cacheKey);
|
||||
|
||||
if (cached !== undefined) {
|
||||
appendMatch(matches, seenGameIds, processName, cached);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (persistedMisses.has(cacheKey)) {
|
||||
setCachedGame(cacheKey, null);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (uncachedLookups >= MAX_UNCACHED_LOOKUPS_PER_REQUEST) {
|
||||
rateLimited = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!tryConsumeRawgLookup(requesterKey)) {
|
||||
rateLimited = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
uncachedLookups += 1;
|
||||
|
||||
const game = await resolveRawgGame(processName);
|
||||
|
||||
setCachedGame(cacheKey, game);
|
||||
|
||||
if (!game) {
|
||||
await rememberPersistedMiss(cacheKey, processName);
|
||||
}
|
||||
|
||||
appendMatch(matches, seenGameIds, processName, game);
|
||||
}
|
||||
|
||||
return {
|
||||
games: matches,
|
||||
rateLimited: rateLimited || undefined
|
||||
};
|
||||
}
|
||||
|
||||
function normalizeProcessList(value: unknown): CandidateProcess[] {
|
||||
if (!Array.isArray(value)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const processes = new Map<string, CandidateProcess>();
|
||||
|
||||
for (const entry of value.slice(0, MAX_INCOMING_PROCESSES)) {
|
||||
const processName = normalizeProcessName(entry);
|
||||
|
||||
if (processName) {
|
||||
const cacheKey = normalizeCacheKey(processName);
|
||||
|
||||
if (!processes.has(cacheKey)) {
|
||||
processes.set(cacheKey, {
|
||||
processName,
|
||||
score: scoreCandidateProcess(String(entry), processName)
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return Array.from(processes.values())
|
||||
.sort((left, right) => right.score - left.score || left.processName.localeCompare(right.processName));
|
||||
}
|
||||
|
||||
function normalizeProcessName(value: unknown): string {
|
||||
if (typeof value !== 'string') {
|
||||
return '';
|
||||
}
|
||||
|
||||
const normalized = value
|
||||
.trim()
|
||||
.replace(/\.exe$/i, '')
|
||||
.replace(/[_-]+/g, ' ')
|
||||
.replace(/\s+/g, ' ')
|
||||
.trim();
|
||||
const cacheKey = normalizeCacheKey(normalized);
|
||||
|
||||
if (normalized.length < 3 || normalized.length > 96 || shouldIgnoreProcessName(cacheKey)) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function shouldIgnoreProcessName(cacheKey: string): boolean {
|
||||
return IGNORED_PROCESS_NAMES.has(cacheKey)
|
||||
|| IGNORED_PROCESS_PATTERNS.some((pattern) => pattern.test(cacheKey));
|
||||
}
|
||||
|
||||
function normalizeRequesterKey(value: unknown): string {
|
||||
if (typeof value !== 'string') {
|
||||
return 'anonymous';
|
||||
}
|
||||
|
||||
const normalized = value.trim().toLowerCase();
|
||||
|
||||
return normalized || 'anonymous';
|
||||
}
|
||||
|
||||
function tryConsumeRawgLookup(requesterKey: string): boolean {
|
||||
const now = Date.now();
|
||||
const existing = rawgLookupBudgets.get(requesterKey);
|
||||
|
||||
if (!existing || existing.windowStartedAt + RAWG_LOOKUP_WINDOW_MS <= now) {
|
||||
rawgLookupBudgets.set(requesterKey, {
|
||||
used: 1,
|
||||
windowStartedAt: now
|
||||
});
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
if (existing.used >= MAX_RAWG_LOOKUPS_PER_USER_PER_WINDOW) {
|
||||
return false;
|
||||
}
|
||||
|
||||
existing.used += 1;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function scoreCandidateProcess(rawValue: string, processName: string): number {
|
||||
let score = 0;
|
||||
|
||||
if (/\.exe$/i.test(rawValue.trim())) {
|
||||
score += 12;
|
||||
}
|
||||
|
||||
if (/[A-Z]/.test(processName) && /[a-z]/.test(processName)) {
|
||||
score += 4;
|
||||
}
|
||||
|
||||
if (/\d/.test(processName)) {
|
||||
score += 1;
|
||||
}
|
||||
|
||||
if (processName.length >= 5 && processName.length <= 32) {
|
||||
score += 2;
|
||||
}
|
||||
|
||||
if (processName.includes(' ')) {
|
||||
score -= 2;
|
||||
}
|
||||
|
||||
return score;
|
||||
}
|
||||
|
||||
function normalizeCacheKey(value: string): string {
|
||||
return value.trim()
|
||||
.toLowerCase()
|
||||
.replace(/\s+/g, ' ');
|
||||
}
|
||||
|
||||
function getCachedGame(cacheKey: string): Omit<MatchedGame, 'processName'> | null | undefined {
|
||||
const cached = cache.get(cacheKey);
|
||||
|
||||
if (!cached) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (cached.expiresAt <= Date.now()) {
|
||||
cache.delete(cacheKey);
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return cached.game;
|
||||
}
|
||||
|
||||
function setCachedGame(cacheKey: string, game: Omit<MatchedGame, 'processName'> | null): void {
|
||||
cache.set(cacheKey, {
|
||||
expiresAt: Date.now() + CACHE_TTL_MS,
|
||||
game
|
||||
});
|
||||
}
|
||||
|
||||
async function loadPersistedMissKeys(processNames: string[]): Promise<Set<string>> {
|
||||
const cacheKeys = Array.from(new Set(processNames.map((name) => normalizeCacheKey(name))));
|
||||
|
||||
if (cacheKeys.length === 0) {
|
||||
return new Set();
|
||||
}
|
||||
|
||||
try {
|
||||
const repository = getDataSource().getRepository(GameMatchMissEntity);
|
||||
const now = Date.now();
|
||||
|
||||
await repository.createQueryBuilder()
|
||||
.delete()
|
||||
.where('expiresAt <= :now', { now })
|
||||
.execute();
|
||||
|
||||
const rows = await repository.createQueryBuilder('miss')
|
||||
.select('miss.processKey')
|
||||
.where('miss.processKey IN (:...cacheKeys)', { cacheKeys })
|
||||
.andWhere('miss.expiresAt > :now', { now })
|
||||
.getMany();
|
||||
|
||||
return new Set(rows.map((row) => row.processKey));
|
||||
} catch {
|
||||
return new Set();
|
||||
}
|
||||
}
|
||||
|
||||
async function rememberPersistedMiss(cacheKey: string, processName: string): Promise<void> {
|
||||
try {
|
||||
const now = Date.now();
|
||||
|
||||
await getDataSource().getRepository(GameMatchMissEntity)
|
||||
.save({
|
||||
processKey: cacheKey,
|
||||
processName,
|
||||
missedAt: now,
|
||||
expiresAt: now + PERSISTED_MISS_TTL_MS
|
||||
});
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
async function resolveRawgGame(processName: string): Promise<Omit<MatchedGame, 'processName'> | null> {
|
||||
const apiKey = getRawgApiKey();
|
||||
|
||||
if (!apiKey) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const query = buildSearchQuery(processName);
|
||||
|
||||
if (!query) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const url = new URL(RAWG_SEARCH_URL);
|
||||
|
||||
url.searchParams.set('key', apiKey);
|
||||
url.searchParams.set('search', query);
|
||||
url.searchParams.set('search_precise', 'true');
|
||||
url.searchParams.set('exclude_additions', 'true');
|
||||
url.searchParams.set('page_size', '1');
|
||||
|
||||
const controller = new AbortController();
|
||||
const timeout = setTimeout(() => controller.abort(), RAWG_SEARCH_TIMEOUT_MS);
|
||||
|
||||
try {
|
||||
const response = await fetch(url, { signal: controller.signal });
|
||||
|
||||
if (!response.ok) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const body = await response.json() as RawgSearchResponse;
|
||||
const result = body.results?.[0];
|
||||
|
||||
if (!isAcceptableRawgMatch(query, result)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
id: String(result.id),
|
||||
name: result.name.trim(),
|
||||
iconUrl: result.background_image || undefined,
|
||||
store: selectPreferredStore(result, result.name.trim())
|
||||
};
|
||||
} catch {
|
||||
return null;
|
||||
} finally {
|
||||
clearTimeout(timeout);
|
||||
}
|
||||
}
|
||||
|
||||
function selectPreferredStore(result: RawgGameResult, gameName: string): GameStoreLink | undefined {
|
||||
const stores = Array.isArray(result.stores) ? result.stores : [];
|
||||
const usableStores = stores
|
||||
.map((entry) => buildStoreLink(entry, gameName))
|
||||
.filter((store): store is GameStoreLink => !!store);
|
||||
|
||||
return usableStores.sort((left, right) => getStorePriority(left) - getStorePriority(right))[0];
|
||||
}
|
||||
|
||||
function getStorePriority(store: GameStoreLink): number {
|
||||
const storeKey = STORE_SEARCH_ALIASES.get(store.slug ?? '')
|
||||
?? STORE_SEARCH_ALIASES.get(store.domain ?? '')
|
||||
?? store.name.trim().toLowerCase();
|
||||
|
||||
return STORE_PRIORITY.get(storeKey) ?? 50;
|
||||
}
|
||||
|
||||
function buildStoreLink(entry: RawgStoreEntry, gameName: string): GameStoreLink | undefined {
|
||||
const store = entry.store;
|
||||
|
||||
if (!store || typeof store.name !== 'string' || !store.name.trim()) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const slug = typeof store.slug === 'string' && store.slug.trim()
|
||||
? store.slug.trim().toLowerCase()
|
||||
: undefined;
|
||||
const domain = typeof store.domain === 'string' && store.domain.trim()
|
||||
? store.domain.trim()
|
||||
.replace(/^https?:\/\//i, '')
|
||||
.replace(/\/$/, '')
|
||||
: undefined;
|
||||
const url = normalizeExternalUrl(entry.url) ?? buildStoreSearchUrl(slug, domain, gameName);
|
||||
|
||||
if (!url) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return {
|
||||
id: typeof store.id === 'number' ? String(store.id) : undefined,
|
||||
name: store.name.trim(),
|
||||
slug,
|
||||
domain,
|
||||
url
|
||||
};
|
||||
}
|
||||
|
||||
function normalizeExternalUrl(value: unknown): string | undefined {
|
||||
if (typeof value !== 'string' || !value.trim()) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const trimmed = value.trim();
|
||||
|
||||
return trimmed.startsWith('http://') || trimmed.startsWith('https://')
|
||||
? trimmed
|
||||
: undefined;
|
||||
}
|
||||
|
||||
function buildStoreSearchUrl(slug: string | undefined, domain: string | undefined, gameName: string): string | undefined {
|
||||
const query = encodeURIComponent(gameName);
|
||||
const storeKey = STORE_SEARCH_ALIASES.get(slug ?? '') ?? STORE_SEARCH_ALIASES.get(domain ?? '');
|
||||
const buildUrl = storeKey ? STORE_SEARCH_URL_BUILDERS[storeKey] : undefined;
|
||||
|
||||
return buildUrl?.(query) ?? (domain ? `https://${domain}` : undefined);
|
||||
}
|
||||
|
||||
function buildSearchQuery(processName: string): string {
|
||||
const query = processName
|
||||
.replace(/\.exe$/i, '')
|
||||
.replace(/\b(x64|x86|win64|win32|linux|shipping|client|launcher|game)\b/gi, ' ')
|
||||
.replace(/\s+/g, ' ')
|
||||
.trim();
|
||||
|
||||
return query.length >= MIN_SEARCH_QUERY_LENGTH ? query : '';
|
||||
}
|
||||
|
||||
function isAcceptableRawgMatch(
|
||||
query: string,
|
||||
result: RawgGameResult | undefined
|
||||
): result is Required<Pick<RawgGameResult, 'id' | 'name'>> & RawgGameResult {
|
||||
if (!result || typeof result.id !== 'number' || typeof result.name !== 'string' || !result.name.trim()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const queryKey = normalizeComparableText(query);
|
||||
const nameKey = normalizeComparableText(result.name);
|
||||
const slugKey = normalizeComparableText(result.slug ?? '');
|
||||
const queryTokens = tokenizeComparableText(queryKey);
|
||||
const nameTokens = tokenizeComparableText(nameKey);
|
||||
const slugTokens = tokenizeComparableText(slugKey);
|
||||
|
||||
if (queryKey.length < MIN_SEARCH_QUERY_LENGTH || queryTokens.length === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (queryKey === nameKey || queryKey === slugKey) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (queryTokens.length === 1) {
|
||||
const [queryToken] = queryTokens;
|
||||
|
||||
return queryToken.length >= 5
|
||||
&& (nameTokens.includes(queryToken) || slugTokens.includes(queryToken));
|
||||
}
|
||||
|
||||
return queryTokens.every((token) => nameTokens.includes(token) || slugTokens.includes(token));
|
||||
}
|
||||
|
||||
function normalizeComparableText(value: string): string {
|
||||
return value.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, ' ')
|
||||
.trim();
|
||||
}
|
||||
|
||||
function tokenizeComparableText(value: string): string[] {
|
||||
return value.split(' ')
|
||||
.filter((token) => token.length >= 2);
|
||||
}
|
||||
|
||||
function appendMatch(
|
||||
matches: MatchedGame[],
|
||||
seenGameIds: Set<string>,
|
||||
processName: string,
|
||||
game: Omit<MatchedGame, 'processName'> | null
|
||||
): void {
|
||||
if (!game || seenGameIds.has(game.id)) {
|
||||
return;
|
||||
}
|
||||
|
||||
seenGameIds.add(game.id);
|
||||
matches.push({
|
||||
...game,
|
||||
processName
|
||||
});
|
||||
}
|
||||
539
server/src/services/plugin-support.service.ts
Normal file
539
server/src/services/plugin-support.service.ts
Normal file
@@ -0,0 +1,539 @@
|
||||
import { getServerById } from '../cqrs';
|
||||
import { getDataSource } from '../db/database';
|
||||
import {
|
||||
PluginDataEntity,
|
||||
ServerPluginEventDefinitionEntity,
|
||||
ServerPluginEventDirection,
|
||||
ServerPluginEventScope,
|
||||
ServerPluginRequirementEntity,
|
||||
ServerPluginRequirementStatus
|
||||
} from '../entities';
|
||||
import { findServerMembership } from './server-access.service';
|
||||
import { resolveServerPermission } from './server-permissions.service';
|
||||
|
||||
export const DEFAULT_PLUGIN_EVENT_MAX_PAYLOAD_BYTES = 64 * 1024;
|
||||
|
||||
const VALID_REQUIREMENT_STATUSES = new Set<ServerPluginRequirementStatus>([
|
||||
'required',
|
||||
'optional',
|
||||
'recommended',
|
||||
'blocked',
|
||||
'incompatible'
|
||||
]);
|
||||
const VALID_EVENT_DIRECTIONS = new Set<ServerPluginEventDirection>([
|
||||
'clientToServer',
|
||||
'serverRelay',
|
||||
'p2pHint'
|
||||
]);
|
||||
const VALID_EVENT_SCOPES = new Set<ServerPluginEventScope>([
|
||||
'server',
|
||||
'channel',
|
||||
'user',
|
||||
'plugin'
|
||||
]);
|
||||
const PLUGIN_ID_PATTERN = /^[a-z0-9][a-z0-9.-]{1,126}[a-z0-9]$/;
|
||||
const EVENT_NAME_PATTERN = /^[a-z][a-z0-9.:-]{1,126}[a-z0-9]$/;
|
||||
const DATA_KEY_PATTERN = /^[a-zA-Z0-9][a-zA-Z0-9._:-]{0,127}$/;
|
||||
const DATA_SCOPE_PATTERN = /^[a-zA-Z][a-zA-Z0-9._:-]{0,63}$/;
|
||||
|
||||
export interface PluginRequirementSummary {
|
||||
installUrl?: string;
|
||||
manifest?: unknown;
|
||||
pluginId: string;
|
||||
reason?: string;
|
||||
sourceUrl?: string;
|
||||
status: ServerPluginRequirementStatus;
|
||||
updatedAt: number;
|
||||
versionRange?: string;
|
||||
}
|
||||
|
||||
export interface PluginEventDefinitionSummary {
|
||||
direction: ServerPluginEventDirection;
|
||||
eventName: string;
|
||||
maxPayloadBytes: number;
|
||||
pluginId: string;
|
||||
scope: ServerPluginEventScope;
|
||||
schemaJson?: string;
|
||||
updatedAt: number;
|
||||
}
|
||||
|
||||
export interface PluginRequirementsSnapshot {
|
||||
eventDefinitions: PluginEventDefinitionSummary[];
|
||||
requirements: PluginRequirementSummary[];
|
||||
serverId: string;
|
||||
updatedAt: number;
|
||||
}
|
||||
|
||||
export interface PluginDataRecord {
|
||||
key: string;
|
||||
ownerId?: string;
|
||||
pluginId: string;
|
||||
schemaVersion: number;
|
||||
scope: string;
|
||||
serverId: string;
|
||||
updatedAt: number;
|
||||
updatedBy?: string;
|
||||
value: unknown;
|
||||
}
|
||||
|
||||
export interface PluginEventEnvelope {
|
||||
eventId?: string;
|
||||
eventName: string;
|
||||
payload: unknown;
|
||||
pluginId: string;
|
||||
serverId: string;
|
||||
sourcePluginUserId?: string;
|
||||
type: 'plugin_event';
|
||||
}
|
||||
|
||||
export class PluginSupportError extends Error {
|
||||
constructor(
|
||||
readonly status: number,
|
||||
readonly code: string,
|
||||
message: string
|
||||
) {
|
||||
super(message);
|
||||
this.name = 'PluginSupportError';
|
||||
}
|
||||
}
|
||||
|
||||
function requirementRepository() {
|
||||
return getDataSource().getRepository(ServerPluginRequirementEntity);
|
||||
}
|
||||
|
||||
function eventDefinitionRepository() {
|
||||
return getDataSource().getRepository(ServerPluginEventDefinitionEntity);
|
||||
}
|
||||
|
||||
function pluginDataRepository() {
|
||||
return getDataSource().getRepository(PluginDataEntity);
|
||||
}
|
||||
|
||||
function normalizeOptionalString(value: unknown, maxLength: number): string | null {
|
||||
if (typeof value !== 'string') {
|
||||
return null;
|
||||
}
|
||||
|
||||
const normalized = value.trim();
|
||||
|
||||
return normalized ? normalized.slice(0, maxLength) : null;
|
||||
}
|
||||
|
||||
function assertPattern(value: string, pattern: RegExp, code: string, label: string): void {
|
||||
if (!pattern.test(value)) {
|
||||
throw new PluginSupportError(400, code, `Invalid ${label}`);
|
||||
}
|
||||
}
|
||||
|
||||
function normalizePluginId(pluginId: unknown): string {
|
||||
const normalized = normalizeOptionalString(pluginId, 128);
|
||||
|
||||
if (!normalized) {
|
||||
throw new PluginSupportError(400, 'MISSING_PLUGIN_ID', 'Missing plugin id');
|
||||
}
|
||||
|
||||
assertPattern(normalized, PLUGIN_ID_PATTERN, 'INVALID_PLUGIN_ID', 'plugin id');
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function normalizeEventName(eventName: unknown): string {
|
||||
const normalized = normalizeOptionalString(eventName, 128);
|
||||
|
||||
if (!normalized) {
|
||||
throw new PluginSupportError(400, 'MISSING_EVENT_NAME', 'Missing event name');
|
||||
}
|
||||
|
||||
assertPattern(normalized, EVENT_NAME_PATTERN, 'INVALID_EVENT_NAME', 'event name');
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function normalizeDataKey(key: unknown): string {
|
||||
const normalized = normalizeOptionalString(key, 128);
|
||||
|
||||
if (!normalized) {
|
||||
throw new PluginSupportError(400, 'MISSING_DATA_KEY', 'Missing data key');
|
||||
}
|
||||
|
||||
assertPattern(normalized, DATA_KEY_PATTERN, 'INVALID_DATA_KEY', 'data key');
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function normalizeDataScope(scope: unknown): string {
|
||||
const normalized = normalizeOptionalString(scope, 64) ?? 'server';
|
||||
|
||||
assertPattern(normalized, DATA_SCOPE_PATTERN, 'INVALID_DATA_SCOPE', 'data scope');
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function normalizeOwnerId(ownerId: unknown): string {
|
||||
return normalizeOptionalString(ownerId, 128) ?? '';
|
||||
}
|
||||
|
||||
function parseJsonValue(valueJson: string): unknown {
|
||||
try {
|
||||
return JSON.parse(valueJson) as unknown;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function parseOptionalJsonValue(valueJson: string | null): unknown {
|
||||
return valueJson ? parseJsonValue(valueJson) : undefined;
|
||||
}
|
||||
|
||||
function serializeJsonValue(value: unknown, code: string): string {
|
||||
try {
|
||||
return JSON.stringify(value ?? null);
|
||||
} catch {
|
||||
throw new PluginSupportError(400, code, 'Value must be JSON serializable');
|
||||
}
|
||||
}
|
||||
|
||||
function toRequirementSummary(entity: ServerPluginRequirementEntity): PluginRequirementSummary {
|
||||
return {
|
||||
installUrl: entity.installUrl ?? undefined,
|
||||
manifest: parseOptionalJsonValue(entity.manifestJson),
|
||||
pluginId: entity.pluginId,
|
||||
reason: entity.reason ?? undefined,
|
||||
sourceUrl: entity.sourceUrl ?? undefined,
|
||||
status: entity.status,
|
||||
updatedAt: entity.updatedAt,
|
||||
versionRange: entity.versionRange ?? undefined
|
||||
};
|
||||
}
|
||||
|
||||
function toEventDefinitionSummary(entity: ServerPluginEventDefinitionEntity): PluginEventDefinitionSummary {
|
||||
return {
|
||||
direction: entity.direction,
|
||||
eventName: entity.eventName,
|
||||
maxPayloadBytes: entity.maxPayloadBytes,
|
||||
pluginId: entity.pluginId,
|
||||
scope: entity.scope,
|
||||
schemaJson: entity.schemaJson ?? undefined,
|
||||
updatedAt: entity.updatedAt
|
||||
};
|
||||
}
|
||||
|
||||
function toPluginDataRecord(entity: PluginDataEntity): PluginDataRecord {
|
||||
return {
|
||||
key: entity.key,
|
||||
ownerId: entity.ownerId || undefined,
|
||||
pluginId: entity.pluginId,
|
||||
schemaVersion: entity.schemaVersion,
|
||||
scope: entity.scope,
|
||||
serverId: entity.serverId,
|
||||
updatedAt: entity.updatedAt,
|
||||
updatedBy: entity.updatedBy ?? undefined,
|
||||
value: parseJsonValue(entity.valueJson)
|
||||
};
|
||||
}
|
||||
|
||||
async function assertServerExists(serverId: string) {
|
||||
const server = await getServerById(serverId);
|
||||
|
||||
if (!server) {
|
||||
throw new PluginSupportError(404, 'SERVER_NOT_FOUND', 'Server not found');
|
||||
}
|
||||
|
||||
return server;
|
||||
}
|
||||
|
||||
export async function assertCanManagePluginSupport(serverId: string, actorUserId: string): Promise<void> {
|
||||
const server = await assertServerExists(serverId);
|
||||
|
||||
if (!actorUserId || !resolveServerPermission(server, actorUserId, 'manageServer')) {
|
||||
throw new PluginSupportError(403, 'NOT_AUTHORIZED', 'Not authorized');
|
||||
}
|
||||
}
|
||||
|
||||
export async function assertCanUsePluginData(serverId: string, actorUserId: string): Promise<void> {
|
||||
const server = await assertServerExists(serverId);
|
||||
|
||||
if (!actorUserId) {
|
||||
throw new PluginSupportError(400, 'MISSING_USER', 'Missing user id');
|
||||
}
|
||||
|
||||
if (server.ownerId === actorUserId) {
|
||||
return;
|
||||
}
|
||||
|
||||
const membership = await findServerMembership(serverId, actorUserId);
|
||||
|
||||
if (!membership) {
|
||||
throw new PluginSupportError(403, 'NOT_MEMBER', 'Only joined users can access plugin data');
|
||||
}
|
||||
}
|
||||
|
||||
export async function getPluginRequirementsSnapshot(serverId: string): Promise<PluginRequirementsSnapshot> {
|
||||
await assertServerExists(serverId);
|
||||
|
||||
const requirementQuery = requirementRepository().find({ where: { serverId } });
|
||||
const eventDefinitionQuery = eventDefinitionRepository().find({ where: { serverId } });
|
||||
const [requirements, eventDefinitions] = await Promise.all([requirementQuery, eventDefinitionQuery]);
|
||||
const requirementSummaries = requirements
|
||||
.map(toRequirementSummary)
|
||||
.sort((first, second) => first.pluginId.localeCompare(second.pluginId));
|
||||
const eventDefinitionSummaries = eventDefinitions
|
||||
.map(toEventDefinitionSummary)
|
||||
.sort((first, second) => `${first.pluginId}:${first.eventName}`.localeCompare(`${second.pluginId}:${second.eventName}`));
|
||||
const updatedAt = Math.max(
|
||||
0,
|
||||
...requirementSummaries.map((requirement) => requirement.updatedAt),
|
||||
...eventDefinitionSummaries.map((definition) => definition.updatedAt)
|
||||
);
|
||||
|
||||
return {
|
||||
eventDefinitions: eventDefinitionSummaries,
|
||||
requirements: requirementSummaries,
|
||||
serverId,
|
||||
updatedAt
|
||||
};
|
||||
}
|
||||
|
||||
export async function upsertPluginRequirement(options: {
|
||||
actorUserId: string;
|
||||
installUrl?: unknown;
|
||||
manifest?: unknown;
|
||||
pluginId: string;
|
||||
reason?: unknown;
|
||||
serverId: string;
|
||||
sourceUrl?: unknown;
|
||||
status: unknown;
|
||||
versionRange?: unknown;
|
||||
}): Promise<PluginRequirementSummary> {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
|
||||
const pluginId = normalizePluginId(options.pluginId);
|
||||
const status = options.status;
|
||||
|
||||
if (!VALID_REQUIREMENT_STATUSES.has(status as ServerPluginRequirementStatus)) {
|
||||
throw new PluginSupportError(400, 'INVALID_REQUIREMENT_STATUS', 'Invalid plugin requirement status');
|
||||
}
|
||||
|
||||
const repo = requirementRepository();
|
||||
const now = Date.now();
|
||||
const existing = await repo.findOne({ where: { serverId: options.serverId, pluginId } });
|
||||
const entity = repo.create({
|
||||
serverId: options.serverId,
|
||||
pluginId,
|
||||
status: status as ServerPluginRequirementStatus,
|
||||
versionRange: normalizeOptionalString(options.versionRange, 128),
|
||||
reason: normalizeOptionalString(options.reason, 512),
|
||||
installUrl: normalizeOptionalString(options.installUrl, 2_000),
|
||||
sourceUrl: normalizeOptionalString(options.sourceUrl, 2_000),
|
||||
manifestJson: options.manifest === undefined ? null : serializeJsonValue(options.manifest, 'INVALID_PLUGIN_MANIFEST_METADATA'),
|
||||
configuredBy: options.actorUserId,
|
||||
createdAt: existing?.createdAt ?? now,
|
||||
updatedAt: now
|
||||
});
|
||||
|
||||
await repo.save(entity);
|
||||
return toRequirementSummary(entity);
|
||||
}
|
||||
|
||||
export async function deletePluginRequirement(options: {
|
||||
actorUserId: string;
|
||||
pluginId: string;
|
||||
serverId: string;
|
||||
}): Promise<void> {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
await requirementRepository().delete({ serverId: options.serverId, pluginId: normalizePluginId(options.pluginId) });
|
||||
}
|
||||
|
||||
export async function upsertPluginEventDefinition(options: {
|
||||
actorUserId: string;
|
||||
direction: unknown;
|
||||
eventName: string;
|
||||
maxPayloadBytes?: unknown;
|
||||
pluginId: string;
|
||||
rateLimitJson?: unknown;
|
||||
schemaJson?: unknown;
|
||||
scope: unknown;
|
||||
serverId: string;
|
||||
}): Promise<PluginEventDefinitionSummary> {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
|
||||
const pluginId = normalizePluginId(options.pluginId);
|
||||
const eventName = normalizeEventName(options.eventName);
|
||||
const { direction, scope } = options;
|
||||
|
||||
if (!VALID_EVENT_DIRECTIONS.has(direction as ServerPluginEventDirection)) {
|
||||
throw new PluginSupportError(400, 'INVALID_EVENT_DIRECTION', 'Invalid plugin event direction');
|
||||
}
|
||||
|
||||
if (!VALID_EVENT_SCOPES.has(scope as ServerPluginEventScope)) {
|
||||
throw new PluginSupportError(400, 'INVALID_EVENT_SCOPE', 'Invalid plugin event scope');
|
||||
}
|
||||
|
||||
const maxPayloadBytes = typeof options.maxPayloadBytes === 'number' && Number.isFinite(options.maxPayloadBytes)
|
||||
? Math.max(1, Math.min(Math.floor(options.maxPayloadBytes), DEFAULT_PLUGIN_EVENT_MAX_PAYLOAD_BYTES))
|
||||
: DEFAULT_PLUGIN_EVENT_MAX_PAYLOAD_BYTES;
|
||||
const repo = eventDefinitionRepository();
|
||||
const now = Date.now();
|
||||
const existing = await repo.findOne({ where: { serverId: options.serverId, pluginId, eventName } });
|
||||
const entity = repo.create({
|
||||
serverId: options.serverId,
|
||||
pluginId,
|
||||
eventName,
|
||||
direction: direction as ServerPluginEventDirection,
|
||||
scope: scope as ServerPluginEventScope,
|
||||
schemaJson: normalizeOptionalString(options.schemaJson, 10_000),
|
||||
maxPayloadBytes,
|
||||
rateLimitJson: normalizeOptionalString(options.rateLimitJson, 2_000),
|
||||
createdAt: existing?.createdAt ?? now,
|
||||
updatedAt: now
|
||||
});
|
||||
|
||||
await repo.save(entity);
|
||||
return toEventDefinitionSummary(entity);
|
||||
}
|
||||
|
||||
export async function deletePluginEventDefinition(options: {
|
||||
actorUserId: string;
|
||||
eventName: string;
|
||||
pluginId: string;
|
||||
serverId: string;
|
||||
}): Promise<void> {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
await eventDefinitionRepository().delete({
|
||||
serverId: options.serverId,
|
||||
pluginId: normalizePluginId(options.pluginId),
|
||||
eventName: normalizeEventName(options.eventName)
|
||||
});
|
||||
}
|
||||
|
||||
export async function listPluginData(options: {
|
||||
actorUserId: string;
|
||||
key?: unknown;
|
||||
ownerId?: unknown;
|
||||
pluginId: string;
|
||||
scope?: unknown;
|
||||
serverId: string;
|
||||
}): Promise<PluginDataRecord[]> {
|
||||
await assertCanUsePluginData(options.serverId, options.actorUserId);
|
||||
|
||||
const pluginId = normalizePluginId(options.pluginId);
|
||||
const scope = options.scope === undefined ? undefined : normalizeDataScope(options.scope);
|
||||
const ownerId = options.ownerId === undefined ? undefined : normalizeOwnerId(options.ownerId);
|
||||
const key = options.key === undefined ? undefined : normalizeDataKey(options.key);
|
||||
const query = pluginDataRepository()
|
||||
.createQueryBuilder('data')
|
||||
.where('data.serverId = :serverId', { serverId: options.serverId })
|
||||
.andWhere('data.pluginId = :pluginId', { pluginId });
|
||||
|
||||
if (scope !== undefined) {
|
||||
query.andWhere('data.scope = :scope', { scope });
|
||||
}
|
||||
|
||||
if (ownerId !== undefined) {
|
||||
query.andWhere('data.ownerId = :ownerId', { ownerId });
|
||||
}
|
||||
|
||||
if (key !== undefined) {
|
||||
query.andWhere('data.key = :key', { key });
|
||||
}
|
||||
|
||||
const records = await query
|
||||
.orderBy('data.scope', 'ASC')
|
||||
.addOrderBy('data.ownerId', 'ASC')
|
||||
.addOrderBy('data.key', 'ASC')
|
||||
.getMany();
|
||||
|
||||
return records.map(toPluginDataRecord);
|
||||
}
|
||||
|
||||
export async function upsertPluginData(options: {
|
||||
actorUserId: string;
|
||||
key: string;
|
||||
ownerId?: unknown;
|
||||
pluginId: string;
|
||||
schemaVersion?: unknown;
|
||||
scope?: unknown;
|
||||
serverId: string;
|
||||
value: unknown;
|
||||
}): Promise<PluginDataRecord> {
|
||||
await assertCanUsePluginData(options.serverId, options.actorUserId);
|
||||
|
||||
const pluginId = normalizePluginId(options.pluginId);
|
||||
const scope = normalizeDataScope(options.scope);
|
||||
const ownerId = scope === 'user' ? normalizeOwnerId(options.ownerId ?? options.actorUserId) : normalizeOwnerId(options.ownerId);
|
||||
|
||||
if (scope === 'user' && ownerId !== options.actorUserId) {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
}
|
||||
|
||||
const key = normalizeDataKey(options.key);
|
||||
const schemaVersion = typeof options.schemaVersion === 'number' && Number.isFinite(options.schemaVersion)
|
||||
? Math.max(1, Math.floor(options.schemaVersion))
|
||||
: 1;
|
||||
const repo = pluginDataRepository();
|
||||
const entity = repo.create({
|
||||
serverId: options.serverId,
|
||||
pluginId,
|
||||
scope,
|
||||
ownerId,
|
||||
key,
|
||||
valueJson: serializeJsonValue(options.value, 'INVALID_PLUGIN_DATA'),
|
||||
schemaVersion,
|
||||
updatedBy: options.actorUserId,
|
||||
updatedAt: Date.now()
|
||||
});
|
||||
|
||||
await repo.save(entity);
|
||||
return toPluginDataRecord(entity);
|
||||
}
|
||||
|
||||
export async function deletePluginData(options: {
|
||||
actorUserId: string;
|
||||
key: string;
|
||||
ownerId?: unknown;
|
||||
pluginId: string;
|
||||
scope?: unknown;
|
||||
serverId: string;
|
||||
}): Promise<void> {
|
||||
await assertCanUsePluginData(options.serverId, options.actorUserId);
|
||||
|
||||
const pluginId = normalizePluginId(options.pluginId);
|
||||
const scope = normalizeDataScope(options.scope);
|
||||
const ownerId = scope === 'user' ? normalizeOwnerId(options.ownerId ?? options.actorUserId) : normalizeOwnerId(options.ownerId);
|
||||
|
||||
if (scope === 'user' && ownerId !== options.actorUserId) {
|
||||
await assertCanManagePluginSupport(options.serverId, options.actorUserId);
|
||||
}
|
||||
|
||||
await pluginDataRepository().delete({
|
||||
serverId: options.serverId,
|
||||
pluginId,
|
||||
scope,
|
||||
ownerId,
|
||||
key: normalizeDataKey(options.key)
|
||||
});
|
||||
}
|
||||
|
||||
export async function validatePluginEventEnvelope(envelope: PluginEventEnvelope): Promise<ServerPluginEventDefinitionEntity> {
|
||||
const pluginId = normalizePluginId(envelope.pluginId);
|
||||
const eventName = normalizeEventName(envelope.eventName);
|
||||
const definition = await eventDefinitionRepository().findOne({
|
||||
where: {
|
||||
serverId: envelope.serverId,
|
||||
pluginId,
|
||||
eventName
|
||||
}
|
||||
});
|
||||
|
||||
if (!definition) {
|
||||
throw new PluginSupportError(404, 'PLUGIN_EVENT_NOT_REGISTERED', 'Plugin event is not registered for this server');
|
||||
}
|
||||
|
||||
if (definition.direction === 'p2pHint') {
|
||||
throw new PluginSupportError(400, 'PLUGIN_EVENT_NOT_RELAYABLE', 'P2P plugin events must not be relayed by the signal server');
|
||||
}
|
||||
|
||||
const payloadBytes = Buffer.byteLength(serializeJsonValue(envelope.payload, 'INVALID_PLUGIN_EVENT_PAYLOAD'), 'utf8');
|
||||
|
||||
if (payloadBytes > definition.maxPayloadBytes) {
|
||||
throw new PluginSupportError(413, 'PLUGIN_EVENT_TOO_LARGE', 'Plugin event payload is too large');
|
||||
}
|
||||
|
||||
return definition;
|
||||
}
|
||||
@@ -130,6 +130,10 @@ export async function findServerMembership(serverId: string, userId: string): Pr
|
||||
return await getMembershipRepository().findOne({ where: { serverId, userId } });
|
||||
}
|
||||
|
||||
export async function countServerMemberships(serverId: string): Promise<number> {
|
||||
return await getMembershipRepository().count({ where: { serverId } });
|
||||
}
|
||||
|
||||
export async function ensureServerMembership(serverId: string, userId: string): Promise<ServerMembershipEntity> {
|
||||
const repo = getMembershipRepository();
|
||||
const now = Date.now();
|
||||
|
||||
221
server/src/websocket/handler-plugin.spec.ts
Normal file
221
server/src/websocket/handler-plugin.spec.ts
Normal file
@@ -0,0 +1,221 @@
|
||||
import {
|
||||
beforeEach,
|
||||
describe,
|
||||
expect,
|
||||
it,
|
||||
vi
|
||||
} from 'vitest';
|
||||
import { WebSocket } from 'ws';
|
||||
import { ConnectedUser } from './types';
|
||||
import { connectedUsers } from './state';
|
||||
|
||||
const pluginSupportMocks = vi.hoisted(() => {
|
||||
class MockPluginSupportError extends Error {
|
||||
constructor(
|
||||
readonly status: number,
|
||||
readonly code: string,
|
||||
message: string
|
||||
) {
|
||||
super(message);
|
||||
this.name = 'PluginSupportError';
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
getPluginRequirementsSnapshot: vi.fn(),
|
||||
PluginSupportError: MockPluginSupportError,
|
||||
validatePluginEventEnvelope: vi.fn()
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock('../services/server-access.service', () => ({
|
||||
authorizeWebSocketJoin: vi.fn(async () => ({ allowed: true as const }))
|
||||
}));
|
||||
|
||||
vi.mock('../services/plugin-support.service', () => pluginSupportMocks);
|
||||
|
||||
import { handleWebSocketMessage } from './handler';
|
||||
|
||||
interface SentMessageStore {
|
||||
sentMessages: string[];
|
||||
}
|
||||
|
||||
function createMockWs(): WebSocket & SentMessageStore {
|
||||
const sentMessages: string[] = [];
|
||||
const socket = {
|
||||
readyState: WebSocket.OPEN,
|
||||
send: (data: string) => {
|
||||
sentMessages.push(data);
|
||||
},
|
||||
close: () => {},
|
||||
sentMessages
|
||||
} as unknown as WebSocket & SentMessageStore;
|
||||
|
||||
return socket;
|
||||
}
|
||||
|
||||
function createConnectedUser(
|
||||
connectionId: string,
|
||||
oderId: string,
|
||||
overrides: Partial<ConnectedUser> = {}
|
||||
): ConnectedUser {
|
||||
const user: ConnectedUser = {
|
||||
displayName: `User ${oderId}`,
|
||||
lastPong: Date.now(),
|
||||
oderId,
|
||||
serverIds: new Set(),
|
||||
ws: createMockWs(),
|
||||
...overrides
|
||||
};
|
||||
|
||||
connectedUsers.set(connectionId, user);
|
||||
return user;
|
||||
}
|
||||
|
||||
function readSentMessages(user: ConnectedUser): Record<string, unknown>[] {
|
||||
return (user.ws as unknown as SentMessageStore).sentMessages.map((messageText) => JSON.parse(messageText) as Record<string, unknown>);
|
||||
}
|
||||
|
||||
describe('server websocket handler - plugin support', () => {
|
||||
beforeEach(() => {
|
||||
connectedUsers.clear();
|
||||
pluginSupportMocks.getPluginRequirementsSnapshot.mockReset();
|
||||
pluginSupportMocks.validatePluginEventEnvelope.mockReset();
|
||||
pluginSupportMocks.getPluginRequirementsSnapshot.mockResolvedValue({
|
||||
eventDefinitions: [],
|
||||
requirements: [],
|
||||
serverId: 'server-1',
|
||||
updatedAt: 0
|
||||
});
|
||||
|
||||
pluginSupportMocks.validatePluginEventEnvelope.mockResolvedValue({ direction: 'serverRelay' });
|
||||
});
|
||||
|
||||
it('sends plugin requirement snapshots after joining a server', async () => {
|
||||
const alice = createConnectedUser('conn-1', 'alice');
|
||||
|
||||
pluginSupportMocks.getPluginRequirementsSnapshot.mockResolvedValue({
|
||||
eventDefinitions: [
|
||||
{
|
||||
direction: 'serverRelay',
|
||||
eventName: 'e2e:relay',
|
||||
maxPayloadBytes: 2048,
|
||||
pluginId: 'e2e.plugin-api',
|
||||
scope: 'server',
|
||||
updatedAt: 2
|
||||
}
|
||||
],
|
||||
requirements: [
|
||||
{
|
||||
pluginId: 'e2e.plugin-api',
|
||||
status: 'required',
|
||||
updatedAt: 1
|
||||
}
|
||||
],
|
||||
serverId: 'server-1',
|
||||
updatedAt: 2
|
||||
});
|
||||
|
||||
await handleWebSocketMessage('conn-1', { type: 'join_server', serverId: 'server-1' });
|
||||
|
||||
const messages = readSentMessages(alice);
|
||||
const pluginRequirements = messages.find((message) => message['type'] === 'plugin_requirements');
|
||||
|
||||
expect(pluginRequirements?.['serverId']).toBe('server-1');
|
||||
expect(pluginRequirements?.['snapshot']).toEqual(expect.objectContaining({ updatedAt: 2 }));
|
||||
});
|
||||
|
||||
it('validates and relays plugin events to other joined users', async () => {
|
||||
const alice = createConnectedUser('conn-1', 'alice', { viewedServerId: 'server-1' });
|
||||
const bob = createConnectedUser('conn-2', 'bob', { viewedServerId: 'server-1' });
|
||||
|
||||
alice.serverIds.add('server-1');
|
||||
bob.serverIds.add('server-1');
|
||||
|
||||
await handleWebSocketMessage('conn-1', {
|
||||
type: 'plugin_event',
|
||||
eventId: 'event-1',
|
||||
eventName: 'e2e:relay',
|
||||
payload: { ok: true },
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1',
|
||||
sourcePluginUserId: 'fixture-user'
|
||||
});
|
||||
|
||||
expect(pluginSupportMocks.validatePluginEventEnvelope).toHaveBeenCalledWith({
|
||||
type: 'plugin_event',
|
||||
eventId: 'event-1',
|
||||
eventName: 'e2e:relay',
|
||||
payload: { ok: true },
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1',
|
||||
sourcePluginUserId: 'fixture-user'
|
||||
});
|
||||
|
||||
const bobMessages = readSentMessages(bob);
|
||||
const relayedEvent = bobMessages.find((message) => message['type'] === 'plugin_event');
|
||||
|
||||
expect(relayedEvent).toEqual(expect.objectContaining({
|
||||
eventId: 'event-1',
|
||||
eventName: 'e2e:relay',
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1',
|
||||
sourcePluginUserId: 'fixture-user',
|
||||
sourceUserId: 'alice'
|
||||
}));
|
||||
|
||||
expect(typeof relayedEvent?.['emittedAt']).toBe('number');
|
||||
});
|
||||
|
||||
it('returns plugin errors for invalid plugin event messages', async () => {
|
||||
const alice = createConnectedUser('conn-1', 'alice');
|
||||
|
||||
await handleWebSocketMessage('conn-1', {
|
||||
type: 'plugin_event',
|
||||
eventName: 'e2e:relay',
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1'
|
||||
});
|
||||
|
||||
const pluginError = readSentMessages(alice).find((message) => message['type'] === 'plugin_error');
|
||||
|
||||
expect(pluginError).toEqual(expect.objectContaining({
|
||||
code: 'INVALID_PLUGIN_EVENT',
|
||||
eventName: 'e2e:relay',
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1'
|
||||
}));
|
||||
|
||||
expect(pluginSupportMocks.validatePluginEventEnvelope).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('forwards plugin support validation errors to the sending user', async () => {
|
||||
const alice = createConnectedUser('conn-1', 'alice', { viewedServerId: 'server-1' });
|
||||
|
||||
alice.serverIds.add('server-1');
|
||||
pluginSupportMocks.validatePluginEventEnvelope.mockRejectedValue(new pluginSupportMocks.PluginSupportError(
|
||||
400,
|
||||
'PLUGIN_EVENT_NOT_RELAYABLE',
|
||||
'P2P plugin events must not be relayed by the signal server'
|
||||
));
|
||||
|
||||
await handleWebSocketMessage('conn-1', {
|
||||
type: 'plugin_event',
|
||||
eventId: 'event-p2p',
|
||||
eventName: 'e2e:p2p',
|
||||
payload: { hint: true },
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1'
|
||||
});
|
||||
|
||||
const pluginError = readSentMessages(alice).find((message) => message['type'] === 'plugin_error');
|
||||
|
||||
expect(pluginError).toEqual(expect.objectContaining({
|
||||
code: 'PLUGIN_EVENT_NOT_RELAYABLE',
|
||||
eventId: 'event-p2p',
|
||||
eventName: 'e2e:p2p',
|
||||
pluginId: 'e2e.plugin-api',
|
||||
serverId: 'server-1'
|
||||
}));
|
||||
});
|
||||
});
|
||||
@@ -67,6 +67,14 @@ describe('server websocket handler - status_update', () => {
|
||||
connectedUsers.clear();
|
||||
});
|
||||
|
||||
it('treats signaling keepalive messages as connection liveness', async () => {
|
||||
createConnectedUser('conn-1', 'user-1', { lastPong: 1 });
|
||||
|
||||
await handleWebSocketMessage('conn-1', { type: 'keepalive' });
|
||||
|
||||
expect(connectedUsers.get('conn-1')?.lastPong).toBeGreaterThan(1);
|
||||
});
|
||||
|
||||
it('updates user status on valid status_update message', async () => {
|
||||
const user = createConnectedUser('conn-1', 'user-1');
|
||||
|
||||
@@ -154,7 +162,7 @@ describe('server websocket handler - status_update', () => {
|
||||
// Identify first (required for handler)
|
||||
await handleWebSocketMessage('conn-1', { type: 'identify', oderId: 'user-1', displayName: 'User 1' });
|
||||
|
||||
// user-2 joins server → should receive server_users with user-1's status
|
||||
// user-2 joins server -> should receive server_users with user-1's status
|
||||
getSentMessagesStore(user2).sentMessages.length = 0;
|
||||
await handleWebSocketMessage('conn-2', { type: 'join_server', serverId: 'server-1' });
|
||||
|
||||
|
||||
@@ -8,6 +8,11 @@ import {
|
||||
isOderIdConnectedToServer
|
||||
} from './broadcast';
|
||||
import { authorizeWebSocketJoin } from '../services/server-access.service';
|
||||
import {
|
||||
getPluginRequirementsSnapshot,
|
||||
PluginSupportError,
|
||||
validatePluginEventEnvelope
|
||||
} from '../services/plugin-support.service';
|
||||
|
||||
interface WsMessage {
|
||||
[key: string]: unknown;
|
||||
@@ -50,6 +55,29 @@ function readMessageId(value: unknown): string | undefined {
|
||||
return normalized;
|
||||
}
|
||||
|
||||
function sendPluginError(user: ConnectedUser, error: unknown, message: WsMessage): void {
|
||||
if (error instanceof PluginSupportError) {
|
||||
user.ws.send(JSON.stringify({
|
||||
type: 'plugin_error',
|
||||
serverId: typeof message['serverId'] === 'string' ? message['serverId'] : undefined,
|
||||
pluginId: typeof message['pluginId'] === 'string' ? message['pluginId'] : undefined,
|
||||
eventName: typeof message['eventName'] === 'string' ? message['eventName'] : undefined,
|
||||
eventId: typeof message['eventId'] === 'string' ? message['eventId'] : undefined,
|
||||
code: error.code,
|
||||
message: error.message
|
||||
}));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
console.error('Unhandled plugin websocket error:', error);
|
||||
user.ws.send(JSON.stringify({
|
||||
type: 'plugin_error',
|
||||
code: 'INTERNAL_ERROR',
|
||||
message: 'Internal server error'
|
||||
}));
|
||||
}
|
||||
|
||||
/** Sends the current user list for a given server to a single connected user. */
|
||||
function sendServerUsers(user: ConnectedUser, serverId: string): void {
|
||||
const users = getUniqueUsersInServer(serverId, user.oderId)
|
||||
@@ -64,6 +92,20 @@ function sendServerUsers(user: ConnectedUser, serverId: string): void {
|
||||
user.ws.send(JSON.stringify({ type: 'server_users', serverId, users }));
|
||||
}
|
||||
|
||||
async function sendPluginRequirements(user: ConnectedUser, serverId: string): Promise<void> {
|
||||
try {
|
||||
const snapshot = await getPluginRequirementsSnapshot(serverId);
|
||||
|
||||
user.ws.send(JSON.stringify({
|
||||
type: 'plugin_requirements',
|
||||
serverId,
|
||||
snapshot
|
||||
}));
|
||||
} catch (error) {
|
||||
sendPluginError(user, error, { type: 'plugin_requirements', serverId });
|
||||
}
|
||||
}
|
||||
|
||||
function handleIdentify(user: ConnectedUser, message: WsMessage, connectionId: string): void {
|
||||
const newOderId = readMessageId(message['oderId']) ?? connectionId;
|
||||
const newScope = typeof message['connectionScope'] === 'string' ? message['connectionScope'] : undefined;
|
||||
@@ -71,25 +113,6 @@ function handleIdentify(user: ConnectedUser, message: WsMessage, connectionId: s
|
||||
const previousDescription = user.description;
|
||||
const previousProfileUpdatedAt = user.profileUpdatedAt;
|
||||
|
||||
// Close stale connections from the same identity AND the same connection
|
||||
// scope so offer routing always targets the freshest socket (e.g. after
|
||||
// page refresh). Connections with a *different* scope (= a different
|
||||
// signal URL that happens to route to this server) are left untouched so
|
||||
// multi-signal-URL setups don't trigger an eviction loop.
|
||||
connectedUsers.forEach((existing, existingId) => {
|
||||
if (existingId !== connectionId
|
||||
&& existing.oderId === newOderId
|
||||
&& existing.connectionScope === newScope) {
|
||||
console.log(`Closing stale connection for ${newOderId} (old=${existingId}, new=${connectionId}, scope=${newScope ?? 'none'})`);
|
||||
|
||||
try {
|
||||
existing.ws.close();
|
||||
} catch { /* already closing */ }
|
||||
|
||||
connectedUsers.delete(existingId);
|
||||
}
|
||||
});
|
||||
|
||||
user.oderId = newOderId;
|
||||
user.displayName = normalizeDisplayName(message['displayName'], normalizeDisplayName(user.displayName));
|
||||
|
||||
@@ -156,6 +179,7 @@ async function handleJoinServer(user: ConnectedUser, message: WsMessage, connect
|
||||
);
|
||||
|
||||
sendServerUsers(user, sid);
|
||||
await sendPluginRequirements(user, sid);
|
||||
|
||||
if (isNewIdentityMembership) {
|
||||
broadcastToServer(sid, {
|
||||
@@ -170,17 +194,22 @@ async function handleJoinServer(user: ConnectedUser, message: WsMessage, connect
|
||||
}
|
||||
}
|
||||
|
||||
function handleViewServer(user: ConnectedUser, message: WsMessage, connectionId: string): void {
|
||||
async function handleViewServer(user: ConnectedUser, message: WsMessage, connectionId: string): Promise<void> {
|
||||
const viewSid = readMessageId(message['serverId']);
|
||||
|
||||
if (!viewSid)
|
||||
return;
|
||||
|
||||
if (!user.serverIds.has(viewSid)) {
|
||||
return;
|
||||
}
|
||||
|
||||
user.viewedServerId = viewSid;
|
||||
connectedUsers.set(connectionId, user);
|
||||
console.log(`User ${normalizeDisplayName(user.displayName)} (${user.oderId}) viewing server ${viewSid}`);
|
||||
|
||||
sendServerUsers(user, viewSid);
|
||||
await sendPluginRequirements(user, viewSid);
|
||||
}
|
||||
|
||||
function handleLeaveServer(user: ConnectedUser, message: WsMessage, connectionId: string): void {
|
||||
@@ -276,7 +305,7 @@ function handleStatusUpdate(user: ConnectedUser, message: WsMessage, connectionI
|
||||
|
||||
user.status = status as ConnectedUser['status'];
|
||||
connectedUsers.set(connectionId, user);
|
||||
console.log(`User ${normalizeDisplayName(user.displayName)} (${user.oderId}) status → ${status}`);
|
||||
console.log(`User ${normalizeDisplayName(user.displayName)} (${user.oderId}) status -> ${status}`);
|
||||
|
||||
for (const serverId of user.serverIds) {
|
||||
broadcastToServer(serverId, {
|
||||
@@ -287,13 +316,65 @@ function handleStatusUpdate(user: ConnectedUser, message: WsMessage, connectionI
|
||||
}
|
||||
}
|
||||
|
||||
async function handlePluginEvent(user: ConnectedUser, message: WsMessage): Promise<void> {
|
||||
const serverId = readMessageId(message['serverId']) ?? user.viewedServerId;
|
||||
const pluginId = readMessageId(message['pluginId']);
|
||||
const eventName = readMessageId(message['eventName']);
|
||||
|
||||
if (!serverId || !pluginId || !eventName || !user.serverIds.has(serverId)) {
|
||||
user.ws.send(JSON.stringify({
|
||||
type: 'plugin_error',
|
||||
serverId,
|
||||
pluginId,
|
||||
eventName,
|
||||
eventId: typeof message['eventId'] === 'string' ? message['eventId'] : undefined,
|
||||
code: 'INVALID_PLUGIN_EVENT',
|
||||
message: 'Plugin event is missing required fields or server membership'
|
||||
}));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
await validatePluginEventEnvelope({
|
||||
type: 'plugin_event',
|
||||
serverId,
|
||||
pluginId,
|
||||
eventName,
|
||||
eventId: typeof message['eventId'] === 'string' ? message['eventId'] : undefined,
|
||||
payload: message['payload'],
|
||||
sourcePluginUserId: typeof message['sourcePluginUserId'] === 'string' ? message['sourcePluginUserId'] : undefined
|
||||
});
|
||||
|
||||
broadcastToServer(serverId, {
|
||||
type: 'plugin_event',
|
||||
serverId,
|
||||
pluginId,
|
||||
eventName,
|
||||
eventId: typeof message['eventId'] === 'string' ? message['eventId'] : undefined,
|
||||
payload: message['payload'],
|
||||
sourcePluginUserId: typeof message['sourcePluginUserId'] === 'string' ? message['sourcePluginUserId'] : undefined,
|
||||
sourceUserId: user.oderId,
|
||||
emittedAt: Date.now()
|
||||
}, user.oderId);
|
||||
} catch (error) {
|
||||
sendPluginError(user, error, message);
|
||||
}
|
||||
}
|
||||
|
||||
export async function handleWebSocketMessage(connectionId: string, message: WsMessage): Promise<void> {
|
||||
const user = connectedUsers.get(connectionId);
|
||||
|
||||
if (!user)
|
||||
return;
|
||||
|
||||
user.lastPong = Date.now();
|
||||
connectedUsers.set(connectionId, user);
|
||||
|
||||
switch (message.type) {
|
||||
case 'keepalive':
|
||||
break;
|
||||
|
||||
case 'identify':
|
||||
handleIdentify(user, message, connectionId);
|
||||
break;
|
||||
@@ -303,7 +384,7 @@ export async function handleWebSocketMessage(connectionId: string, message: WsMe
|
||||
break;
|
||||
|
||||
case 'view_server':
|
||||
handleViewServer(user, message, connectionId);
|
||||
await handleViewServer(user, message, connectionId);
|
||||
break;
|
||||
|
||||
case 'leave_server':
|
||||
@@ -328,6 +409,10 @@ export async function handleWebSocketMessage(connectionId: string, message: WsMe
|
||||
handleStatusUpdate(user, message, connectionId);
|
||||
break;
|
||||
|
||||
case 'plugin_event':
|
||||
await handlePluginEvent(user, message);
|
||||
break;
|
||||
|
||||
default:
|
||||
console.log('Unknown message type:', message.type);
|
||||
}
|
||||
|
||||
@@ -13,6 +13,8 @@ import {
|
||||
} from './broadcast';
|
||||
import { handleWebSocketMessage } from './handler';
|
||||
|
||||
type IncomingWebSocketMessage = Parameters<typeof handleWebSocketMessage>[1];
|
||||
|
||||
/** How often to ping all connected clients (ms). */
|
||||
const PING_INTERVAL_MS = 30_000;
|
||||
/** Maximum time a client can go without a pong before we consider it dead (ms). */
|
||||
@@ -89,12 +91,20 @@ export function setupWebSocket(server: Server<typeof IncomingMessage, typeof Ser
|
||||
});
|
||||
|
||||
ws.on('message', async (data) => {
|
||||
try {
|
||||
const message = JSON.parse(data.toString());
|
||||
let message: IncomingWebSocketMessage;
|
||||
|
||||
await handleWebSocketMessage(connectionId, message);
|
||||
try {
|
||||
message = JSON.parse(data.toString()) as IncomingWebSocketMessage;
|
||||
} catch (err) {
|
||||
console.error('Invalid WebSocket message:', err);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
await handleWebSocketMessage(connectionId, message);
|
||||
} catch (err) {
|
||||
console.error('WebSocket message handler failed:', err);
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
@@ -17,6 +17,6 @@ export interface ConnectedUser {
|
||||
connectionScope?: string;
|
||||
/** User availability status (online, away, busy, offline). */
|
||||
status?: 'online' | 'away' | 'busy' | 'offline';
|
||||
/** Timestamp of the last pong received (used to detect dead connections). */
|
||||
/** Timestamp of the last pong or client message received (used to detect dead connections). */
|
||||
lastPong: number;
|
||||
}
|
||||
|
||||
42
toju-app/README.md
Normal file
42
toju-app/README.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Product Client
|
||||
|
||||
Angular 21 renderer for MetoYou / Toju. This package is managed from the repository root, so the main build, test, lint, and Electron integration commands are run there rather than from a local `package.json`.
|
||||
|
||||
## Commands
|
||||
|
||||
- `npm run start` starts the Angular dev server.
|
||||
- `npm run build` builds the client to `dist/client`.
|
||||
- `npm run watch` runs the Angular build in watch mode.
|
||||
- `npm run test` runs the product-client Vitest suite.
|
||||
- `npm run lint` runs ESLint across the repo.
|
||||
- `npm run format` formats Angular HTML templates.
|
||||
- `npm run sort:props` sorts Angular template properties.
|
||||
- `npm run electron:dev` or `npm run dev` runs the client with Electron.
|
||||
|
||||
## Structure
|
||||
|
||||
| Path | Description |
|
||||
| --- | --- |
|
||||
| `src/app/domains/` | Bounded contexts and public domain entry points |
|
||||
| `src/app/infrastructure/` | Shared technical runtime such as persistence and realtime |
|
||||
| `src/app/shared-kernel/` | Cross-domain contracts and shared models |
|
||||
| `src/app/features/` | App-level composition and transitional feature shells |
|
||||
| `src/app/core/` | Platform adapters, compatibility entry points, and cross-domain technical helpers |
|
||||
| `src/app/shared/` | Shared UI primitives and utilities |
|
||||
| `src/app/store/` | NgRx reducers, effects, selectors, and actions |
|
||||
| `public/` | Static assets copied into the Angular build |
|
||||
|
||||
## Key Docs
|
||||
|
||||
- [src/app/domains/README.md](src/app/domains/README.md)
|
||||
- [src/app/shared-kernel/README.md](src/app/shared-kernel/README.md)
|
||||
- [src/app/infrastructure/persistence/README.md](src/app/infrastructure/persistence/README.md)
|
||||
- [src/app/infrastructure/realtime/README.md](src/app/infrastructure/realtime/README.md)
|
||||
- [../docs/architecture.md](../docs/architecture.md)
|
||||
- [AGENTS.md](AGENTS.md)
|
||||
|
||||
## Notes
|
||||
|
||||
- `angular.json` defines build, serve, and lint targets for the product client.
|
||||
- Product-client tests currently run through the root Vitest setup instead of an Angular `test` architect target.
|
||||
- If the renderer-to-desktop contract changes, update the Angular bridge, Electron preload API, and IPC handlers together.
|
||||
@@ -96,13 +96,13 @@
|
||||
"budgets": [
|
||||
{
|
||||
"type": "initial",
|
||||
"maximumWarning": "2.2MB",
|
||||
"maximumError": "2.32MB"
|
||||
"maximumWarning": "10mb",
|
||||
"maximumError": "20mb"
|
||||
},
|
||||
{
|
||||
"type": "anyComponentStyle",
|
||||
"maximumWarning": "4kB",
|
||||
"maximumError": "8kB"
|
||||
"maximumWarning": "10mb",
|
||||
"maximumError": "20mb"
|
||||
}
|
||||
],
|
||||
"outputHashing": "all"
|
||||
|
||||
3
toju-app/public/plugins/e2e-all-api/README.md
Normal file
3
toju-app/public/plugins/e2e-all-api/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# E2E All API Plugin
|
||||
|
||||
Fixture plugin for Playwright coverage. It calls every public Toju plugin API surface, registers UI contributions, writes storage, publishes events, creates plugin user data, and logs completion.
|
||||
6
toju-app/public/plugins/e2e-all-api/icon.svg
Normal file
6
toju-app/public/plugins/e2e-all-api/icon.svg
Normal file
@@ -0,0 +1,6 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="E2E plugin icon">
|
||||
<rect width="64" height="64" rx="12" fill="#111827" />
|
||||
<path d="M18 22h28v20H18z" fill="#38bdf8" />
|
||||
<path d="M24 16h16v6H24zM24 42h16v6H24z" fill="#a7f3d0" />
|
||||
<path d="M25 30h14v4H25z" fill="#111827" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 319 B |
293
toju-app/public/plugins/e2e-all-api/main.js
Normal file
293
toju-app/public/plugins/e2e-all-api/main.js
Normal file
@@ -0,0 +1,293 @@
|
||||
const tinyWave = 'data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAABAAEAESsAACJWAAACABAAZGF0YQAAAAA=';
|
||||
const originalMessage = 'Plugin API original message';
|
||||
const editedMessage = 'Plugin API edited message';
|
||||
const deletedMessage = 'Plugin API deleted message';
|
||||
const embedMessage = 'toju:embed:e2e.coverage:{"title":"Plugin API custom embed","body":"Rendered by plugin API"}';
|
||||
const soundboardPlayedMessage = 'E2E soundboard played Airhorn to voice channel';
|
||||
|
||||
export async function activate(context) {
|
||||
const api = context.api;
|
||||
const currentUser = api.profile.getCurrent();
|
||||
const shouldMutateChat = !currentUser?.displayName?.includes('Bob');
|
||||
const pluginUserId = api.server.registerPluginUser({
|
||||
displayName: 'E2E Plugin Bot',
|
||||
id: 'e2e-plugin-bot'
|
||||
});
|
||||
|
||||
context.subscriptions.push(api.ui.registerSettingsPage('coverage', {
|
||||
label: 'E2E Coverage',
|
||||
render: () => 'E2E settings contribution'
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerAppPage('coverage', {
|
||||
label: 'E2E Page',
|
||||
path: '/plugins/e2e/coverage',
|
||||
render: () => 'E2E page contribution'
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerSidePanel('coverage', {
|
||||
label: 'E2E Soundboard',
|
||||
render: () => 'E2E soundboard ready'
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerChannelSection('coverage', {
|
||||
label: 'E2E Soundboard',
|
||||
type: 'custom'
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerComposerAction('coverage', {
|
||||
icon: 'SFX',
|
||||
label: 'E2E Soundboard',
|
||||
run: () => openSoundboardModal(api, pluginUserId)
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerProfileAction('coverage', {
|
||||
label: 'E2E Profile',
|
||||
run: () => api.logger.info('profile action ran')
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerToolbarAction('coverage', {
|
||||
label: 'E2E Toolbar',
|
||||
run: () => api.logger.info('toolbar action ran')
|
||||
}));
|
||||
context.subscriptions.push(api.ui.registerEmbedRenderer('coverage', {
|
||||
embedType: 'e2e.coverage',
|
||||
render: (payload) => `E2E custom embed: ${payload?.title ?? 'missing title'}`
|
||||
}));
|
||||
|
||||
const injectedBadge = document.createElement('div');
|
||||
|
||||
injectedBadge.dataset.testid = 'e2e-plugin-owned-dom';
|
||||
injectedBadge.textContent = 'E2E plugin-owned DOM injected into chat';
|
||||
injectedBadge.style.position = 'absolute';
|
||||
injectedBadge.style.left = '1rem';
|
||||
injectedBadge.style.bottom = '5.5rem';
|
||||
injectedBadge.style.zIndex = '20';
|
||||
injectedBadge.style.border = '1px solid hsl(var(--border))';
|
||||
injectedBadge.style.borderRadius = '0.5rem';
|
||||
injectedBadge.style.padding = '0.35rem 0.5rem';
|
||||
injectedBadge.style.background = 'hsl(var(--card))';
|
||||
injectedBadge.style.color = 'hsl(var(--foreground))';
|
||||
injectedBadge.style.fontSize = '0.75rem';
|
||||
context.subscriptions.push(api.ui.mountElement('chat-owned-badge', {
|
||||
element: injectedBadge,
|
||||
target: 'app-chat-messages'
|
||||
}));
|
||||
|
||||
context.subscriptions.push(api.events.subscribeServer({ eventName: 'e2e:server', handler: () => {} }));
|
||||
context.subscriptions.push(api.events.subscribeP2p({ eventName: 'e2e:p2p', handler: () => {} }));
|
||||
|
||||
api.storage.set('coverage', { ok: true });
|
||||
api.storage.get('coverage');
|
||||
await api.clientData.write('coverage', { ok: true });
|
||||
await api.clientData.read('coverage');
|
||||
await api.serverData.write('coverage', { ok: true });
|
||||
await api.serverData.read('coverage');
|
||||
|
||||
api.profile.update({
|
||||
description: 'Updated by E2E plugin',
|
||||
displayName: `${currentUser?.displayName || 'E2E Plugin User'} Plugin Renamed`
|
||||
});
|
||||
api.profile.updateAvatar({
|
||||
avatarHash: 'e2e-plugin-avatar',
|
||||
avatarMime: 'image/svg+xml',
|
||||
avatarUrl: '/plugins/e2e-all-api/icon.svg'
|
||||
});
|
||||
|
||||
api.users.getCurrent();
|
||||
api.users.list();
|
||||
api.users.readMembers();
|
||||
api.users.setRole(pluginUserId, 'member');
|
||||
api.users.kick(pluginUserId);
|
||||
api.users.ban(pluginUserId, 'E2E coverage');
|
||||
|
||||
api.roles.list();
|
||||
api.roles.setAssignments([]);
|
||||
|
||||
api.channels.list();
|
||||
api.channels.addAudioChannel({ id: 'e2e-audio', name: 'E2E Audio', position: 90 });
|
||||
api.channels.addVideoChannel({ id: 'e2e-video', name: 'E2E Video', position: 91 });
|
||||
api.channels.select('general');
|
||||
api.channels.rename('e2e-audio', 'E2E Audio Renamed');
|
||||
|
||||
api.server.getCurrent();
|
||||
api.server.updatePermissions({ allowVoice: true });
|
||||
api.server.updateSettings({
|
||||
name: api.server.getCurrent()?.name,
|
||||
topic: 'Updated by E2E plugin'
|
||||
});
|
||||
|
||||
api.messages.readCurrent();
|
||||
if (shouldMutateChat) {
|
||||
const sentMessage = api.messages.send(originalMessage);
|
||||
|
||||
api.messages.edit(sentMessage.id, editedMessage);
|
||||
|
||||
const removableMessage = api.messages.send(deletedMessage);
|
||||
|
||||
api.messages.delete(removableMessage.id);
|
||||
api.messages.send(embedMessage);
|
||||
}
|
||||
|
||||
api.messages.sendAsPluginUser({
|
||||
content: 'Plugin bot message from all-api fixture',
|
||||
pluginUserId
|
||||
});
|
||||
api.messages.moderateDelete('missing-message-id');
|
||||
api.messages.sync(api.messages.readCurrent());
|
||||
context.subscriptions.push(api.messageBus.subscribe({
|
||||
handler: () => {},
|
||||
latestMessageLimit: 5,
|
||||
replayLatest: true,
|
||||
topic: 'e2e:latest'
|
||||
}));
|
||||
api.messageBus.publish({
|
||||
includeLatestMessages: true,
|
||||
includeSelf: true,
|
||||
latestMessageLimit: 5,
|
||||
payload: { ok: true },
|
||||
topic: 'e2e:latest'
|
||||
});
|
||||
api.messageBus.sendLatestMessages({
|
||||
limit: 5,
|
||||
topic: 'e2e:latest'
|
||||
});
|
||||
|
||||
api.p2p.connectedPeers();
|
||||
api.p2p.broadcastData('e2e:p2p', { ok: true });
|
||||
api.p2p.sendData('missing-peer', 'e2e:p2p', { ok: true });
|
||||
api.events.publishServer('e2e:server', { ok: true });
|
||||
api.events.publishP2p('e2e:p2p', { ok: true });
|
||||
|
||||
api.media.setOutputVolume(0.8);
|
||||
api.media.setInputVolume(0.8);
|
||||
await api.media.playAudioClip({ url: tinyWave, volume: 0 }).catch((error) => api.logger.warn('audio clip rejected', String(error)));
|
||||
await api.media.addCustomVideoStream({ label: 'e2e-video', stream: new MediaStream() });
|
||||
|
||||
const audioContext = new AudioContext();
|
||||
const destination = audioContext.createMediaStreamDestination();
|
||||
|
||||
await api.media.addCustomAudioStream({ label: 'e2e-audio', stream: destination.stream }).catch((error) => api.logger.warn('audio stream rejected', String(error)));
|
||||
await audioContext.close();
|
||||
|
||||
api.storage.remove('coverage');
|
||||
await api.clientData.remove('coverage');
|
||||
await api.serverData.remove('coverage');
|
||||
api.logger.info('all-api plugin completed');
|
||||
}
|
||||
|
||||
export function ready(context) {
|
||||
context.api.logger.info('all-api plugin ready');
|
||||
}
|
||||
|
||||
export function deactivate(context) {
|
||||
context.api.logger.info('all-api plugin deactivated');
|
||||
}
|
||||
|
||||
function openSoundboardModal(api, pluginUserId) {
|
||||
document.querySelector('[data-testid="e2e-soundboard-modal"]')?.remove();
|
||||
|
||||
const overlay = document.createElement('div');
|
||||
|
||||
overlay.dataset.testid = 'e2e-soundboard-modal';
|
||||
overlay.setAttribute('role', 'dialog');
|
||||
overlay.setAttribute('aria-modal', 'true');
|
||||
overlay.setAttribute('aria-label', 'E2E Soundboard');
|
||||
overlay.style.position = 'fixed';
|
||||
overlay.style.inset = '0';
|
||||
overlay.style.zIndex = '9999';
|
||||
overlay.style.display = 'grid';
|
||||
overlay.style.placeItems = 'center';
|
||||
overlay.style.background = 'rgb(0 0 0 / 0.45)';
|
||||
|
||||
const panel = document.createElement('section');
|
||||
|
||||
panel.style.width = 'min(24rem, calc(100vw - 2rem))';
|
||||
panel.style.border = '1px solid hsl(var(--border))';
|
||||
panel.style.borderRadius = '0.5rem';
|
||||
panel.style.padding = '1rem';
|
||||
panel.style.color = 'hsl(var(--foreground))';
|
||||
panel.style.background = 'hsl(var(--card))';
|
||||
panel.style.boxShadow = '0 1.25rem 3rem rgb(0 0 0 / 0.25)';
|
||||
|
||||
const title = document.createElement('h2');
|
||||
|
||||
title.textContent = 'E2E Soundboard';
|
||||
title.style.margin = '0 0 0.75rem';
|
||||
title.style.fontSize = '1rem';
|
||||
|
||||
const status = document.createElement('p');
|
||||
|
||||
status.dataset.testid = 'e2e-soundboard-status';
|
||||
status.textContent = 'Ready to play to voice channel';
|
||||
status.style.margin = '0 0 1rem';
|
||||
status.style.color = 'hsl(var(--muted-foreground))';
|
||||
status.style.fontSize = '0.875rem';
|
||||
|
||||
const actions = document.createElement('div');
|
||||
|
||||
actions.style.display = 'flex';
|
||||
actions.style.gap = '0.5rem';
|
||||
actions.style.justifyContent = 'flex-end';
|
||||
|
||||
const closeButton = document.createElement('button');
|
||||
|
||||
closeButton.type = 'button';
|
||||
closeButton.textContent = 'Close';
|
||||
closeButton.style.border = '1px solid hsl(var(--border))';
|
||||
closeButton.style.borderRadius = '0.375rem';
|
||||
closeButton.style.padding = '0.5rem 0.75rem';
|
||||
closeButton.style.background = 'transparent';
|
||||
closeButton.style.color = 'hsl(var(--foreground))';
|
||||
closeButton.addEventListener('click', () => overlay.remove());
|
||||
|
||||
const playButton = document.createElement('button');
|
||||
|
||||
playButton.type = 'button';
|
||||
playButton.textContent = 'Play airhorn to voice';
|
||||
playButton.style.border = '0';
|
||||
playButton.style.borderRadius = '0.375rem';
|
||||
playButton.style.padding = '0.5rem 0.75rem';
|
||||
playButton.style.background = 'hsl(var(--primary))';
|
||||
playButton.style.color = 'hsl(var(--primary-foreground))';
|
||||
playButton.addEventListener('click', async () => {
|
||||
playButton.disabled = true;
|
||||
status.textContent = 'Playing Airhorn to voice channel';
|
||||
|
||||
try {
|
||||
await playSoundboardClipToVoice(api);
|
||||
api.p2p.broadcastData('e2e:p2p', { sound: 'airhorn', source: 'soundboard' });
|
||||
api.events.publishP2p('e2e:p2p', { sound: 'airhorn', source: 'soundboard' });
|
||||
api.messages.sendAsPluginUser({ content: soundboardPlayedMessage, pluginUserId });
|
||||
api.logger.info('soundboard played to voice channel');
|
||||
status.textContent = soundboardPlayedMessage;
|
||||
} catch (error) {
|
||||
status.textContent = error instanceof Error ? error.message : 'Soundboard playback failed';
|
||||
api.logger.warn('soundboard playback failed', String(error));
|
||||
} finally {
|
||||
playButton.disabled = false;
|
||||
}
|
||||
});
|
||||
|
||||
actions.append(closeButton, playButton);
|
||||
panel.append(title, status, actions);
|
||||
overlay.append(panel);
|
||||
api.ui.mountElement('soundboard-modal', {
|
||||
element: overlay,
|
||||
target: 'body'
|
||||
});
|
||||
}
|
||||
|
||||
async function playSoundboardClipToVoice(api) {
|
||||
const audioContext = new AudioContext();
|
||||
const oscillator = audioContext.createOscillator();
|
||||
const gain = audioContext.createGain();
|
||||
const destination = audioContext.createMediaStreamDestination();
|
||||
|
||||
oscillator.type = 'square';
|
||||
oscillator.frequency.value = 330;
|
||||
gain.gain.value = 0.08;
|
||||
oscillator.connect(gain);
|
||||
gain.connect(destination);
|
||||
oscillator.start();
|
||||
|
||||
await api.media.addCustomAudioStream({ label: 'e2e-soundboard-airhorn', stream: destination.stream });
|
||||
await api.media.playAudioClip({ url: tinyWave, volume: 0 }).catch((error) => api.logger.warn('soundboard preview rejected', String(error)));
|
||||
await new Promise((resolve) => setTimeout(resolve, 150));
|
||||
oscillator.stop();
|
||||
await audioContext.close();
|
||||
}
|
||||
100
toju-app/public/plugins/e2e-all-api/toju.plugin.json
Normal file
100
toju-app/public/plugins/e2e-all-api/toju.plugin.json
Normal file
@@ -0,0 +1,100 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"id": "e2e.all-api-plugin",
|
||||
"title": "E2E All API Plugin",
|
||||
"description": "Calls every public Toju plugin API surface for user-facing Playwright coverage.",
|
||||
"version": "1.0.0",
|
||||
"kind": "client",
|
||||
"scope": "server",
|
||||
"apiVersion": "1.0.0",
|
||||
"compatibility": {
|
||||
"minimumTojuVersion": "1.0.0",
|
||||
"verifiedTojuVersion": "1.0.0"
|
||||
},
|
||||
"entrypoint": "./main.js",
|
||||
"authors": [
|
||||
{
|
||||
"name": "MetoYou Tests",
|
||||
"url": "https://git.azaaxin.com/myxelium/Toju"
|
||||
}
|
||||
],
|
||||
"homepage": "https://git.azaaxin.com/myxelium/Toju",
|
||||
"readme": "./README.md",
|
||||
"capabilities": [
|
||||
"profile.read",
|
||||
"profile.write",
|
||||
"users.read",
|
||||
"users.manage",
|
||||
"roles.read",
|
||||
"roles.manage",
|
||||
"messages.read",
|
||||
"messages.send",
|
||||
"messages.editOwn",
|
||||
"messages.deleteOwn",
|
||||
"messages.moderate",
|
||||
"messages.sync",
|
||||
"channels.read",
|
||||
"channels.manage",
|
||||
"server.read",
|
||||
"server.manage",
|
||||
"p2p.data",
|
||||
"p2p.media",
|
||||
"media.playAudio",
|
||||
"media.addAudioStream",
|
||||
"media.addVideoStream",
|
||||
"audio.volume",
|
||||
"audio.effects",
|
||||
"ui.settings",
|
||||
"ui.pages",
|
||||
"ui.sidePanel",
|
||||
"ui.channelsSection",
|
||||
"ui.embeds",
|
||||
"ui.dom",
|
||||
"storage.local",
|
||||
"storage.serverData.read",
|
||||
"storage.serverData.write",
|
||||
"events.server.publish",
|
||||
"events.server.subscribe",
|
||||
"events.p2p.publish",
|
||||
"events.p2p.subscribe"
|
||||
],
|
||||
"events": [
|
||||
{
|
||||
"eventName": "e2e:server",
|
||||
"direction": "serverRelay",
|
||||
"scope": "server",
|
||||
"maxPayloadBytes": 2048
|
||||
},
|
||||
{
|
||||
"eventName": "e2e:p2p",
|
||||
"direction": "p2pHint",
|
||||
"scope": "user",
|
||||
"maxPayloadBytes": 2048
|
||||
}
|
||||
],
|
||||
"data": [
|
||||
{
|
||||
"key": "coverage",
|
||||
"scope": "server",
|
||||
"storage": "serverData"
|
||||
}
|
||||
],
|
||||
"settings": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ui": {
|
||||
"settingsPages": ["coverage"],
|
||||
"sidePanels": ["coverage"],
|
||||
"channelSections": ["coverage"]
|
||||
},
|
||||
"pluginUser": {
|
||||
"displayName": "E2E Plugin Bot",
|
||||
"label": "All API fixture"
|
||||
}
|
||||
}
|
||||
18
toju-app/public/plugins/e2e-plugin-source.json
Normal file
18
toju-app/public/plugins/e2e-plugin-source.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"title": "MetoYou E2E Plugin Source",
|
||||
"plugins": [
|
||||
{
|
||||
"id": "e2e.all-api-plugin",
|
||||
"title": "E2E All API Plugin",
|
||||
"description": "Test plugin that calls every public Toju plugin API surface.",
|
||||
"version": "1.0.0",
|
||||
"scope": "server",
|
||||
"author": "MetoYou Tests",
|
||||
"image": "./e2e-all-api/icon.svg",
|
||||
"github": "https://git.azaaxin.com/myxelium/Toju",
|
||||
"homepage": "https://git.azaaxin.com/myxelium/Toju",
|
||||
"install": "./e2e-all-api/toju.plugin.json",
|
||||
"readme": "./e2e-all-api/README.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -28,7 +28,7 @@
|
||||
@if (themeStudioFullscreenComponent()) {
|
||||
<ng-container *ngComponentOutlet="themeStudioFullscreenComponent()" />
|
||||
} @else {
|
||||
<div class="flex h-full items-center justify-center px-6 text-sm text-muted-foreground">Loading Theme Studio…</div>
|
||||
<div class="flex h-full items-center justify-center px-6 text-sm text-muted-foreground">Loading Theme Studio...</div>
|
||||
}
|
||||
</div>
|
||||
} @else { @if (showDesktopUpdateNotice()) {
|
||||
@@ -145,7 +145,7 @@
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
} @if (!isThemeStudioFullscreen()) {
|
||||
} @if (!isThemeStudioFullscreen() && !isDirectMessageRoute()) {
|
||||
<app-floating-voice-controls />
|
||||
}
|
||||
<app-settings-modal />
|
||||
|
||||
@@ -34,9 +34,29 @@ export const routes: Routes = [
|
||||
loadComponent: () =>
|
||||
import('./features/room/chat-room/chat-room.component').then((module) => module.ChatRoomComponent)
|
||||
},
|
||||
{
|
||||
path: 'dm',
|
||||
loadComponent: () =>
|
||||
import('./domains/direct-message/feature/dm-workspace/dm-workspace.component').then((module) => module.DmWorkspaceComponent)
|
||||
},
|
||||
{
|
||||
path: 'dm/:conversationId',
|
||||
loadComponent: () =>
|
||||
import('./domains/direct-message/feature/dm-workspace/dm-workspace.component').then((module) => module.DmWorkspaceComponent)
|
||||
},
|
||||
{
|
||||
path: 'settings',
|
||||
loadComponent: () =>
|
||||
import('./features/settings/settings.component').then((module) => module.SettingsComponent)
|
||||
},
|
||||
{
|
||||
path: 'plugin-store',
|
||||
loadComponent: () =>
|
||||
import('./domains/plugins/feature/plugin-store/plugin-store.component').then((module) => module.PluginStoreComponent)
|
||||
},
|
||||
{
|
||||
path: 'plugins/:pluginId/:pageId',
|
||||
loadComponent: () =>
|
||||
import('./domains/plugins/feature/plugin-page-host/plugin-page-host.component').then((module) => module.PluginPageHostComponent)
|
||||
}
|
||||
];
|
||||
|
||||
@@ -34,6 +34,7 @@ import { ExternalLinkService } from './core/platform';
|
||||
import { SettingsModalService } from './core/services/settings-modal.service';
|
||||
import { ElectronBridgeService } from './core/platform/electron/electron-bridge.service';
|
||||
import { UserStatusService } from './core/services/user-status.service';
|
||||
import { GameActivityService } from './domains/game-activity';
|
||||
import { ServersRailComponent } from './features/servers/servers-rail/servers-rail.component';
|
||||
import { TitleBarComponent } from './features/shell/title-bar/title-bar.component';
|
||||
import { FloatingVoiceControlsComponent } from './domains/voice-session/feature/floating-voice-controls/floating-voice-controls.component';
|
||||
@@ -44,7 +45,8 @@ import { NativeContextMenuComponent } from './features/shell/native-context-menu
|
||||
import { UsersActions } from './store/users/users.actions';
|
||||
import { RoomsActions } from './store/rooms/rooms.actions';
|
||||
import { selectCurrentRoom } from './store/rooms/rooms.selectors';
|
||||
import { ROOM_URL_PATTERN, STORAGE_KEY_CURRENT_USER_ID } from './core/constants';
|
||||
import { ROOM_URL_PATTERN } from './core/constants';
|
||||
import { clearStoredCurrentUserId, getStoredCurrentUserId } from './core/storage/current-user-storage';
|
||||
import {
|
||||
ThemeNodeDirective,
|
||||
ThemePickerOverlayComponent,
|
||||
@@ -94,10 +96,12 @@ export class App implements OnInit, OnDestroy {
|
||||
readonly externalLinks = inject(ExternalLinkService);
|
||||
readonly electronBridge = inject(ElectronBridgeService);
|
||||
readonly userStatus = inject(UserStatusService);
|
||||
readonly gameActivity = inject(GameActivityService);
|
||||
readonly dismissedDesktopUpdateNoticeKey = signal<string | null>(null);
|
||||
readonly themeStudioFullscreenComponent = signal<Type<unknown> | null>(null);
|
||||
readonly themeStudioControlsPosition = signal<{ x: number; y: number } | null>(null);
|
||||
readonly isDraggingThemeStudioControls = signal(false);
|
||||
readonly currentRouteUrl = signal(this.getCurrentRouteUrl());
|
||||
|
||||
readonly appShellLayoutStyles = computed(() => this.theme.getLayoutContainerStyles('appShell'));
|
||||
readonly serversRailLayoutStyles = computed(() => this.theme.getLayoutItemStyles('serversRail'));
|
||||
@@ -111,6 +115,7 @@ export class App implements OnInit, OnDestroy {
|
||||
return this.settingsModal.activePage() === 'theme'
|
||||
&& this.settingsModal.themeStudioMinimized();
|
||||
});
|
||||
readonly isDirectMessageRoute = computed(() => this.getRoutePath(this.currentRouteUrl()).startsWith('/dm'));
|
||||
readonly desktopUpdateNoticeKey = computed(() => {
|
||||
const updateState = this.desktopUpdateState();
|
||||
|
||||
@@ -219,8 +224,19 @@ export class App implements OnInit, OnDestroy {
|
||||
|
||||
void this.desktopUpdates.initialize();
|
||||
|
||||
let currentUserId = getStoredCurrentUserId();
|
||||
|
||||
await this.databaseService.initialize();
|
||||
|
||||
if (currentUserId) {
|
||||
const persistedUserId = await this.databaseService.getCurrentUserId();
|
||||
|
||||
if (persistedUserId !== currentUserId) {
|
||||
clearStoredCurrentUserId();
|
||||
currentUserId = null;
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const apiBase = this.servers.getApiBaseUrl();
|
||||
|
||||
@@ -231,31 +247,29 @@ export class App implements OnInit, OnDestroy {
|
||||
|
||||
await this.setupDesktopDeepLinks();
|
||||
|
||||
this.store.dispatch(UsersActions.loadCurrentUser());
|
||||
|
||||
this.userStatus.start();
|
||||
|
||||
this.store.dispatch(RoomsActions.loadRooms());
|
||||
|
||||
const currentUserId = localStorage.getItem(STORAGE_KEY_CURRENT_USER_ID);
|
||||
this.gameActivity.start();
|
||||
const currentUrl = this.getCurrentRouteUrl();
|
||||
|
||||
if (!currentUserId) {
|
||||
if (!this.isPublicRoute(this.router.url)) {
|
||||
if (!this.isPublicRoute(currentUrl)) {
|
||||
this.router.navigate(['/login'], {
|
||||
queryParams: {
|
||||
returnUrl: this.router.url
|
||||
returnUrl: currentUrl
|
||||
}
|
||||
}).catch(() => {});
|
||||
}
|
||||
} else {
|
||||
const current = this.router.url;
|
||||
this.store.dispatch(UsersActions.loadCurrentUser());
|
||||
this.store.dispatch(RoomsActions.loadRooms());
|
||||
|
||||
const generalSettings = loadGeneralSettingsFromStorage();
|
||||
const lastViewedChat = loadLastViewedChatFromStorage(currentUserId);
|
||||
|
||||
if (
|
||||
generalSettings.reopenLastViewedChat
|
||||
&& lastViewedChat
|
||||
&& (current === '/' || current === '/search')
|
||||
&& (currentUrl === '/' || currentUrl === '/search')
|
||||
) {
|
||||
this.router.navigate(['/room', lastViewedChat.roomId], { replaceUrl: true }).catch(() => {});
|
||||
}
|
||||
@@ -264,6 +278,8 @@ export class App implements OnInit, OnDestroy {
|
||||
this.router.events.subscribe((evt) => {
|
||||
if (evt instanceof NavigationEnd) {
|
||||
const url = evt.urlAfterRedirects || evt.url;
|
||||
|
||||
this.currentRouteUrl.set(url);
|
||||
const roomMatch = url.match(ROOM_URL_PATTERN);
|
||||
const currentRoomId = roomMatch ? roomMatch[1] : null;
|
||||
|
||||
@@ -388,9 +404,31 @@ export class App implements OnInit, OnDestroy {
|
||||
}
|
||||
|
||||
private isPublicRoute(url: string): boolean {
|
||||
return url === '/login' ||
|
||||
url === '/register' ||
|
||||
url.startsWith('/invite/');
|
||||
const path = this.getRoutePath(url);
|
||||
|
||||
return path === '/login' ||
|
||||
path === '/register' ||
|
||||
path.startsWith('/invite/');
|
||||
}
|
||||
|
||||
private getCurrentRouteUrl(): string {
|
||||
if (typeof window === 'undefined') {
|
||||
return this.router.url;
|
||||
}
|
||||
|
||||
const currentUrl = `${window.location.pathname}${window.location.search}${window.location.hash}`;
|
||||
|
||||
return currentUrl || this.router.url;
|
||||
}
|
||||
|
||||
private getRoutePath(url: string): string {
|
||||
if (!url) {
|
||||
return '/';
|
||||
}
|
||||
|
||||
const [path] = url.split(/[?#]/, 1);
|
||||
|
||||
return path || '/';
|
||||
}
|
||||
|
||||
private parseDesktopInviteUrl(url: string): { inviteId: string; sourceUrl: string } | null {
|
||||
|
||||
@@ -5,6 +5,7 @@ export const STORAGE_KEY_CONNECTION_SETTINGS = 'metoyou_connection_settings';
|
||||
export const STORAGE_KEY_NOTIFICATION_SETTINGS = 'metoyou_notification_settings';
|
||||
export const STORAGE_KEY_VOICE_SETTINGS = 'metoyou_voice_settings';
|
||||
export const STORAGE_KEY_DEBUGGING_SETTINGS = 'metoyou_debugging_settings';
|
||||
export const STORAGE_KEY_ICE_SERVERS = 'metoyou_ice_servers';
|
||||
export const STORAGE_KEY_THEME_ACTIVE = 'metoyou_theme_active';
|
||||
export const STORAGE_KEY_THEME_DRAFT = 'metoyou_theme_draft';
|
||||
export const STORAGE_KEY_USER_VOLUMES = 'metoyou_user_volumes';
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user