robert/ttrpg-initiative-tracker
1
0
Fork 0
Code Issues Pull Requests Releases 4 Wiki Activity

refactor: rename ws adapter to server across codebase

Browse Source 
'ws' conflated storage mode with transport protocol (WebSocket). Renamed for
clarity: the adapter talks the self-hosted server (src/storage/server.js), which
happens to use WebSocket for realtime — but the name should describe what it
connects to, not how.

Renames:
- src/storage/ws.js -> server.js
- createWsStorage() -> createServerStorage()
- storage mode 'ws' -> 'server'
- REACT_APP_BACKEND_WS -> REACT_APP_BACKEND_REALTIME_URL
- factory param wsUrl -> realtimeUrl
- server/tests/ws-*.test.js -> server-*.test.js

Kept literal: 'ws' npm package, ws:// protocol URLs, /ws WebSocket endpoint.
Transport is accurate there; only storage-naming changed.

Updated all docs (DEVELOPMENT, TESTING, REWORK_PLAN, GLOSSARY, TODO), scripts
(dev-start.sh, replay-combat.js), factory + ESM tests. 204 tests green.
This commit is contained in:
david raistrick
2026-07-04 15:47:13 -04:00
parent cb41d9ec8f
commit e94e1959ff
16 changed files with 64 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/tests/StorageEsm.test.js
+2 -2
View File
@@ -1,6 +1,6 @@
// Lock: storage adapters must use ESM exports (no module.exports).
// Regression guard: CJS in src/ crashes CRA prod build (ESM strict).
// Bug history: ws.js + firebase.js used module.exports. Dev lenient (masked),
// Bug history: server.js + firebase.js used module.exports. Dev lenient (masked),
// prod bundle crashed blank page. firebase.js always ESM.
import fs from 'fs';
import path from 'path';
@@ -8,7 +8,7 @@ import path from 'path';
const ADAPTER_DIR = path.join(__dirname, '..', 'storage');
describe('storage adapters use ESM (no CJS)', () => {
const adapters = ['ws.js', 'firebase.js', 'index.js'];
const adapters = ['server.js', 'firebase.js', 'index.js'];
test.each(adapters)('%s has no module.exports', (file) => {
const full = fs.readFileSync(path.join(ADAPTER_DIR, file), 'utf8');
// strip line comments so words like 'require' in explanatory comments don't trip the guard
src/tests/storage.factory.test.js
+6 -6
View File
@@ -27,10 +27,10 @@ describe('getStorageMode', () => {
expect(getStorageMode()).toBe('firebase');
});
test('returns ws when REACT_APP_STORAGE=ws', () => {
process.env.REACT_APP_STORAGE = 'ws';
test('returns server when REACT_APP_STORAGE=server', () => {
process.env.REACT_APP_STORAGE = 'server';
const { getStorageMode } = require('../storage/index');
expect(getStorageMode()).toBe('ws');
expect(getStorageMode()).toBe('server');
});
test('throws on unknown mode', () => {
@@ -41,8 +41,8 @@ describe('getStorageMode', () => {
});
describe('getStorage factory routing', () => {
test('ws mode returns ws adapter (init may fail without backend — catch)', () => {
process.env.REACT_APP_STORAGE = 'ws';
test('server mode returns server adapter (init may fail without backend — catch)', () => {
process.env.REACT_APP_STORAGE = 'server';
const { getStorage } = require('../storage/index');
try {
const s = getStorage();
@@ -56,7 +56,7 @@ describe('getStorage factory routing', () => {
});
test('returns singleton on repeat call (same instance)', () => {
process.env.REACT_APP_STORAGE = 'ws';
process.env.REACT_APP_STORAGE = 'server';
const { getStorage } = require('../storage/index');
let a;
try { a = getStorage(); } catch (e) { return; } // no backend ok