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

feature: support new JOBS api #128

Merged
merged 4 commits into from
Jun 26, 2024
Merged

feature: support new JOBS api #128

merged 4 commits into from
Jun 26, 2024

Conversation

rustatian
Copy link
Member

@rustatian rustatian commented Jun 26, 2024

Reason for This PR

ref: roadrunner-server/roadrunner#1941

Description of Changes

  • Support NackWithOptions method.

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

  • Chores

    • Updated linter version to improve code quality checks.
    • Updated multiple dependencies to the latest versions.
  • Refactor

    • Modified internal logic of job handling, including type changes and method updates for better performance and reliability.
  • New Features

    • Introduced NackWithOptions method for enhanced job control.
  • Bug Fixes

    • Adjusted type conversions and logic in job processing to resolve potential issues.

Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian rustatian added the enhancement New feature or request label Jun 26, 2024
@rustatian rustatian requested a review from wolfy-j June 26, 2024 10:12
@rustatian rustatian self-assigned this Jun 26, 2024
Copy link

coderabbitai bot commented Jun 26, 2024

Warning

Rate limit exceeded

@rustatian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 35 minutes and 43 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 4e41006 and 79fb3ea.

Walkthrough

This update mainly focuses on version upgrades and configuration changes. Key revisions include upgrading the golangci-lint, adjusting linter configurations, modifying import paths and package versions in Go modules, and enhancing the job handling logic in the boltjobs package, especially the Item struct and related methods.

Changes

File(s) Change Summary
.github/workflows/linters.yml Updated golangci/golangci-lint-action from v1.56 to v1.59.
.golangci.yml Removed skip-dirs, govet, golint settings, and nolintlint configuration for allow-leading-space. Added exclude-dirs.
boltjobs/driver.go Updated import path for jobs package from v3 to v4.
boltjobs/item.go Modified Delay field type, added NackWithOptions method, changed Nack and Requeue logic, and adjusted type conversion.
go.mod Updated github.com/roadrunner-server/api/v4 version from v4.12.0 to v4.13.0.
plugin.go Updated import path for jobs package from version 3 to version 4 in the boltdb package.
tests/go.mod Updated versions for multiple github.com/roadrunner-server and google.golang.org/genproto/googleapis packages.

Poem

In lines of code so crisp and fine,
We upgraded versions, oh how they shine,
Imports were shifted, lints refined,
With NackWithOptions, jobs align.
The rabbit hops with joy so pure,
For updates made and bugs' cure!


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

@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 ed75a6e and 1ee4454.

Files ignored due to path filters (3)
  • go.sum is excluded by !**/*.sum
  • go.work.sum is excluded by !**/*.sum
  • tests/go.sum is excluded by !**/*.sum
Files selected for processing (7)
  • .github/workflows/linters.yml (1 hunks)
  • .golangci.yml (3 hunks)
  • boltjobs/driver.go (1 hunks)
  • boltjobs/item.go (5 hunks)
  • go.mod (1 hunks)
  • plugin.go (1 hunks)
  • tests/go.mod (2 hunks)
Files skipped from review due to trivial changes (3)
  • .github/workflows/linters.yml
  • boltjobs/driver.go
  • go.mod
Additional comments not posted (6)
plugin.go (3)

5-5: Import path updated to new API version.

This change is necessary to utilize the updated jobs API in the boltdb plugin.


Line range hint 60-62: DriverFromConfig method implementation looks good.

The method correctly utilizes the new API for constructing a driver from configuration.


Line range hint 64-66: DriverFromPipeline method implementation is correct.

This method properly handles the construction of a driver from a pipeline using the updated API.

.golangci.yml (1)

65-67: Configuration update to exclude directories from linting.

Adding .github and .git to exclude-dirs helps avoid unnecessary linting in these directories, which are not part of the main application code.

tests/go.mod (1)

8-21: Dependency version updates in tests/go.mod.

The updates to dependencies like github.com/roadrunner-server/api/v4 and others are essential for ensuring compatibility with the new API changes.

boltjobs/item.go (1)

6-6: Significant updates and new method implementation in boltjobs/item.go.

The introduction of NackWithOptions and changes to the Options type (e.g., Delay field type change) are well-implemented and align with the new API requirements.

Also applies to: 12-12, 17-17, 40-40, 131-142, 198-203

Signed-off-by: Valery Piashchynski <[email protected]>
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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1ee4454 and 4e41006.

Files selected for processing (1)
  • boltjobs/item.go (5 hunks)
Additional context used
golangci-lint
boltjobs/item.go

200-200: S1009: should omit nil check; len() for map[string][]string is defined as zero (gosimple)

GitHub Check: Golang-CI (lint)
boltjobs/item.go

[failure] 200-200:
S1009: should omit nil check; len() for map[string][]string is defined as zero (gosimple)

Additional comments not posted (3)
boltjobs/item.go (3)

131-142: New method NackWithOptions implementation review.

The method NackWithOptions adds significant flexibility to job handling by allowing conditional requeuing with a specified delay. The implementation correctly checks for AutoAck before proceeding and handles the requeue condition appropriately by calling Requeue or Nack based on the requeue flag.


150-150: Review of modified Nack method.

The updated Nack method includes comprehensive transaction logic, ensuring robust error handling and rollback scenarios. This is crucial for maintaining data integrity in failure cases.


282-282: Verify type conversion in fromJob method.

The conversion of job.Delay() to int aligns with the updated Options struct. It's important to ensure that this change is consistent across all usages of the Delay field to avoid type mismatch errors.

boltjobs/item.go Outdated Show resolved Hide resolved
boltjobs/item.go Show resolved Hide resolved
Signed-off-by: Valery Piashchynski <[email protected]>
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian rustatian merged commit 93a1b8d into master Jun 26, 2024
6 checks passed
@rustatian rustatian deleted the feature/jobs-api-update branch June 26, 2024 10:43
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