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

chore: remove pools shutdown policy #88

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Conversation

rustatian
Copy link
Member

@rustatian rustatian commented Aug 30, 2024

Reason for This PR

ref: roadrunner-server/roadrunner#1986

Description of Changes

  • Since endure v2 we don't need to have a central place to shutdown pools of workers. So every plugin can independently maintain its own pool.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • New Features

    • Enhanced testing configuration to support race condition detection and debugging.
  • Bug Fixes

    • Improved resource management strategy within the plugin, leading to a more streamlined shutdown process.
  • Refactor

    • Simplified the Plugin struct by removing the pools slice and adjusting the Stop method signature.

@rustatian rustatian added the enhancement New feature or request label Aug 30, 2024
@rustatian rustatian requested a review from wolfy-j August 30, 2024 11:06
@rustatian rustatian self-assigned this Aug 30, 2024
Copy link

coderabbitai bot commented Aug 30, 2024

Walkthrough

The changes involve modifications to the .golangci.yml file, the Makefile, and the plugin.go file. The linter configuration has been updated by replacing exportloopref with copyloopvar. The Makefile target has been renamed from testpkg to test, with adjustments to the test command to include race and debug tags. In plugin.go, the Plugin struct has been simplified by removing the pools slice, and the Stop method has been altered to streamline its parameters and logic.

Changes

Files Change Summary
.golangci.yml Replaced linter exportloopref with copyloopvar.
Makefile Renamed target from testpkg to test and modified the test command to include -tags=race and -tags=debug.
plugin.go Removed pools slice from Plugin struct, eliminated initialization in Init, and simplified Stop method signature.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Makefile
    participant Plugin

    User->>Makefile: Run `make test`
    Makefile->>Plugin: Execute `go test -tags=race,debug`
    Plugin->>Plugin: Run tests with new configuration
Loading

🐇 "In the code where the changes play,
New linters hop, and tests now sway.
Pools are gone, a simpler way,
Let's celebrate this bright new day!
With tags of race and debug cheer,
Our code will shine, let's give a cheer!" 🐇


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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@rustatian rustatian changed the title chore: remove central pools shutdown policy chore: remove pools shutdown policy Aug 30, 2024
Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3cdc644 and 08e1f1b.

Files selected for processing (3)
  • .golangci.yml (1 hunks)
  • Makefile (1 hunks)
  • plugin.go (5 hunks)
Additional comments not posted (2)
.golangci.yml (1)

43-43: Approve linter change but verify effectiveness.

The replacement of exportloopref with copyloopvar is noted. Ensure that the new linter copyloopvar effectively catches issues related to pointers to enclosing loop variables as intended.

The code changes are approved.

Run the following script to verify the effectiveness of the new linter:

plugin.go (1)

112-112: Approve method simplification but verify overall impact.

The simplification of the Stop method by removing the context.Context parameter and the synchronization logic is noted. Verify that this change aligns with the new architecture and does not adversely affect the plugin's functionality.

The code changes are approved.

Run the following script to verify the overall impact on the plugin's functionality:

Comment on lines +1 to +2
go test -v -race -cover -tags=race -tags=debug ./...
Copy link

Choose a reason for hiding this comment

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

Merge tags in the test command.

The go test command includes -tags=race and -tags=debug separately, which might not work as intended because the last -tags option will override the previous one. Merge them into a single -tags option to enable both features simultaneously.

Apply this diff to fix the command:

-	go test -v -race -cover -tags=race -tags=debug ./...
+	go test -v -race -cover -tags="race,debug" ./...
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.

Suggested change
test:
go test -v -race -cover -tags=race -tags=debug ./...
test:
go test -v -race -cover -tags="race,debug" ./...

@rustatian rustatian merged commit eb447c5 into master Aug 30, 2024
6 checks passed
@rustatian rustatian deleted the chore/pool-shutdown branch August 30, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant