feat: Add pg-boss as an alternative queue provider #4619
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces pg-boss as an optional alternative to Redis for background job and queue processing in FlowiseAI.
Key changes:
- Added `pg-boss` as a dependency.
- Created `PgBossQueue`, `PgBossPredictionQueue`, and `PgBossUpsertQueue` classes to implement queue functionality using pg-boss.
- Updated `QueueManager` to conditionally initialize Redis-based queues or pg-boss queues based on the `QUEUE_PROVIDER` environment variable.
- If `QUEUE_PROVIDER` is set to `pgboss`, the system will use the PostgreSQL connection details from the existing database configuration (`DATABASE_TYPE`, `DATABASE_HOST`, etc.) or a specific `PG_BOSS_DATABASE_URL`.
- If `redis` (default), the existing BullMQ/Redis implementation is used.
- BullBoard setup is skipped when pg-boss is the selected provider, as BullBoard is BullMQ-specific.
- Added documentation for the new `QUEUE_PROVIDER` environment variable in `CONTRIBUTING.md`.
This change provides you with the flexibility to leverage your existing PostgreSQL databases for FlowiseAI's background tasks, potentially reducing operational overhead and simplifying deployments, especially for those already using PostgreSQL.
Note: Server-Sent Events (SSE) for real-time updates on predictions are currently tied to the Redis implementation (`RedisEventPublisher`) and will not work if `pg-boss` is selected. Future work may involve implementing a pg-boss compatible SSE mechanism (e.g., using `pg_notify`).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduces pg-boss as an optional alternative to Redis for background job and queue processing in FlowiseAI.
Key changes:
pg-bossas a dependency.PgBossQueue,PgBossPredictionQueue, andPgBossUpsertQueueclasses to implement queue functionality using pg-boss.QueueManagerto conditionally initialize Redis-based queues or pg-boss queues based on theQUEUE_PROVIDERenvironment variable.QUEUE_PROVIDERis set topgboss, the system will use the PostgreSQL connection details from the existing database configuration (DATABASE_TYPE,DATABASE_HOST, etc.) or a specificPG_BOSS_DATABASE_URL.redis(default), the existing BullMQ/Redis implementation is used.QUEUE_PROVIDERenvironment variable inCONTRIBUTING.md.This change provides you with the flexibility to leverage your existing PostgreSQL databases for FlowiseAI's background tasks, potentially reducing operational overhead and simplifying deployments, especially for those already using PostgreSQL.
Note: Server-Sent Events (SSE) for real-time updates on predictions are currently tied to the Redis implementation (
RedisEventPublisher) and will not work ifpg-bossis selected. Future work may involve implementing a pg-boss compatible SSE mechanism (e.g., usingpg_notify).