From 3d28289b529f13f557fc46c145ca29a04095bdd6 Mon Sep 17 00:00:00 2001
From: Danny Avila <danny@librechat.ai>
Date: Fri, 12 Dec 2025 02:40:34 -0500
Subject: [PATCH] refactor: Update GenerationJobManager documentation and
 structure

- Enhanced the documentation for GenerationJobManager to clarify the architecture and pluggable service design.
- Updated comments to reflect the potential for Redis integration and the need for async refactoring.
- Improved the structure of the GenerationJob facade to emphasize the unified API while allowing for implementation swapping without affecting consumer code.
---
 .../api/src/stream/GenerationJobManager.ts    | 33 +++++++++++++++----
 1 file changed, 26 insertions(+), 7 deletions(-)

diff --git a/packages/api/src/stream/GenerationJobManager.ts b/packages/api/src/stream/GenerationJobManager.ts
index 71c13a941c..9d5aa28497 100644
--- a/packages/api/src/stream/GenerationJobManager.ts
+++ b/packages/api/src/stream/GenerationJobManager.ts
@@ -33,14 +33,30 @@ interface RuntimeJobState {
 
 /**
  * Manages generation jobs for resumable LLM streams.
- * Composes three implementations for clean separation of concerns:
- * - InMemoryJobStore: Serializable job metadata (swappable for Redis)
- * - InMemoryEventTransport: Pub/sub events (swappable for Redis Pub/Sub)
- * - InMemoryContentState: Volatile content refs with WeakRef (always in-memory)
+ *
+ * Architecture: Composes three pluggable services for clean separation:
+ * - jobStore: Serializable job metadata (InMemory → Redis/KV for horizontal scaling)
+ * - eventTransport: Pub/sub events (InMemory → Redis Pub/Sub for horizontal scaling)
+ * - contentState: Volatile content refs with WeakRef (always in-memory, not shared)
+ *
+ * Current implementation uses sync methods for performance. When adding Redis support,
+ * the manager methods will need to become async, or use a sync-capable Redis client.
+ *
+ * @example Future Redis injection (requires async refactor):
+ * ```ts
+ * const manager = new GenerationJobManagerClass({
+ *   jobStore: new RedisJobStore(redisClient),
+ *   eventTransport: new RedisPubSubTransport(redisClient),
+ *   contentState: new InMemoryContentState(), // Always local
+ * });
+ * ```
  */
 class GenerationJobManagerClass {
+  /** Job metadata storage - swappable for Redis, KV store, etc. */
   private jobStore: InMemoryJobStore;
+  /** Event pub/sub transport - swappable for Redis Pub/Sub, etc. */
   private eventTransport: InMemoryEventTransport;
+  /** Volatile content state with WeakRef - always in-memory per instance */
   private contentState: InMemoryContentState;
 
   /** Runtime state - always in-memory, not serializable */
@@ -146,9 +162,12 @@ class GenerationJobManagerClass {
   }
 
   /**
-   * Build a GenerationJob facade from job data and runtime state.
-   * This maintains backwards compatibility with existing code that expects
-   * job.emitter, job.abortController, etc.
+   * Build a GenerationJob facade from composed services.
+   *
+   * This facade provides a unified API (job.emitter, job.abortController, etc.)
+   * while internally delegating to the injected services (jobStore, eventTransport,
+   * contentState). This allows swapping implementations (e.g., Redis) without
+   * changing consumer code.
    *
    * IMPORTANT: The emitterProxy.on('allSubscribersLeft') handler registration
    * does NOT use eventTransport.subscribe(). This is intentional: