Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: worker stop&start logic #8497

Merged
merged 1 commit into from
May 16, 2024
Merged

fix: worker stop&start logic #8497

merged 1 commit into from
May 16, 2024

Conversation

mertmit
Copy link
Member

@mertmit mertmit commented May 16, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented May 16, 2024

Walkthrough

Walkthrough

This update introduces a new HealthCheck job type in the JobTypes enum and implements a HealthCheckProcessor class to handle these jobs using Bull queues in a NestJS application. The JobsService class has been enhanced to dynamically manage queue pausing and resuming based on an environment variable, ensuring efficient job handling. The toggleQueue() method centralizes this logic, improving maintainability and clarity.

Changes

File Path Change Summary
packages/nocodb/src/interface/Jobs.ts Added HealthCheck to JobTypes enum.
packages/nocodb/src/modules/jobs/jobs/health-check.processor.ts Introduced HealthCheckProcessor class to handle health check jobs, including decorators and methods.
packages/nocodb/src/modules/jobs/redis/jobs.service.ts Refactored JobsService to use toggleQueue() for pausing/resuming queues and updated add() method.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Out of diff range and nitpick comments (2)
packages/nocodb/src/modules/jobs/redis/jobs.service.ts (2)

Line range hint 38-54: Add error handling and improve logging.

Consider adding error handling to the toggleQueue method and improving logging to ensure robustness.

-  async toggleQueue() {
+  async toggleQueue(): Promise<void> {
    try {
      if (process.env.NC_WORKER_CONTAINER === 'false') {
        await this.jobsQueue.pause(true);
        this.logger.log('Queue paused due to NC_WORKER_CONTAINER being false');
      } else if (process.env.NC_WORKER_CONTAINER !== 'true') {
        // resume primary instance queue if there is no worker
        const workerCount = await this.jobsRedisService.workerCount();
        const localWorkerPaused = await this.jobsQueue.isPaused(true);

        // if there is no worker and primary instance queue is paused, resume it
        // if there is any worker and primary instance queue is not paused, pause it
        if (workerCount === 0 && localWorkerPaused) {
          await this.jobsQueue.resume(true);
          this.logger.log('Queue resumed due to no workers');
        } else if (workerCount > 0 && !localWorkerPaused) {
          await this.jobsQueue.pause(true);
          this.logger.log('Queue paused due to active workers');
        }
      }
    } catch (error) {
      this.logger.error('Failed to toggle queue', error);
    }
  }

Line range hint 56-61: Add error handling and improve logging.

Consider adding error handling to the add method and improving logging to ensure robustness.

-  async add(name: string, data: any) {
+  async add(name: string, data: any): Promise<Job> {
    try {
      await this.toggleQueue();
      const job = await this.jobsQueue.add(name, data);
      this.logger.log(`Job added: ${name}`);
      return job;
    } catch (error) {
      this.logger.error(`Failed to add job: ${name}`, error);
      throw error;
    }
  }
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 993ff32 and d221d74.
Files selected for processing (3)
  • packages/nocodb/src/interface/Jobs.ts (1 hunks)
  • packages/nocodb/src/modules/jobs/jobs/health-check.processor.ts (1 hunks)
  • packages/nocodb/src/modules/jobs/redis/jobs.service.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • packages/nocodb/src/interface/Jobs.ts

Comment on lines +13 to +27
async healthCheck() {
const queue = this.jobsService.jobsQueue as Queue;

if (queue) {
queue
.getJobCounts()
.then((stats) => {
// log stats periodically
this.logger.log({ stats });
})
.catch((err) => {
this.logger.error(err);
});
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add type annotations and improve error handling.

Consider adding type annotations to the healthCheck method and improving error handling to ensure robustness.

-  async healthCheck() {
+  async healthCheck(job: Job): Promise<void> {
    const queue = this.jobsService.jobsQueue as Queue;

    if (queue) {
      queue
        .getJobCounts()
        .then((stats) => {
          // log stats periodically
          this.logger.log({ stats });
        })
        .catch((err) => {
          this.logger.error('Failed to get job counts', err);
        });
    } else {
      this.logger.warn('Queue is not available');
    }
  }

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.

Suggested change
async healthCheck() {
const queue = this.jobsService.jobsQueue as Queue;
if (queue) {
queue
.getJobCounts()
.then((stats) => {
// log stats periodically
this.logger.log({ stats });
})
.catch((err) => {
this.logger.error(err);
});
}
}
async healthCheck(job: Job): Promise<void> {
const queue = this.jobsService.jobsQueue as Queue;
if (queue) {
queue
.getJobCounts()
.then((stats) => {
// log stats periodically
this.logger.log({ stats });
})
.catch((err) => {
this.logger.error('Failed to get job counts', err);
});
} else {
this.logger.warn('Queue is not available');
}
}

Copy link
Contributor

github-actions bot commented May 16, 2024

Uffizzi Preview deployment-51816 was deleted.

@dstala dstala merged commit 31a5350 into develop May 16, 2024
19 of 23 checks passed
@dstala dstala deleted the nc-fix/worker-stats branch May 16, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants