Files
hyprcrd/relay/inc/routes/collab-locks.php
T
thandClaude Opus 4.6 f6cf7b4358 collab-buckets: exclusive locks, server-enforced, with editor takeover
The previous lock implementation was advisory only — the relay's lock
table PK was (bucket_uid, card_uid, holder_id), so multiple users could
"hold" the same card simultaneously and the plugin only used the locks
to draw a small badge. Concurrent writers raced through LWW, and an
unsaved editor on User A could be silently overwritten when User B
saved (the symptom: cards appearing to "disappear" from User A's view
once their version was clobbered by an LWW pull).

Now an exclusive, server-enforced lock:

* relay schema: collab_card_locks PK is (bucket_uid, card_uid). One
  lock per card. Migration drops the old 3-column-PK table on the
  next bootstrap (locks are 60s ephemeral, no data to preserve).
* /api/collab-locks POST: returns 409 + holder info when another
  tenant already holds it. Same holder refreshes the TTL.
* /api/collab-cards POST/DELETE: refuse with 423 + locked_by when a
  foreign tenant holds the lock. The plugin's local edit is preserved
  — the push just stays queued and retries on the next poll until
  the lock expires or is released. Tombstones are gated the same way
  so a card can't be deleted under the holder's editor.
* Plugin push phase: tracks blocked count + holder names, surfaces
  them in the poll response so the frontend can toast the user.

Frontend lock-on-first-keystroke flow:

* The lock is no longer acquired on editor-open — opening for read
  doesn't lock anything. On the FIRST input event in #inp-title or
  #editor-body the plugin tries to acquire. On success, heartbeat
  every 30 s; on 409, immediately enter editor takeover.
