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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ignore hook when disable #702

Merged
merged 1 commit into from
Jul 11, 2024
Merged

fix: ignore hook when disable #702

merged 1 commit into from
Jul 11, 2024

Conversation

elrrrrrrr
Copy link
Member

@elrrrrrrr elrrrrrrr commented Jul 11, 2024

Currently, triggerHookWorkerMaxConcurrentTasks is 10 by defualt, which can lead to some redis queries even hookEnable is not activated.

  • ♻️ Follow CreateTriggerHookWorker, when hookEnable is not activated, do not query task queue.

目前 triggerHookWorkerMaxConcurrentTasks 默认为 10,在未开启 hookEnable 时会带来一些冗余的 redis 查询

  • ♻️ 参照 CreateTriggerHookWorker 逻辑,hookEnable 关闭时,不进行存量任务轮训

Summary by CodeRabbit

  • Bug Fixes
    • Added a check to ensure hooks are enabled before proceeding, improving reliability and preventing errors when hooks are disabled.

@elrrrrrrr elrrrrrrr added the bug Something isn't working label Jul 11, 2024
Copy link
Contributor

coderabbitai bot commented Jul 11, 2024

Walkthrough

A conditional check has been added to the subscribe method in the TriggerHookWorker class to ensure that the hookEnable configuration parameter is set to true before executing further logic. This update is aimed at enhancing the control flow by preventing the method from proceeding when the hook functionality is disabled.

Changes

File Path Change Summary
app/port/schedule/TriggerHookWorker.ts Added a check for this.config.cnpmcore.hookEnable in subscribe method to ensure hooks are enabled before processing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TriggerHookWorker
    participant Config

    User ->> TriggerHookWorker: subscribe()
    TriggerHookWorker ->> Config: this.config.cnpmcore.hookEnable
    alt hookEnable is true
        TriggerHookWorker ->> TriggerHookWorker: Proceed with subscription logic
    else hookEnable is false
        TriggerHookWorker ->> TriggerHookWorker: Skip subscription logic
    end
Loading

Poem

In code's vast realm, a check we weave,
Ensuring hooks are right to leave.
With logic clear and bugs held tight,
Our TriggerHookWorker shines so bright.
Enabled paths, we now construe,
For flawless runs, our goal in view.
🌟💻✨


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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

codecov bot commented Jul 11, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.81%. Comparing base (ca6ce4e) to head (0e4121e).
Report is 1 commits behind head on master.

Files Patch % Lines
app/port/schedule/TriggerHookWorker.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #702      +/-   ##
==========================================
- Coverage   96.81%   96.81%   -0.01%     
==========================================
  Files         181      181              
  Lines       18002    18003       +1     
  Branches     2337     2338       +1     
==========================================
  Hits        17429    17429              
- Misses        573      574       +1     

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

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 381a10c and 0e4121e.

Files selected for processing (1)
  • app/port/schedule/TriggerHookWorker.ts (1 hunks)
Additional comments not posted (1)
app/port/schedule/TriggerHookWorker.ts (1)

30-30: LGTM! Ensure configuration is used correctly across the codebase.

The added conditional check to verify this.config.cnpmcore.hookEnable is a necessary improvement to prevent redundant Redis queries when hookEnable is disabled.

However, verify that this configuration (hookEnable) is correctly set and used across the codebase.

Verification successful

Configuration usage verified successfully.

The hookEnable configuration is correctly set and consistently used across the codebase. The configuration is defined in config/config.default.ts and utilized in multiple files, including tests, ensuring its functionality is well-covered.

  • config/config.default.ts: hookEnable is set to false.
  • app/port/config.ts: hookEnable is defined as a boolean.
  • app/port/schedule/TriggerHookWorker.ts: The new conditional check using hookEnable.
  • app/port/schedule/CreateTriggerHookWorker.ts: Uses hookEnable.
  • app/core/event/ChangesStream.ts: Multiple checks for hookEnable.
  • test/core/event/ChangesStream.test.ts: Tests for hookEnable.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `hookEnable` configuration across the codebase.

# Test: Search for the configuration usage. Expect: Consistent usage of `hookEnable`.
rg --type typescript 'hookEnable'

Length of output: 68


Script:

#!/bin/bash
# Description: Verify the usage of `hookEnable` configuration across the codebase.

# Test: Search for the configuration usage. Expect: Consistent usage of `hookEnable`.
rg --type ts 'hookEnable'

Length of output: 1146

@fengmk2 fengmk2 merged commit bd49917 into master Jul 11, 2024
12 of 13 checks passed
@fengmk2 fengmk2 deleted the ignore-hook-when-disable branch July 11, 2024 13:26
fengmk2 pushed a commit that referenced this pull request Jul 11, 2024
[skip ci]

## [3.61.6](v3.61.5...v3.61.6) (2024-07-11)

### Bug Fixes

* ignore hook when disable ([#702](#702)) ([bd49917](bd49917))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants