mirror of
https://github.com/Shik3i/KoalaSync.git
synced 2026-07-26 12:08:15 +00:00
KoalaDev
9963da2ebc
Replace the implicit "hostPeerId present ⇒ feature supported" heuristic with an
explicit capabilities list the relay advertises in ROOM_DATA. Cleaner, self-
documenting, and the extensible hook for the planned co-host feature (owner
promotes guests to extra controllers) — a future 'co-host' capability + events
slot in without a protocol bump.
- shared: CAPABILITIES { HOST_CONTROL }.
- server: SERVER_CAPABILITIES advertised in ROOM_DATA.
- background: track serverCapabilities (empty against older relay), serverSupports(),
thread hostControlSupported through GET_STATUS / GET_CONTROL_MODE / CONTROL_MODE.
- popup: gate the host-control card on the explicit capability instead of hostPeerId.
Backwards-compatible both ways: old relay omits the field → feature stays hidden
(no errors); old client ignores the field. WS test asserts ROOM_DATA advertises
the capability. Adds docs/host-control-mode-TESTING.md (beta-server setup, wss
caveat, two-new-clients note, verification checklist).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
85 lines
3.5 KiB
JavaScript
85 lines
3.5 KiB
JavaScript
/**
|
|
* KoalaSync Shared Constants & Protocol Definitions
|
|
*
|
|
* ⚠️ WARNING: This is the SINGLE SOURCE OF TRUTH.
|
|
* If you edit this file, you MUST run: node scripts/build-extension.cjs
|
|
* to propagate changes to the extension and relay server.
|
|
*/
|
|
|
|
export const PROTOCOL_VERSION = "1.0.0";
|
|
export const APP_VERSION = "2.4.6";
|
|
|
|
export const OFFICIAL_SERVER_URL = 'wss://syncserver.koalastuff.net';
|
|
export const OFFICIAL_LANDING_PAGE_URL = 'https://sync.koalastuff.net';
|
|
export const OFFICIAL_SERVER_TOKEN = '62170b705234c4f4807a9b22420bb93cf1a2aacfa4c5d3b47804482babb8eb50';
|
|
export const SUPPORT_URL = 'https://support.koalastuff.net';
|
|
export const GITHUB_URL = 'https://github.com/Shik3i/KoalaSync';
|
|
|
|
export function isFirefox() {
|
|
const manifest = chrome.runtime.getManifest();
|
|
return !!manifest.browser_specific_settings?.gecko?.id;
|
|
}
|
|
|
|
export function getReviewUrl() {
|
|
return isFirefox()
|
|
? 'https://addons.mozilla.org/firefox/addon/koalasync/reviews/'
|
|
: 'https://chromewebstore.google.com/detail/koalasync/obbnmkmlaaddodakcbdljknjpagklifc/reviews';
|
|
}
|
|
|
|
export const EVENTS = {
|
|
// Connection & Room
|
|
JOIN_ROOM: "join_room",
|
|
LEAVE_ROOM: "leave_room",
|
|
ROOM_DATA: "room_data", // Server -> Client: current room state
|
|
ERROR: "error",
|
|
|
|
// Host Control Mode
|
|
SET_CONTROL_MODE: "set_control_mode", // Client -> Server: host sets room control mode ('everyone' | 'host-only')
|
|
CONTROL_MODE: "control_mode", // Server -> Client: room control mode changed { controlMode, hostPeerId }
|
|
|
|
// Media Control
|
|
PLAY: "play",
|
|
PAUSE: "pause",
|
|
SEEK: "seek",
|
|
|
|
// Sync Coordination
|
|
PEER_STATUS: "peer_status", // Heartbeat from peers
|
|
FORCE_SYNC_PREPARE: "force_sync_prepare",
|
|
FORCE_SYNC_ACK: "force_sync_ack",
|
|
FORCE_SYNC_EXECUTE: "force_sync_execute",
|
|
EVENT_ACK: "event_ack",
|
|
GET_ROOMS: "get_rooms",
|
|
ROOM_LIST: "room_list",
|
|
|
|
// Episode Auto-Sync
|
|
EPISODE_LOBBY: "episode_lobby", // Broadcast: waiting for everyone on this episode
|
|
EPISODE_READY: "episode_ready", // Response: loaded the episode and paused at 0:00
|
|
EPISODE_LOBBY_CANCEL: "episode_lobby_cancel", // Broadcast: cancel active lobby and resume
|
|
|
|
// Ping / Latency
|
|
PING: "ping", // { t: timestamp, target?: peerId } — empty target = server echo
|
|
PONG: "pong" // server responds with same { t } for client RTT calculation
|
|
};
|
|
|
|
// Room control modes (Host Control Mode feature).
|
|
// NOTE: content.js does not import this module — it uses the string literals
|
|
// 'everyone' / 'host-only' directly. Keep these values in sync there.
|
|
export const CONTROL_MODES = {
|
|
EVERYONE: 'everyone', // default: anyone can play/pause/seek for the room
|
|
HOST_ONLY: 'host-only' // only the host drives the room
|
|
};
|
|
|
|
// Server feature capabilities, advertised to clients in ROOM_DATA. Lets a client
|
|
// detect what the relay actually supports instead of inferring it from the
|
|
// presence of a data field — so new server features degrade cleanly on older
|
|
// relays (unknown/absent list → feature treated as unavailable) and old clients
|
|
// simply ignore the field. Add a flag here as each server-gated feature lands.
|
|
export const CAPABILITIES = {
|
|
HOST_CONTROL: 'host-control'
|
|
// Future: CO_HOST: 'co-host' // owner promotes guests to additional controllers
|
|
};
|
|
|
|
export const HEARTBEAT_INTERVAL = 15000; // 15s
|
|
export const FORCE_SYNC_TIMEOUT = 8500; // 8.5s timeout for force sync ACKs (must be > content.js poll timeout of 8s)
|
|
export const EPISODE_LOBBY_TIMEOUT = 60000; // 60s timeout for episode lobby
|