* Takeover mode: title + body inputs disabled, all three save
  buttons get a capture-phase click blocker (stopImmediatePropagation
  to defeat the editor's own listener), a window-level capture-phase
  keydown blocker swallows Ctrl/Cmd+S (app.js binds save directly to
  the shortcut, bypassing the buttons), and a banner inside the
  modal explains the situation. The user can still copy their
  unsaved text out before closing.
* If a foreign lock arrives via the regular poll while the editor is
  already open on that card, the same takeover engages mid-session.
* Opening the editor on a card whose lock is *already* known to be
  foreign starts in takeover mode without arming the input listeners
  at all.
* Self-detection: poll response now carries `self` (the relay
  username), cached as window._collabSelf, so we don't take ourselves
  over and the board decoration ignores our own lock.

Visual:

* Board cards held by a foreign lock now get a frosted overlay +
  centered lock icon + holder name (replaces the small corner badge).
* Editor takeover banner uses the danger accent. Save buttons get a
  .collab-save-blocked dim style.
* New `.collab-lock-toast` variant of the existing conflict toast,
  used for both "your push is queued because X is editing" and
  "this card just got locked by X" notifications.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 19:36:57 +02:00

100 lines
5.2 KiB
PHP

<?php
// Collab card lock routes (Phase 4 — advisory edit locks):
// POST /api/collab-locks acquire/refresh a lock
// DELETE /api/collab-locks/{bucket}/{card} release own lock
// GET /api/collab-locks list locks visible to caller
//
// Membership is enforced on every operation. A lock refresh just extends
// the TTL (60 seconds from now). Expired rows are pruned on every request
// via bootstrap.php cleanup, so the GET list never contains stale locks.
if (!defined('RELAY_BOOTSTRAPPED')) { http_response_code(404); exit; }
$clientTenant = $clientTenant ?? authClient($db);
function collabLocksIsMember(PDO $db, string $bucketUid, int $tenantId): bool {
$stmt = $db->prepare('SELECT 1 FROM collab_bucket_members WHERE bucket_uid = :b AND tenant_id = :t');
$stmt->execute(['b' => $bucketUid, 't' => $tenantId]);
return (bool)$stmt->fetchColumn();
}
// ── POST: acquire/refresh ────────────────────────────────────────
if ($route === '/api/collab-locks' && $method === 'POST') {
if (!$clientTenant) jsonResponse(['error' => 'unauthorized'], 401);
if (isRateLimited($db, 'collab-locks-post', 240)) jsonResponse(['error' => 'rate limited'], 429);
$input = json_decode(file_get_contents('php://input'), true) ?: [];
$bucketUid = trim((string)($input['bucket_uid'] ?? ''));
$cardUid = trim((string)($input['card_uid'] ?? ''));
if ($bucketUid === '' || $cardUid === '') jsonResponse(['error' => 'bucket_uid and card_uid required'], 400);
if (!collabLocksIsMember($db, $bucketUid, (int)$clientTenant['id'])) {
jsonResponse(['error' => 'not a member of this bucket'], 403);
}
// Drop expired before checking — bootstrap cleanup runs every request
// but this protects against a stale lock blocking acquisition in the
// narrow window between cleanup and this query.
$db->prepare("DELETE FROM collab_card_locks WHERE bucket_uid = :b AND card_uid = :c AND expires_at <= datetime('now')")
->execute(['b' => $bucketUid, 'c' => $cardUid]);
// Existing live lock? If a different tenant holds it, refuse.
$cur = $db->prepare('SELECT holder_id, holder_username, expires_at FROM collab_card_locks WHERE bucket_uid = :b AND card_uid = :c');
$cur->execute(['b' => $bucketUid, 'c' => $cardUid]);
$existing = $cur->fetch();
if ($existing && (int)$existing['holder_id'] !== (int)$clientTenant['id']) {
jsonResponse([
'error' => 'card is being edited by ' . $existing['holder_username'],
'locked_by' => $existing['holder_username'],
'locked_by_id' => (int)$existing['holder_id'],
'expires_at' => $existing['expires_at'],
], 409);
}
// Acquire / refresh — same holder bumps the expiry
$db->prepare("
INSERT INTO collab_card_locks (bucket_uid, card_uid, holder_id, holder_username, acquired_at, expires_at)
VALUES (:b, :c, :hid, :hu, datetime('now'), datetime('now', '+60 seconds'))
ON CONFLICT(bucket_uid, card_uid) DO UPDATE SET
holder_id = excluded.holder_id,
holder_username = excluded.holder_username,
expires_at = excluded.expires_at
")->execute([
'b' => $bucketUid,
'c' => $cardUid,
'hid' => $clientTenant['id'],
'hu' => $clientTenant['username'],
]);
jsonResponse([
'ok' => true,
'holder_id' => (int)$clientTenant['id'],
'expires_at' => (string)$db->query("SELECT datetime('now', '+60 seconds')")->fetchColumn(),
]);
}
// ── DELETE: release own lock ─────────────────────────────────────
if (preg_match('#^/api/collab-locks/([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$#', $route, $m) && $method === 'DELETE') {
if (!$clientTenant) jsonResponse(['error' => 'unauthorized'], 401);
$bucketUid = $m[1];
$cardUid = $m[2];
$db->prepare('DELETE FROM collab_card_locks WHERE bucket_uid = :b AND card_uid = :c AND holder_id = :h')
->execute(['b' => $bucketUid, 'c' => $cardUid, 'h' => $clientTenant['id']]);
jsonResponse(['ok' => true]);
}
// ── GET: list locks visible to caller ────────────────────────────
if ($route === '/api/collab-locks' && $method === 'GET') {
if (!$clientTenant) jsonResponse(['error' => 'unauthorized'], 401);
if (isRateLimited($db, 'collab-locks-get', 120)) jsonResponse(['error' => 'rate limited'], 429);
// Only return locks in buckets the caller is currently a member of,
// and only non-expired rows (bootstrap cleanup + defensive filter).
$stmt = $db->prepare("
SELECT l.bucket_uid, l.card_uid, l.holder_id, l.holder_username, l.acquired_at, l.expires_at
FROM collab_card_locks l
INNER JOIN collab_bucket_members m ON m.bucket_uid = l.bucket_uid
WHERE m.tenant_id = :tid
AND l.expires_at > datetime('now')
ORDER BY l.acquired_at DESC
");
$stmt->execute(['tid' => $clientTenant['id']]);
jsonResponse(['ok' => true, 'locks' => $stmt->fetchAll()]);
}