feat(jobs): Use ordered registry

[calbera]

Using the ordered registry allows implementing apps to preserve running jobs in order upon start up

Summary by CodeRabbit

• New Features

  • Implemented ordered job loading to enhance the execution sequence of tasks.
  • Improved error handling during the job iteration process for better stability.

• Refactor

  • Updated transaction status terminology for clarity in transaction outcomes.

• Chores

  • Streamlined job registry structure for more efficient job management.

[coderabbitai]

Warning

Rate Limit Exceeded

@calbera has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 27 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 85e9162 and 562babd.

Walkthrough

The system has undergone a refinement where job execution now follows a specific order, and the job registry management is more structured. A structural change in a transaction-related struct and a renaming of a transaction status constant reflect an effort to streamline transaction handling. Error handling has been enhanced, ensuring a smoother operation when jobs are loaded and run.

Changes

File Path	Change Summary
baseapp/job_manager.go	Introduced ordered job loading with error handling in RunProducers.
core/transactor/.../transactor.go	Altered factory field type in TxrV2.
core/transactor/.../types.go	Renamed error constant to StatusRevert.
job/registry.go	Removed interface, embedded types.Registry, and improved job registration and counting.

Poem

In the warren of code, where the bytes do hop, 🐇
A change was made; a refactor non-stop.
Jobs line up, a neat little queue,
A rabbit's touch, making all things new. 🌟

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1546d21 and 85e9162.

Files ignored due to filter (2)

• go.mod
• go.sum

Files selected for processing (4)

• baseapp/job_manager.go (1 hunks)
• core/transactor/transactor.go (1 hunks)
• core/transactor/types/types.go (1 hunks)
• job/registry.go (1 hunks)

Files skipped from review due to trivial changes (1)

• core/transactor/transactor.go

Additional comments: 5

job/registry.go (3)

• 11-11: The Registry struct now embeds types.Registry with string keys and Basic values. This change aligns with the PR's objective to introduce an ordered job registry.

• 17-17: The NewRegistry function correctly initializes the Registry with an OrderedMap. This ensures that jobs will be stored and retrieved in the order they were registered.

• 30-30: The Count method has been updated to use the Iterate method of the embedded Registry. Ensure that the Iterate method indeed returns all registered jobs, as this affects the correctness of the Count method.

core/transactor/types/types.go (1)

• 21-21: Renaming ERR_REVERT to StatusRevert improves the clarity of the constant's purpose, aligning with the PR's objectives. Ensure that all references to ERR_REVERT throughout the codebase have been updated to StatusRevert.

Verification successful

---

The old constant ERR_REVERT is no longer present in the codebase, and the new constant StatusRevert is being used in several files. This aligns with the PR's objectives and the review comment.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for the old constant name to ensure it's no longer used.
rg --type go 'ERR_REVERT'
# Search for the new constant name to validate its usage.
rg --type go 'StatusRevert'

Length of output: 453

baseapp/job_manager.go (1)

• 166-166: The loop now iterates over the keys of the ordered jobs. Verify that the IterateInOrder method and the Keys method are correctly implemented to ensure the jobs are processed in the correct order.

[hunter-bera]

yeeet