@commentbox/server-worker 0.1.2 → 0.2.1

package/migrations/0002_sessions.sql

@@ -0,0 +1,15 @@
+-- 0002: session links (CommentBox mode "session"). Only the SHA-256 of a token is stored.
+CREATE TABLE IF NOT EXISTS review_sessions (
+  id TEXT PRIMARY KEY,
+  name TEXT NOT NULL,
+  token_hash TEXT NOT NULL UNIQUE,
+  created_at TEXT NOT NULL,
+  expires_at INTEGER NOT NULL,
+  closed_at INTEGER
+);
+
+CREATE TABLE IF NOT EXISTS session_comments (
+  comment_id TEXT PRIMARY KEY,
+  session_id TEXT NOT NULL
+);
+CREATE INDEX IF NOT EXISTS session_comments_session ON session_comments (session_id);

package/migrations/0003_rounds.sql

@@ -0,0 +1,28 @@
+-- CommentBox 0.2: comment rounds (opt-in). Adds the rounds table and two columns on comments.
+-- Servers apply this by themselves on start (the ALTERs only when the columns are missing).
+ALTER TABLE comments ADD COLUMN round_id TEXT;
+ALTER TABLE comments ADD COLUMN screenshot_highlighted INTEGER NOT NULL DEFAULT 0;
+CREATE INDEX IF NOT EXISTS comments_round ON comments (round_id);
+CREATE TABLE IF NOT EXISTS rounds (
+  id TEXT PRIMARY KEY,
+  project TEXT NOT NULL,
+  page_url TEXT NOT NULL,
+  session TEXT NOT NULL,
+  status TEXT NOT NULL DEFAULT 'open',
+  comment_count INTEGER NOT NULL DEFAULT 0,
+  created_at TEXT NOT NULL,
+  updated_at TEXT NOT NULL,
+  last_comment_at INTEGER NOT NULL,
+  closed_at TEXT,
+  close_reason TEXT
+);
+CREATE INDEX IF NOT EXISTS rounds_open ON rounds (status, project, page_url, session);
+CREATE INDEX IF NOT EXISTS rounds_idle ON rounds (status, last_comment_at);
+CREATE TABLE IF NOT EXISTS screenshot_variants (
+  screenshot_id TEXT NOT NULL,
+  variant TEXT NOT NULL,
+  mime TEXT NOT NULL,
+  data TEXT NOT NULL,
+  created_at TEXT NOT NULL,
+  PRIMARY KEY (screenshot_id, variant)
+);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commentbox/server-worker",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "CommentBox server for Cloudflare Workers + D1.",
   "keywords": [
     "commentbox",
@@ -43,8 +43,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@commentbox/widget": "0.1.2",
-    "@commentbox/core": "0.1.2"
+    "@commentbox/core": "0.2.1",
+    "@commentbox/widget": "0.2.1"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20241011.0",

package/src/worker.ts

@@ -1,4 +1,4 @@
-import { configFromEnv, createHandler, createSqlStore, processDeliveries } from '@commentbox/core'
+import { applyRetention, configFromEnv, configWarnings, createHandler, createSqlStore, processDeliveries, processRounds, resolveConfig } from '@commentbox/core'
 
 import { d1Driver } from './d1.js'
 
@@ -12,14 +12,26 @@ export type Env = {
   WEBHOOK_URL?: string
   WEBHOOK_MAX_ATTEMPTS?: string
   WEBHOOK_INTEGRATION?: string
+  WEBHOOK_ALLOW_INSECURE?: string
   // Opt-in install count (off by default; DO_NOT_TRACK=1 always disables). See docs/telemetry.md.
   COMMENTBOX_TELEMETRY?: string
   COMMENTBOX_TELEMETRY_URL?: string
   DO_NOT_TRACK?: string
+  // Comment rounds and the Donna integration (opt-in). See integrations/donna/README.md.
+  COMMENTBOX_ROUNDS?: string
+  COMMENTBOX_DONNA?: string
+  COMMENTBOX_ROUND_IDLE_MINUTES?: string
+  COMMENTBOX_ROUND_MAX_COMMENTS?: string
+  // Limits for public demos.
+  MAX_COMMENT_LENGTH?: string
+  MAX_SCREENSHOT_BYTES?: string
+  RETENTION_HOURS?: string
   // Secrets (wrangler secret put …):
   ADMIN_TOKEN?: string
   WEBHOOK_SECRET?: string
   WEBHOOK_BEARER_TOKEN?: string
+  // Extra header on every delivery, `Header-Name: value` (e.g. `X-Api-Key: abc`). A secret: wrangler secret put.
+  WEBHOOK_AUTH_HEADER?: string
 }
 
 /** Worker entry, without the widget import so tests can run it against a fake D1. */
@@ -30,6 +42,8 @@ export function createWorker(widgetJs?: string) {
     let hit = cache.get(env)
     if (!hit) {
       const store = createSqlStore(d1Driver(env.DB))
+      // Once per isolate, never with secret values.
+      for (const w of configWarnings(env)) console.warn(w)
       hit = { store, handle: createHandler({ store, config: configFromEnv(env), widgetJs }), ready: null }
       cache.set(env, hit)
     }
@@ -40,12 +54,19 @@ export function createWorker(widgetJs?: string) {
     async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
       return get(env).handle(req, { waitUntil: (p) => ctx.waitUntil(p) })
     },
-    /** Cron trigger (every minute): sends webhook retries that are due. */
+    /** Cron trigger (every minute): closes idle comment rounds and sends webhook retries that are due. */
     async scheduled(_event: ScheduledController, env: Env, ctx: ExecutionContext): Promise<void> {
       const hit = get(env)
       hit.ready ??= hit.store.init()
       await hit.ready
-      ctx.waitUntil(processDeliveries(hit.store, configFromEnv(env)))
+      const config = configFromEnv(env)
+      // Idle rounds first (they queue round.closed), then every due delivery, retries included.
+      ctx.waitUntil(
+        processRounds(hit.store, config)
+          .then(() => resolveConfig(hit.store, config))
+          .then((cfg) => processDeliveries(hit.store, cfg))
+          .then(() => applyRetention(hit.store, config)),
+      )
     },
   } satisfies ExportedHandler<Env>
 }

