fix(controlplane): introduced abstract classes to improve workers & queue #2019
Conversation
…ueue - Replaced individual worker and queue interfaces with abstract base classes for better code reuse and maintainability. - Updated worker and queue classes to extend from the new base abstract classes, simplifying their constructors and error handling and log managements. - Removed deprecated worker creation functions in favor of the new base worker & queue pattern. - Adjusted imports and cleaned up unused code across multiple worker files.
fahimfaisaal
requested review from
JivusAyrus,
StarpTech and
wilsonrivera
as code owners
WalkthroughIntroduces BaseQueue and BaseWorker classes, removes IQueue/IWorker interfaces and factory-style worker creators, migrates existing queue/worker modules to class-based implementations with .create(), adds DeleteOrganizationAuditLogs and ReactivateOrganization modules, and updates imports/bootstrapping and CLI scripts accordingly. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🧠 Learnings (2)📚 Learning: 2025-08-29T10:28:04.846ZApplied to files:
📚 Learning: 2025-11-20T14:54:43.904ZApplied to files:
🧬 Code graph analysis (1)controlplane/src/core/build-server.ts (5)
🔇 Additional comments (2)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
controlplane/src/core/workers/base/Queue.ts (1)
18-18: Remove trailing whitespaceLine 18 has trailing whitespace that should be removed.
- }, -}; - + }, +}; +controlplane/src/core/workers/DeleteOrganizationAuditLogsWorker.ts (1)
50-63: Use consistent logger instanceConsider using the BaseWorker's child logger for consistency, as it includes worker context.
} catch (err) { - this.input.logger.error( + this.logger.error( { jobId: job.id, organizationId: job.data.organizationId, err }, 'Failed to delete audit logs for organization', ); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
controlplane/src/core/build-server.ts(3 hunks)controlplane/src/core/workers/AIGraphReadmeWorker.ts(4 hunks)controlplane/src/core/workers/CacheWarmerWorker.ts(3 hunks)controlplane/src/core/workers/DeactivateOrganizationWorker.ts(3 hunks)controlplane/src/core/workers/DeleteOrganizationAuditLogsWorker.ts(3 hunks)controlplane/src/core/workers/DeleteOrganizationWorker.ts(5 hunks)controlplane/src/core/workers/DeleteUserQueue.ts(5 hunks)controlplane/src/core/workers/ReactivateOrganizationWorker.ts(3 hunks)controlplane/src/core/workers/Worker.ts(0 hunks)controlplane/src/core/workers/base/Queue.ts(1 hunks)controlplane/src/core/workers/base/Worker.ts(1 hunks)controlplane/src/core/workers/base/index.ts(1 hunks)
💤 Files with no reviewable changes (1)
- controlplane/src/core/workers/Worker.ts
🧰 Additional context used
🧬 Code Graph Analysis (1)
controlplane/src/core/workers/ReactivateOrganizationWorker.ts (1)
controlplane/src/core/workers/DeleteOrganizationWorker.ts (1)
DeleteOrganizationQueue(20-39)
🔇 Additional comments (20)
controlplane/src/core/workers/base/index.ts (1)
1-2: Clean barrel export pattern!The module correctly provides a single entry point for the base classes.
controlplane/src/core/workers/base/Worker.ts (1)
14-26: Well-structured worker lifecycle managementThe create method properly initializes the BullMQ worker with appropriate event handlers for monitoring and debugging.
controlplane/src/core/workers/base/Queue.ts (1)
5-17: Production-ready job configuration defaultsThe default job options provide excellent balance between reliability (6 retry attempts with exponential backoff) and resource management (90-day retention).
controlplane/src/core/workers/DeleteOrganizationAuditLogsWorker.ts (1)
15-34: Clean queue implementation with proper job deduplicationThe queue correctly extends BaseQueue and uses organizationId as jobId to prevent duplicate jobs per organization.
controlplane/src/core/build-server.ts (1)
314-375: Consistent worker instantiation pattern successfully implementedAll workers now follow the standardized pattern of class instantiation followed by
.create()method call, with proper lifecycle management through thebullWorkersarray.controlplane/src/core/workers/DeleteOrganizationWorker.ts (3)
1-1: Imports look goodThe import of
ConnectionOptions, Job, JobsOptionsfrombullmqis appropriate for the refactored implementation.
20-23: Queue constructor implementation is correctThe constructor properly delegates to the base class with the required parameters.
53-56: Worker constructor properly delegates to base classThe constructor correctly passes all required parameters to the base class constructor, including the concurrency setting of 10.
controlplane/src/core/workers/AIGraphReadmeWorker.ts (2)
21-34: Queue constructor with custom job options is well-structuredThe constructor properly configures default job options including retry logic with exponential backoff, which is a good practice for AI-related operations that might be rate-limited.
69-77: Worker initialization maintains proper separation of concernsThe constructor correctly delegates to the base class while maintaining the OpenAI client initialization, preserving the original functionality.
controlplane/src/core/workers/CacheWarmerWorker.ts (2)
22-27: Queue constructor follows standard patternThe constructor properly delegates to the base class with the minimal required configuration.
60-63: Worker constructor correctly configuredThe constructor properly passes all parameters to the base class with appropriate concurrency settings.
controlplane/src/core/workers/ReactivateOrganizationWorker.ts (2)
6-6: Cross-worker dependency is appropriateThe import of
DeleteOrganizationQueuefrom another worker file is valid and maintains proper separation of concerns.
47-50: Worker constructor maintains consistencyThe constructor follows the same pattern as other workers with identical concurrency settings, ensuring consistent behavior across the worker pool.
controlplane/src/core/workers/DeleteUserQueue.ts (3)
24-24: Queue constructor is consistent with other implementationsThe constructor follows the established pattern for base class delegation.
56-59: Worker configuration aligns with other workersThe constructor maintains consistency with the concurrency setting of 10, matching all other refactored workers.
43-105: Excellent refactoring to reduce code duplicationThis refactoring successfully achieves the PR objectives by:
- Eliminating 30-40 lines of boilerplate code per worker
- Standardizing error handling and logging through base classes
- Maintaining type safety with generics
- Ensuring consistent concurrency settings across all workers
The implementation aligns perfectly with the template pattern, allowing workers to focus solely on their business logic.
controlplane/src/core/workers/DeactivateOrganizationWorker.ts (3)
1-1: Clean import refactoring!The import changes correctly reflect the move to base classes while retaining necessary BullMQ types.
Also applies to: 8-8
19-22: Excellent refactoring to extend BaseQueue!The constructor correctly delegates to the base class, eliminating boilerplate code while maintaining type safety through generics.
41-56: Well-structured worker refactoring with centralized configuration!The constructor properly extends BaseWorker and consolidates all dependencies into a single input object. This aligns perfectly with the PR's goal of reducing boilerplate.
Please verify that the concurrency setting of 10 is appropriate for deactivation operations. Consider if this could lead to race conditions or excessive load on dependent services (Keycloak, database).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
controlplane/src/core/workers/base/Queue.ts (2)
12-16: Consider reducing the initial backoff delay.The exponential backoff delay of 112 seconds (112,000ms) seems quite high for the initial retry attempt. Typically, exponential backoff starts with a smaller delay (e.g., 1-10 seconds) to allow for faster recovery from transient failures.
Consider adjusting the delay:
backoff: { type: 'exponential', - delay: 112_000, + delay: 2_000, // Start with 2 seconds },
41-45: Consider improving type safety in Job type parameters.The abstract method signatures use
anytypes in the Job type parameters (Job<T, any, string>), which reduces type safety. Consider using more specific types or generics for better compile-time checking.For example, you could introduce additional generic parameters:
- public abstract addJob(job: T, opts?: Omit<JobsOptions, 'jobId'>): Promise<Job<T, any, string> | undefined>; + public abstract addJob(job: T, opts?: Omit<JobsOptions, 'jobId'>): Promise<Job<T, unknown, string> | undefined>; - public abstract getJob(job: T): Promise<Job<T, any, string> | undefined>; + public abstract getJob(job: T): Promise<Job<T, unknown, string> | undefined>;Or introduce a generic for the result type if it's known by concrete implementations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
controlplane/src/core/workers/DeleteOrganizationWorker.ts(5 hunks)controlplane/src/core/workers/base/Queue.ts(1 hunks)controlplane/src/core/workers/base/Worker.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- controlplane/src/core/workers/base/Worker.ts
- controlplane/src/core/workers/DeleteOrganizationWorker.ts
🔇 Additional comments (3)
controlplane/src/core/workers/base/Queue.ts (3)
1-2: LGTM - Clean imports.The imports are well-structured and include the necessary dependencies for queue management and logging.
18-23: LGTM - Well-structured type definition.The
BaseQueueParamstype is properly defined with appropriate required and optional properties.
25-39: LGTM - Excellent abstract class design.The constructor properly initializes the queue and logger with contextual information, and the error handling setup ensures consistent logging across all queue implementations. This design effectively centralizes common queue functionality.
|
Hi @fahimfaisaal, thanks for the PR. That looks like a useful refactor. We're gonna take a look soon. |
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
controlplane/src/core/workers/DeleteUser.ts (1)
27-41: Add validation for userId before using as jobId.The methods use
job.userIdas the job identifier without validation. Consider adding a check to ensure userId is defined and valid.public addJob(job: DeleteUserInput, opts?: Omit<JobsOptions, 'jobId'>) { + if (!job.userId) { + throw new Error('userId is required for job identification'); + } return this.queue.add(job.userId, job, { ...opts, jobId: job.userId, }); } public removeJob(job: DeleteUserInput) { + if (!job.userId) { + throw new Error('userId is required for job identification'); + } return this.queue.remove(job.userId); } public getJob(job: DeleteUserInput) { + if (!job.userId) { + throw new Error('userId is required for job identification'); + } return this.queue.getJob(job.userId); }
🧹 Nitpick comments (3)
controlplane/src/core/workers/ReactivateOrganization.ts (1)
38-47: Consider making concurrency configurable.The worker class refactoring looks good overall. However, the concurrency is hardcoded to
10which reduces flexibility.Consider accepting concurrency as a constructor parameter:
export class ReactivateOrganizationWorker extends BaseWorker<ReactivateOrganizationInput> { constructor( private input: { redisConnection: ConnectionOptions; db: PostgresJsDatabase<typeof schema>; logger: pino.Logger; deleteOrganizationQueue: DeleteOrganizationQueue; + concurrency?: number; }, ) { - super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: 10 }, input.logger); + super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: input.concurrency ?? 10 }, input.logger); }controlplane/src/core/workers/CacheWarmer.ts (1)
49-61: Consider making concurrency configurable.The worker refactoring looks good and properly extends
BaseWorker. However, the concurrency value is hardcoded to10.Consider making concurrency configurable to allow performance tuning across different deployments:
export class CacheWarmerWorker extends BaseWorker<CacheWarmerInput> { constructor( private input: { redisConnection: ConnectionOptions; db: PostgresJsDatabase<typeof schema>; logger: pino.Logger; chClient: ClickHouseClient | undefined; blobStorage: BlobStorage; cacheWarmerQueue: CacheWarmerQueue; + concurrency?: number; }, ) { - super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: 10 }, input.logger); + super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: input.concurrency ?? 10 }, input.logger); }controlplane/src/core/workers/DeleteUser.ts (1)
56-56: Consider making concurrency configurable.The concurrency is hardcoded to 10. Consider making this configurable through the input parameters for better flexibility across different environments.
private input: { db: PostgresJsDatabase<typeof schema>; redisConnection: ConnectionOptions; logger: pino.Logger; keycloakClient: Keycloak; keycloakRealm: string; blobStorage: BlobStorage; platformWebhooks: PlatformWebhookService; deleteOrganizationAuditLogsQueue: DeleteOrganizationAuditLogsQueue; + concurrency?: number; }, ) { - super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: 10 }, input.logger); + super(WorkerName, QueueName, { connection: input.redisConnection, concurrency: input.concurrency ?? 10 }, input.logger); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
controlplane/src/bin/deactivate-org.ts(1 hunks)controlplane/src/bin/delete-user.ts(1 hunks)controlplane/src/bin/reactivate-org.ts(1 hunks)controlplane/src/core/build-server.ts(3 hunks)controlplane/src/core/repositories/OrganizationRepository.ts(1 hunks)controlplane/src/core/repositories/UserRepository.ts(1 hunks)controlplane/src/core/routes.ts(1 hunks)controlplane/src/core/workers/AIGraphReadme.ts(5 hunks)controlplane/src/core/workers/CacheWarmer.ts(3 hunks)controlplane/src/core/workers/DeactivateOrganization.ts(3 hunks)controlplane/src/core/workers/DeleteOrganization.ts(5 hunks)controlplane/src/core/workers/DeleteOrganizationAuditLogs.ts(1 hunks)controlplane/src/core/workers/DeleteUser.ts(5 hunks)controlplane/src/core/workers/ReactivateOrganization.ts(3 hunks)
✅ Files skipped from review due to trivial changes (6)
- controlplane/src/bin/deactivate-org.ts
- controlplane/src/core/repositories/UserRepository.ts
- controlplane/src/bin/delete-user.ts
- controlplane/src/bin/reactivate-org.ts
- controlplane/src/core/routes.ts
- controlplane/src/core/repositories/OrganizationRepository.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- controlplane/src/core/build-server.ts
🧰 Additional context used
🧬 Code Graph Analysis (2)
controlplane/src/core/workers/ReactivateOrganization.ts (1)
controlplane/src/core/workers/DeleteOrganization.ts (1)
DeleteOrganizationQueue(20-39)
controlplane/src/core/workers/DeactivateOrganization.ts (2)
controlplane/src/core/services/Keycloak.ts (1)
Keycloak(8-431)controlplane/src/core/workers/DeleteOrganization.ts (1)
DeleteOrganizationQueue(20-39)
🔇 Additional comments (25)
controlplane/src/core/workers/DeleteOrganization.ts (4)
1-1: Import statements look correct.The imports properly include the necessary BullMQ types and the new base classes from the refactored architecture.
Also applies to: 10-11
20-39: Queue class refactoring is well-implemented.The
DeleteOrganizationQueueclass correctly extendsBaseQueue<DeleteOrganizationInput>with proper generic typing. The constructor appropriately delegates to the base class with the required configuration parameters, and all public methods maintain their original functionality.
41-54: Worker class constructor follows proper template pattern.The
DeleteOrganizationWorkerclass correctly extendsBaseWorker<DeleteOrganizationInput>and the constructor properly delegates to the base class with all required parameters (worker name, queue name, options, and logger). The concurrency setting of 10 is preserved from the original implementation.
56-110: Handler method refactoring maintains functionality with proper encapsulation.The handler method visibility change from
publictoprotectedis appropriate for the template pattern, as the base class will manage the public interface. The method signature correctly uses the generic typeJob<DeleteOrganizationInput>, and all business logic including error handling is preserved intact.controlplane/src/core/workers/DeactivateOrganization.ts (3)
1-8: Imports are well-organized and appropriate.The imports correctly bring in the new base classes and maintain necessary dependencies.
19-39: Queue implementation follows consistent patterns.The refactored queue class properly extends
BaseQueueand maintains the same public interface. The implementation aligns with other queue implementations likeDeleteOrganizationQueue.
41-86: Worker refactoring maintains functionality while improving structure.The worker class properly extends
BaseWorkerand correctly delegates initialization to the base class. The handler method visibility change toprotectedis appropriate as it enforces proper encapsulation.controlplane/src/core/workers/ReactivateOrganization.ts (3)
1-7: Import changes look good!The imports correctly include the new base classes and the required DeleteOrganizationQueue dependency.
17-36: Queue class refactoring is well implemented!The class correctly extends
BaseQueueand maintains the same public API while delegating queue initialization to the base class.
50-75: Handler method visibility change is appropriate!The change from
publictoprotectedcorrectly implements the template method pattern, where the base class manages the worker lifecycle and calls the handler internally.controlplane/src/core/workers/CacheWarmer.ts (3)
1-1: Imports correctly updated for base class usage.The import changes properly reflect the refactoring to use
BaseQueueandBaseWorkerwhile retaining necessary type imports from bullmq.Also applies to: 9-9
20-27: Clean refactoring to extend BaseQueue.The queue class properly extends
BaseQueue<CacheWarmerInput>and delegates initialization to the base class, aligning with the PR's goal of reducing boilerplate code.
63-63: Appropriate visibility change for template method pattern.Changing the handler to
protectedcorrectly implements the template method pattern where the base class manages the worker lifecycle and calls the handler internally.controlplane/src/core/workers/DeleteOrganizationAuditLogs.ts (4)
1-6: LGTM! Clean imports and proper ES module syntax.The imports are well-organized and follow proper ES module conventions with
.jsextensions. The dependency injection pattern is correctly established through the imported types.
8-9: Good practice using descriptive constants.The queue and worker names are well-defined and follow consistent naming conventions.
11-13: Well-defined interface for job input.The interface is appropriately scoped and provides clear type safety for the worker's input requirements.
15-34: Excellent implementation of the queue class.The queue class effectively leverages the base class architecture with proper generic typing. Using
organizationIdas both the job name andjobIdensures job uniqueness per organization, which is appropriate for this use case.controlplane/src/core/workers/DeleteUser.ts (4)
22-22: Good use of generics for type safety!The refactoring to extend
BaseQueue<DeleteUserInput>properly leverages TypeScript's type system.
23-25: Clean constructor delegation!The simplified constructor properly delegates queue initialization to the base class, reducing boilerplate.
43-47: Consistent refactoring pattern and improved flexibility!The worker class properly extends
BaseWorker<DeleteUserInput>and usesConnectionOptionsfor better flexibility in Redis configuration.
59-59: Correct visibility modifier for template method pattern!Changing the handler method to
protectedproperly encapsulates it within the class hierarchy, ensuring it's only called by the base class.controlplane/src/core/workers/AIGraphReadme.ts (4)
2-2: Clean import refactoring!The imports correctly reflect the new architecture - importing only the necessary types from bullmq while the actual Queue and Worker implementations are now handled by the base classes.
Also applies to: 8-8
58-74: Excellent worker class refactoring!The class properly extends BaseWorker with correct generic type and delegates worker setup to the base class. The concurrency setting (10) is preserved, and the OpenAI GraphQL client initialization is appropriately placed after the base class constructor.
120-136: Appropriate visibility change for the handler method!Changing the handler to
protectedcorrectly implements the template method pattern, ensuring it can only be called by the base class orchestration logic while maintaining proper async/await handling and error propagation.
19-35: Confirmed: BaseQueue exposes thequeueproperty
Theprotected readonly queue: Queue<T>in controlplane/src/core/workers/base/Queue.ts ensures thataddJob,removeJob, andgetJobon AIGraphReadmeQueue will work as intended.All set—no further changes needed.
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
controlplane/src/core/workers/AIGraphReadme.ts(4 hunks)controlplane/src/core/workers/CacheWarmer.ts(3 hunks)controlplane/src/core/workers/DeactivateOrganization.ts(3 hunks)controlplane/src/core/workers/DeleteOrganization.ts(3 hunks)controlplane/src/core/workers/DeleteOrganizationAuditLogs.ts(1 hunks)controlplane/src/core/workers/DeleteUser.ts(4 hunks)controlplane/src/core/workers/ReactivateOrganization.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
- controlplane/src/core/workers/DeleteOrganizationAuditLogs.ts
- controlplane/src/core/workers/DeactivateOrganization.ts
- controlplane/src/core/workers/AIGraphReadme.ts
- controlplane/src/core/workers/CacheWarmer.ts
- controlplane/src/core/workers/DeleteOrganization.ts
- controlplane/src/core/workers/DeleteUser.ts
🔇 Additional comments (1)
controlplane/src/core/workers/ReactivateOrganization.ts (1)
37-74: Well-structured worker implementation following the new base class pattern.The worker implementation correctly extends the BaseWorker class and properly handles errors by logging with context before re-throwing. The use of async/await aligns with the PR's goal of fixing asynchronous handling.
| public removeJob(job: ReactivateOrganizationInput) { | ||
| return this.queue.remove(job.organizationId); | ||
| } | ||
|
|
||
| public getJob(job: ReactivateOrganizationInput) { | ||
| return this.queue.getJob(job.organizationId); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Rename misleading parameter names in removeJob and getJob methods.
The parameter name job in these methods is misleading as it's not a Job instance but rather the input data. This could cause confusion for developers.
- public removeJob(job: ReactivateOrganizationInput) {
- return this.queue.remove(job.organizationId);
+ public removeJob(input: ReactivateOrganizationInput) {
+ return this.queue.remove(input.organizationId);
}
- public getJob(job: ReactivateOrganizationInput) {
- return this.queue.getJob(job.organizationId);
+ public getJob(input: ReactivateOrganizationInput) {
+ return this.queue.getJob(input.organizationId);
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| public removeJob(job: ReactivateOrganizationInput) { | |
| return this.queue.remove(job.organizationId); | |
| } | |
| public getJob(job: ReactivateOrganizationInput) { | |
| return this.queue.getJob(job.organizationId); | |
| } | |
| public removeJob(input: ReactivateOrganizationInput) { | |
| return this.queue.remove(input.organizationId); | |
| } | |
| public getJob(input: ReactivateOrganizationInput) { | |
| return this.queue.getJob(input.organizationId); | |
| } |
🤖 Prompt for AI Agents
In controlplane/src/core/workers/ReactivateOrganization.ts around lines 28 to
34, rename the parameter named 'job' in the removeJob and getJob methods to a
more descriptive name such as 'input' or 'reactivateInput' to accurately reflect
that it is input data, not a Job instance. Update all references to this
parameter within these methods accordingly to avoid confusion.
| protected async handler(job: Job<ReactivateOrganizationInput>) { | ||
| try { | ||
| const orgRepo = new OrganizationRepository(this.input.logger, this.input.db); | ||
|
|
||
| const org = await orgRepo.bySlug(job.data.organizationSlug); | ||
| if (!org) { | ||
| throw new Error('Organization not found'); | ||
| } | ||
|
|
||
| if (org.id !== job.data.organizationId) { | ||
| throw new Error('Id and slug mismatch'); | ||
| } | ||
|
|
||
| await orgRepo.reactivateOrganization({ | ||
| organizationId: job.data.organizationId, | ||
| deleteOrganizationQueue: this.input.deleteOrganizationQueue, | ||
| }); |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify handling of already-active organizations.
The handler doesn't check if the organization is already active before attempting reactivation. Ensure that the reactivateOrganization repository method properly handles this scenario to avoid unnecessary processing or state inconsistencies.
🏁 Script executed:
#!/bin/bash
# Description: Check if the OrganizationRepository.reactivateOrganization method handles already-active organizations
# Search for the reactivateOrganization method implementation
ast-grep --pattern 'reactivateOrganization($_) {
$$$
}'
# Also search with async keyword
ast-grep --pattern 'async reactivateOrganization($_) {
$$$
}'
# Search for any status checks in the implementation
rg -A 10 "reactivateOrganization.*\{" --type tsLength of output: 4280
Add a guard for already-active organizations before reactivation
The reactivateOrganization method in OrganizationRepository always unsets the deactivated fields, even if the org is already active. Add an explicit check on isDeactivated and throw or short-circuit when it’s false to avoid redundant updates or hidden bugs.
• File: controlplane/src/core/repositories/OrganizationRepository.ts
– Before running the UPDATE, fetch the current isDeactivated flag for organizationId.
– If isDeactivated is already false, throw an error (or simply return) to indicate no action is needed.
Suggested diff (inside reactivateOrganization):
public async reactivateOrganization(input: {
organizationId: string;
deleteOrganizationQueue: DeleteOrganizationQueue;
}) {
- await this.db.transaction(async (tx) => {
+ await this.db.transaction(async (tx) => {
+ // Guard: don’t reactivate an already-active organization
+ const current = await tx
+ .select({ isDeactivated: schema.organizations.isDeactivated })
+ .from(schema.organizations)
+ .where({ id: input.organizationId })
+ .first();
+
+ if (current && !current.isDeactivated) {
+ throw new Error('Organization is already active');
+ }
+
await tx
.update(schema.organizations)
.set({
isDeactivated: false,
deactivatedAt: null,
deactivationReason: null,
})
.where({ id: input.organizationId });📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| protected async handler(job: Job<ReactivateOrganizationInput>) { | |
| try { | |
| const orgRepo = new OrganizationRepository(this.input.logger, this.input.db); | |
| const org = await orgRepo.bySlug(job.data.organizationSlug); | |
| if (!org) { | |
| throw new Error('Organization not found'); | |
| } | |
| if (org.id !== job.data.organizationId) { | |
| throw new Error('Id and slug mismatch'); | |
| } | |
| await orgRepo.reactivateOrganization({ | |
| organizationId: job.data.organizationId, | |
| deleteOrganizationQueue: this.input.deleteOrganizationQueue, | |
| }); | |
| // File: controlplane/src/core/repositories/OrganizationRepository.ts | |
| public async reactivateOrganization(input: { | |
| organizationId: string; | |
| deleteOrganizationQueue: DeleteOrganizationQueue; | |
| }) { | |
| await this.db.transaction(async (tx) => { | |
| // Guard: don’t reactivate an already-active organization | |
| const current = await tx | |
| .select({ isDeactivated: schema.organizations.isDeactivated }) | |
| .from(schema.organizations) | |
| .where({ id: input.organizationId }) | |
| .first(); | |
| if (current && !current.isDeactivated) { | |
| throw new Error('Organization is already active'); | |
| } | |
| await tx | |
| .update(schema.organizations) | |
| .set({ | |
| isDeactivated: false, | |
| deactivatedAt: null, | |
| deactivationReason: null, | |
| }) | |
| .where({ id: input.organizationId }); | |
| }); | |
| // …any remaining logic (e.g. enqueueing deleteOrganizationQueue)… | |
| } |
🤖 Prompt for AI Agents
In controlplane/src/core/repositories/OrganizationRepository.ts around the
reactivateOrganization method, add a check before executing the update query to
fetch the current isDeactivated status for the given organizationId. If
isDeactivated is already false, either throw an error or return early to prevent
unnecessary updates and signal that the organization is already active. This
avoids redundant database operations and potential hidden bugs.
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
2 participants
Improvements
Before: Each of the 7+ workers contained 30-40 lines of identical boilerplate code for queue setup, Redis connections, job options, and error handling
After: All common functionality consolidated into BaseQueue and BaseWorker base classes
Impact: Reduced codebase by ~200+ lines of duplicated code, with all configuration centralized in the base classes
Consistent Behavior: All workers now have identical error handling, logging patterns, and job management
Type Safety: Generic base classes (BaseQueue, BaseWorker) provide compile-time type checking
Reduced Human Error: No more copy-paste mistakes when creating new workers
Minimal Implementation: New workers only need to extend base classes and implement the handler method
Plug-and-Play: Consistent constructor patterns and method signatures across all workers
Template Pattern: Clear structure guides developers on how to implement new workers correctly
Example: Adding a new worker now requires ~15 lines instead of ~60 lines
Centralized Updates: Changes to queue behavior, error handling, or job options only need modification in one place
Easier Debugging: Consistent logging and error patterns across all workers
Simplified Testing: Base class functionality can be tested once, reducing test complexity
Code Readability: Worker classes now focus purely on business logic, making them easier to understand and review
Summary by CodeRabbit
Refactor
New Features
Chores
✏️ Tip: You can customize this high-level summary in your review settings.
Checklist