feat: add lock method to LockRepository for managing room locks with …

[ggazzo]

…disposal functionality

Summary by CodeRabbit

• Refactor

  • Reworked event processing to a streaming model, improving responsiveness and throughput for room updates.
  • Introduced coordinated per-room queueing with distributed locks to avoid contention while preserving safe concurrency.
  • Simplified enqueue path to ensure timely handling of new and backlog events.

• Bug Fixes

  • Reduced race conditions and duplicate processing across instances, lowering chances of stalled or skipped rooms and improving consistency under load.

[coderabbitai]

Walkthrough

The PR converts per-room processing to an async-generator pipeline, moving from Promise-based handlers to streaming iteration. It introduces a lock repository and integrates lock acquisition/updates in the queue processor. EventService now enqueues without acquiring locks. Listener and StagingAreaService adopt generator-based control flow.

Changes

Cohort / File(s)	Summary of changes
Async‑generator processing pipeline packages/federation-sdk/src/listeners/staging-area.listener.ts, packages/federation-sdk/src/services/staging-area.service.ts, packages/federation-sdk/src/queues/staging-area.queue.ts	Listener’s handler becomes an async generator and delegates with yield*. StagingAreaService’s processEventForRoom now yields events in a streaming loop. Queue handler type changes to consume async generators during processing.
Distributed lock repository + queue integration packages/federation-sdk/src/repositories/lock.repository.ts, packages/federation-sdk/src/queues/staging-area.queue.ts	Adds LockRepository.lock(roomId, instanceId) with acquire/update/release via async disposal; implements timed lock acquisition and duplicate-key handling. Queue acquires per-room locks, updates lock on each yielded step, and disposes at completion or skip if unavailable.
Event enqueue flow (locks removed at source) packages/federation-sdk/src/services/event.service.ts	Removes per-room lock acquisition for incoming and startup processing; always enqueues rooms to the staging queue, deferring concurrency control to the queue/lock layer.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Producer as EventSource
  participant EventService
  participant StagingAreaQueue as Queue
  participant LockRepository as LockRepo
  participant StagingAreaService as StagingSvc

  Producer->>EventService: Incoming PDU(s) / startup scan
  EventService->>Queue: enqueue(roomId)

  Note over Queue: Processing loop (per room)
  Queue->>LockRepo: lock(roomId, instanceId)
  alt lock acquired
    LockRepo-->>Queue: { success: true, update(), [asyncDispose]() }
    Queue->>StagingSvc: processEventForRoom(roomId) [async generator]
    loop For each yielded item
      StagingSvc-->>Queue: yield nextStep/undefined
      Queue->>LockRepo: update()
    end
    Queue->>LockRepo: [asyncDispose]() (release)
  else lock not acquired
    LockRepo-->>Queue: { success: false, ... }
    Note over Queue: Skip processing this room
  end

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

• fix: missing events not being processed properly #212 — Also modifies StagingAreaService.processEventForRoom, indicating overlapping or sequential refactors to the same generator-based processing flow.

Poem

A rabbit taps keys in a streaming parade,
Locks click in rhythm as events are played.
Yield by yield, the queue keeps time,
Rooms march singly—no overlap, no crime.
With gentle hops, the backlog thins—
Async winds blow, and processing begins. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title does reference a valid part of the changeset by noting the addition of a lock method to LockRepository, but the trailing ellipsis makes it incomplete and unclear, and it fails to convey the broader refactoring of queue handlers and streaming workflows that are core to this PR. The current phrasing does not fully summarize the main change and leaves readers guessing what comes after the ellipsis.	Please rewrite the title to remove the trailing ellipsis and clearly summarize the PR’s primary focus—such as the shift to async generators for queue handling and the integration of distributed locks—so that it accurately reflects the most important change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/refactor-queue-generators

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9f32b43 and dbb1052.

📒 Files selected for processing (5)

• packages/federation-sdk/src/listeners/staging-area.listener.ts (1 hunks)
• packages/federation-sdk/src/queues/staging-area.queue.ts (2 hunks)
• packages/federation-sdk/src/repositories/lock.repository.ts (1 hunks)
• packages/federation-sdk/src/services/event.service.ts (0 hunks)
• packages/federation-sdk/src/services/staging-area.service.ts (4 hunks)

💤 Files with no reviewable changes (1)

• packages/federation-sdk/src/services/event.service.ts

🧰 Additional context used

🧬 Code graph analysis (2)

packages/federation-sdk/src/queues/staging-area.queue.ts (3)

packages/federation-sdk/src/listeners/staging-area.listener.ts (1)

• singleton (6-21)

packages/federation-sdk/src/repositories/lock.repository.ts (2)

• singleton (10-91)
• lock (19-43)

packages/federation-sdk/src/services/config.service.ts (1)

• ConfigService (74-147)

packages/federation-sdk/src/repositories/lock.repository.ts (2)

packages/room/src/manager/event-wrapper.ts (1)

• roomId (78-80)

packages/federation-sdk/src/services/config.service.ts (1)

• instanceId (104-106)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.86%. Comparing base (9f32b43) to head (dbb1052).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage   81.86%   81.86%           
=======================================
  Files          63       63           
  Lines        4709     4709           
=======================================
  Hits         3855     3855           
  Misses        854      854           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.