package/wrangler.toml

@@ -2,11 +2,15 @@
 # 1. npx wrangler d1 create commentbox           -> paste the database_id below
 # 2. npx wrangler d1 migrations apply commentbox --remote
 # 3. npx wrangler secret put ADMIN_TOKEN / WEBHOOK_SECRET   (never commit secrets)
+#    Optional secrets: WEBHOOK_BEARER_TOKEN, and WEBHOOK_AUTH_HEADER for an extra header on every delivery,
+#    format "Header-Name: value", e.g. "X-Api-Key: abc" or "Authorization: Bearer abc123" (wins over the bearer token).
 # 4. npx wrangler deploy
 # `npx @commentbox/cli init --origin https://your-site.com --provision` runs these steps for you.
 name = "commentbox"
 main = "src/index.ts"
 compatibility_date = "2024-10-01"
+# nodejs_compat: Buffer for the server-side screenshot highlighter (jpeg-js) used by comment rounds.
+compatibility_flags = ["nodejs_compat"]
 
 [vars]
 # Comma-separated origins allowed to post comments (no trailing slash).
@@ -23,6 +27,10 @@ WEBHOOK_INTEGRATION = "webhook"
 # Opt-in anonymous install count, OFF by default. "1" sends one ping per verified webhook registration
 # (random install id, version, integration, event kind; nothing else). DO_NOT_TRACK = "1" always wins. See docs/telemetry.md.
 COMMENTBOX_TELEMETRY = "0"
+# Comment rounds + Donna review cards (opt-in, off by default). DONNA=1 implies ROUNDS=1 and shows "Send round".
+COMMENTBOX_ROUNDS = "0"
+COMMENTBOX_DONNA = "0"
+COMMENTBOX_ROUND_IDLE_MINUTES = "15"
 # Set when the Worker runs behind a custom domain, e.g. "https://comments.example.com".
 PUBLIC_URL = ""