@homie-rocks/studio 0.28.0 → 0.29.0

package/worker/chat-store.mjs

@@ -1,7 +1,8 @@
 /**
  * ROOM CHAT IN THE STUDIO'S OWN D1 (@homie-rocks/studio 0.23.0, NETPLAY.md section 19): the owner's chat rules per game
  * and per server, and the reports players make. Never the chat itself: what people say lives a few minutes in the
- * room's memory and nowhere else (worker/room.mjs). A report keeps the one message it is about, for 30 days.
+ * room's memory and nowhere else (worker/room.mjs), unless an owner turns a room's `history` on (0.29.0: then
+ * worker/lounge-store.mjs keeps it for that many days). A report keeps the one message it is about, for 30 days.
  *
  *   chat_rules    (game, server, rules JSON, updated_at): server '' is the whole game; a server's row wins over it
  *   chat_reports  one reported message: its words, its sender's room name and (when signed in) account id, the room,

package/worker/chat.mjs

@@ -20,6 +20,9 @@
  *
  * Emoji and quick lines are the studio's own words: they never need a review, so they reach every screen at once.
  * NOTHING is stored here: the relay keeps a short window in memory (section 19), and a report keeps only the message.
+ * A room keeps its words longer only when its owner turns `history` on (a number of days, 0.29.0; off for every game
+ * by default, never on a kids server): then the Table writes what was said, never a reaction, to the studio's own D1
+ * (worker/lounge-store.mjs) and forgets it after that many days.
  */
 import { WORDS_B64 } from './chat-words.mjs';
 import { clefRun, localAiOf } from './brain.mjs';
@@ -55,6 +58,8 @@ export const CHAT_LIMITS = Object.freeze({
   /** A typed message: `max` is the room's, at most this (homie.rocks's LINE_MAX). */
   text: 280, minText: 20, name: 24,
   lineText: 60, lines: 12, extraEmoji: 3, words: 64, word: 32, slowMax: 120,
+  /** `history`: the most days a room may keep what was said (0, the default, keeps nothing past the window). */
+  historyMax: 90,
   /** The room's window: the last `keep` messages from the last `keepMs` (memory only), for a page that just opened. */
   keep: 50, keepMs: 15 * 60_000,
   /** The same words from the same person within this long are not sent again. */
@@ -77,9 +82,12 @@ export const CHAT_RATES = Object.freeze({
 /** A game with no "chat" in its game.json: emoji and quick lines for everyone, typing for signed-in players (reviewed). */
 export const CHAT_DEFAULTS = Object.freeze({
   mode: 'text', who: 'signed-in', react: 'anyone', slow: 2, max: 140, links: 'block', swears: 'block', ai: true,
-  bubbles: true, watchers: true, hub: true,
+  bubbles: true, watchers: true, hub: true, history: 0,
 });
 
+/** How long a room with these rules keeps what was said: its `history` days, else the window's few minutes. */
+export const windowMsOf = (rules) => (rules?.history > 0 ? rules.history * 86_400_000 : CHAT_LIMITS.keepMs);
+
 const ID = /^[a-z][a-z0-9_]{0,15}$/;
 const PICTO = /\p{Extended_Pictographic}/u;
 const oneLine = (v, max) => [...String(v ?? '').normalize('NFKC').replace(/[\p{Cc}\p{Cf}\p{Co}\p{Cs}\u2028\u2029]+/gu, ' ').replace(/\s+/g, ' ').trim()].slice(0, max).join('').trim();
@@ -151,6 +159,8 @@ export function normalizeChat(raw, { kids = false, speech = 'game' } = {}) {
     links: r.links === 'allow' ? 'allow' : 'block',
     swears: r.swears === 'allow' ? 'allow' : 'block',
     ai: bool('ai'), bubbles: bool('bubbles'), watchers: bool('watchers'), hub: bool('hub'),
+    // Kept words (0.29.0): only when the owner asks, never on a kids server or a capped one, never with chat off.
+    history: kids || capped || mode === 'off' ? 0 : int(r.history, 0, CHAT_LIMITS.historyMax, CHAT_DEFAULTS.history),
     emoji: [...REACTIONS.map((x) => ({ ...x })), ...extraEmoji(r.emoji)],
     lines: quickLines(r.lines),
     block: wordList(r.block), allow: wordList(r.allow),
@@ -191,6 +201,7 @@ export function checkChatRules(body) {
   for (const k of ['who', 'react']) if (b[k] !== undefined) { if (!CHAT_WHO.includes(b[k])) return bad(`${k} is anyone, signed-in or members`); f[k] = b[k]; }
   if (b.slow !== undefined) { const n = Math.floor(Number(b.slow)); if (!Number.isFinite(n) || n < 0 || n > CHAT_LIMITS.slowMax) return bad(`slow is 0 to ${CHAT_LIMITS.slowMax} seconds`); f.slow = n; }
   if (b.max !== undefined) { const n = Math.floor(Number(b.max)); if (!Number.isFinite(n) || n < CHAT_LIMITS.minText || n > CHAT_LIMITS.text) return bad(`max is ${CHAT_LIMITS.minText} to ${CHAT_LIMITS.text} characters`); f.max = n; }
+  if (b.history !== undefined) { const n = Math.floor(Number(b.history)); if (!Number.isFinite(n) || n < 0 || n > CHAT_LIMITS.historyMax) return bad(`history is 0 (keep nothing) to ${CHAT_LIMITS.historyMax} days`); f.history = n; }
   if (b.links !== undefined) { if (!['block', 'allow'].includes(b.links)) return bad('links is block or allow'); f.links = b.links; }
   if (b.swears !== undefined) { if (!['block', 'allow'].includes(b.swears)) return bad('swears is block or allow'); f.swears = b.swears; }
   for (const k of ['ai', 'bubbles', 'watchers', 'hub']) if (b[k] !== undefined) f[k] = b[k] === true || b[k] === 'on' || b[k] === 'true';
@@ -208,6 +219,7 @@ export function chatProblems(raw) {
   if (!raw || typeof raw !== 'object' || Array.isArray(raw)) return ['"chat" is an object (or false for no chat)'];
   const out = [];
   if (raw.mode !== undefined && !CHAT_MODES.includes(raw.mode)) out.push('chat.mode is off, emoji, lines or text');
+  if (raw.history !== undefined && !(Number.isInteger(raw.history) && raw.history >= 0 && raw.history <= CHAT_LIMITS.historyMax)) out.push(`chat.history is a number of days, 0 to ${CHAT_LIMITS.historyMax} (0 keeps nothing past the room's few minutes)`);
   for (const k of ['who', 'react']) if (raw[k] !== undefined && !CHAT_WHO.includes(raw[k])) out.push(`chat.${k} is anyone, signed-in or members`);
   // Where chat sits on the screen is the page's (game.json "screen": { "chat" }), never the room's rules.
   for (const k of ['corner', 'place', 'at']) if (raw[k] !== undefined && (k !== 'at' || typeof raw.at === 'string')) out.push(`chat.${k}: where chat sits on the screen goes in "screen": { "chat": { "at": … } }`);

package/worker/discover.mjs

@@ -67,6 +67,8 @@ export function robotsTxt(cat, origin, { preview = false } = {}) {
     'Disallow: /shop/thanks',
     'Disallow: /shop/parent/',
     'Disallow: /__homie',
+    // The Lounge's socket and APIs (0.29.0); its page may be crawled.
+    ...(cat.studio?.lounge ? ['Disallow: /lounge/api/', 'Disallow: /lounge/__'] : []),
     ...games.flatMap((id) => [`Disallow: /${id}/play`, `Disallow: /${id}/tv`, `Disallow: /${id}/watch`, `Disallow: /${id}/live`, `Disallow: /${id}/invite`, `Disallow: /${id}/api/`, `Disallow: /${id}/__`, `Disallow: /${id}/s/*/play`, `Disallow: /${id}/s/*/tv`, `Disallow: /${id}/s/*/home`]),
     '',
     `Sitemap: ${origin}/sitemap.xml`,
@@ -96,6 +98,8 @@ export function sitemapEntries(cat, { all = null } = {}) {
   if (songs.length) { add('/music/', newest(songs.map(mediaDate))); for (const e of songs) add(`/music/${e.slug}/`, mediaDate(e)); }
   if (videos.length) { add('/videos/', newest(videos.map(mediaDate))); for (const e of videos) add(`/videos/${e.slug}/`, mediaDate(e)); }
   if (posts.length) { add('/posts/', newest(posts.map(postDate))); for (const p of posts) add(`/posts/${p.slug}/`, postDate(p)); }
+  // The Lounge (0.29.0), when studio.json turns it on: its page (what is said there is not in the page).
+  if (cat.studio?.lounge) add('/lounge/');
   for (const p of ownPages(cat, all)) add(p);
   return out;
 }
@@ -210,6 +214,7 @@ export function llmsTxt(cat, origin, { remixable = () => false, directory = 'htt
   }
   out.push('', '## Optional', '');
   if (games.length) out.push(`- [Rooms](${origin}/rooms/): every public room playing now (${origin}/api/rooms is the same as JSON)`);
+  if (cat.studio?.lounge) out.push(`- [${label(cat.studio.lounge.name ?? 'The Lounge')}](${origin}/lounge/): the studio's community room: play nights, live rooms and chat (${origin}/lounge/api/now is its play nights and rules as JSON; what people say there is not published)`);
   out.push(`- [Studio manifest](${origin}/.well-known/homie-studio.json): the games, songs, videos and posts as JSON`);
   out.push(`- [Sitemap](${origin}/sitemap.xml): every public page`);
   if (!full) out.push(`- [Everything, in full](${origin}/llms-full.txt): each game's whole description, how to play and credits, and every post's text`);

package/worker/index.mjs

@@ -92,6 +92,8 @@ import { BRAIN_BUDGET, HouseAgents, agentFacts, aiName, decodeFacts, encodeFacts
 import { CLEF, DECIDE, clefRun, costOf, localAiOf, picksOf, talks } from './brain.mjs';
 import { REACTIONS, reviewChat } from './chat.mjs';
 import { REPORT_REASONS, chatDay, chatOf, chatRowsOf, fileReport } from './chat-store.mjs';
+import { forgetLines, historyOf, keepLines, keptLine } from './lounge-store.mjs';
+import { isLoungePath, loungeRoutes } from './lounge.mjs';
 import { doorPage, serverPage, serversPage } from './site.mjs';
 import { isLocalOrigin, qrSvg } from './qr.mjs';
 import { SEAT_MAX, perAddress, seatsOf } from './seats.mjs';
@@ -601,6 +603,11 @@ async function route(request, env, ctx) {
     if (shopped) return shopped;
   }
   if (path.startsWith('/api/player/') || path === '/account' || path === '/account/' || path === '/_homie/account.js') return playerRoutes(request, env, ctx, url, { catalogueOf: getCat });
+  // The Lounge (0.29.0, chat/LOUNGE.md): the studio's own community room, when studio.json turns it on.
+  if (isLoungePath(path)) {
+    const lounged = await loungeRoutes(request, env, ctx, url, { catalogueOf: getCat, roomsOf });
+    if (lounged) return lounged;
+  }
   if (path === '/_homie/site.js') return new Response(SITE_JS, { headers: { 'content-type': 'text/javascript; charset=utf-8', 'cache-control': url.searchParams.get('v') === STUDIO_VERSION_TAG ? 'public, max-age=31536000, immutable' : 'public, max-age=300', 'x-content-type-options': 'nosniff' } });
   if (path === '/api/stats/beat' && request.method === 'POST') return mediaBeat(request, env, ctx, url);
   if (path === '/api/stats') {
@@ -658,6 +665,8 @@ async function route(request, env, ctx) {
       // The studio's posts, for the hub (the full text is in /posts/feed.json).
       posts: (cat.posts ?? []).slice(0, 20).map((p) => ({ slug: p.slug, title: p.title, date: p.date, summary: p.summary, page: `${url.origin}/posts/${p.slug}/`, image: p.image ? (p.image.startsWith('/') ? `${url.origin}${p.image}` : p.image) : null, links: p.links ?? {} })),
       ...(shareRooms ? { rooms: `${url.origin}/api/rooms` } : {}),
+      // The studio's Lounge (0.29.0), for a directory that shows lounges: its page and its public facts.
+      ...(cat.studio?.lounge ? { lounge: { name: cat.studio.lounge.name, page: `${url.origin}/lounge/`, now: `${url.origin}/lounge/api/now` } } : {}),
       // Shared only when studio.json says `stats.share`: two numbers for the whole studio, for the hub.
       ...(played ? { played } : {}),
       // The shop (0.24.0): whether it sells and its till, never a key or a sale; and referrals: this studio takes
@@ -1200,11 +1209,30 @@ export class Table {
     this.vocabRead = this.readVocab(game).catch(() => false);
     // Room chat (section 19): typed text the floor let through waits for the studio's own Workers AI.
     this.room.review = (text, opts) => this.reviewChat(text, opts);
+    // Kept chat (0.29.0): a room whose rules keep `history` writes what was said to D1 and deletes what is taken down,
+    // one after another (a line removed the moment it went out is never written after its delete).
+    this.room.onPublished = (rec) => this.keptQueue(() => keepLines(this.env, this.game, this.code, [rec]));
+    this.room.onUnsaid = (ids) => this.keptQueue(() => forgetLines(this.env, this.game, this.code, ids));
     // A game's own decisions (section 20): the host's typed questions, for a game whose game.json opts in.
     this.room.decider = (state, questions, opts) => this.decide(state, questions, opts);
     return this.room;
   }
 
+  /** Kept chat's writes, in order, each finished before the next (D1 calls from one room never pass each other). */
+  keptQueue(fn) {
+    if (!this.env.DB) return;
+    this.kept = (this.kept ?? Promise.resolve()).then(fn).catch((error) => { try { console.log(JSON.stringify({ ev: 'chat-history-failed', room: this.code, error: String(error?.message ?? error).slice(0, 200) })); } catch { /* no console */ } });
+    this.ctx.waitUntil(this.kept);
+  }
+
+  /** A room that keeps history puts what it kept back in its window before its first page opens (once per opening). */
+  async hydrateHistory(room) {
+    const days = room.chatRules().history;
+    if (!(days > 0) || room.hydrated || !this.env.DB) return;
+    room.hydrated = true;
+    try { await this.kept; room.hydrate(await historyOf(this.env, this.game, this.code, { days })); } catch { /* the window alone (before migration 0009) */ }
+  }
+
   /** Whether this game asked for decisions (game.json "decide": true, in the built catalogue), read once a minute. */
   async decideOn() {
     if (this.decideRead && Date.now() - this.decideRead.at < 60_000) return this.decideRead.on;
@@ -1411,14 +1439,16 @@ export class Table {
     // A chat line as the room keeps it (section 19), for a report: the Worker files the room's own copy, never a reporter's.
     if (url.pathname === '/__chat') {
       const id = url.searchParams.get('id');
-      const r = room.chatLog.find((x) => x.id === id);
-      return json({ ok: Boolean(r), line: r ? { id: r.id, kind: r.kind, text: r.text ?? null, glyph: r.glyph ?? null, name: r.name, seat: r.seat, at: r.at, by: r.by, player: r.from?.player ?? null } : null });
+      // A line older than the window is in the room's kept history, when it keeps one (0.29.0).
+      const r = room.chatLog.find((x) => x.id === id) ?? (room.chatRules().history > 0 ? await keptLine(this.env, this.game, this.code, id) : null);
+      return json({ ok: Boolean(r), line: r ? { id: r.id, kind: r.kind, text: r.text ?? null, glyph: r.glyph ?? null, name: r.name, seat: r.seat, at: r.at, by: r.by, player: r.from?.player ?? null, owner: Boolean(r.owner), mod: Boolean(r.mod) } : null });
     }
     if (url.pathname === '/__office') {
       const ctl = await request.json().catch(() => null);
       const why = await verifyControl(this.env, ctl, { game: this.game, room: this.code }, this.seen);
       if (why) return json({ ok: false, error: 'refused', why }, 403);
-      const res = room.control(ctl.op, ctl.args && typeof ctl.args === 'object' ? ctl.args : {});
+      // A Lounge card waits for the studio's review (0.29.0); every other control answers at once.
+      const res = await room.control(ctl.op, ctl.args && typeof ctl.args === 'object' ? ctl.args : {});
       // AI talk turned off (a policy) or a guide kicked: the house guides follow at once.
       if (this.house) this.house.sync();
       await this.ctx.storage.put('office', room.officeSaved()).catch(() => {});
@@ -1436,6 +1466,8 @@ export class Table {
     if (pol) room.setPolicy(pol);
     if (this.house) this.house.sync();
     const agent = decodeFacts(url.searchParams.get('ag'));
+    // Kept chat (0.29.0): the room's history is back in its window before this page hears it.
+    await this.hydrateHistory(room);
     const [client, server] = Object.values(new WebSocketPair());
     server.accept();
     const via = url.searchParams.get('via');
@@ -1459,6 +1491,9 @@ export class Table {
       acct: url.searchParams.get('acct') === '1',
       member: url.searchParams.get('mem') === '1',
       hub: url.pathname === '/__watch' && url.searchParams.get('hub') === '1',
+      // The Lounge (0.29.0): the signed-in account's name and a moderator's mark, the Worker's word on a watch socket.
+      ...(url.pathname === '/__watch' && url.searchParams.get('nm') ? { name: String(url.searchParams.get('nm')).slice(0, 40) } : {}),
+      ...(url.pathname === '/__watch' && url.searchParams.get('mod') === '1' ? { mod: true } : {}),
       send: (text) => { try { server.send(text); } catch { /* closed */ } },
       close: (c, r) => { try { server.close(c, r); } catch { /* closed */ } },
       buffered: () => 0,