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

make job name optional #4005

Merged
merged 3 commits into from
May 22, 2024
Merged

make job name optional #4005

merged 3 commits into from
May 22, 2024

Conversation

wdbaruni
Copy link
Collaborator

Use the auto-generated job id as the job name value if name was not provided

Copy link

coderabbitai bot commented May 16, 2024

Important

Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

"github.com/bacalhau-project/bacalhau/pkg/test/mock"
)

type JobTestSuite struct {
Copy link
Member

Choose a reason for hiding this comment

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

We should be explicit with the job type we set since there is different behavior regarding jobIDs dependent on its type:

if j.Type == JobTypeBatch || j.Type == JobTypeOps {

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

As we are both working on very different timezones, my recommendation is to have bias for action and not block PRs for things not related to the PR itself. Feel free to add comments and I'll make sure I'll address what I can or open follow-up issues to track the ones that I can't, but give approval if there are no concerns with the main scope of the PR.

Added tests in d9191d6

Comment on lines 89 to 92
// Ensure nested objects are deeply copied
for i, task := range job.Tasks {
suite.NotSame(task, cpy.Tasks[i], "The tasks in the job and its copy should not be the same instance")
}
Copy link
Member

Choose a reason for hiding this comment

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

since we only support one task right now we should use the Task() method here present on the job and its copy.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

we should all tasks are equal in copy, otherwise we will only be verifying the first tasks are the same, and won't catch if copy is appending more tasks for some reason.

I've added a dedicated test for Task() in d9191d6


func (suite *JobTestSuite) TestNamespacedID() {
job := mock.Job()
nsID := job.NamespacedID()
Copy link
Member

Choose a reason for hiding this comment

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

what is the purpose of NamespacedID?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

globally unique job id across namespaces. When we allow users to set their own job IDs, they only need to be unique within their own namespace and not globally

@wdbaruni wdbaruni enabled auto-merge (squash) May 22, 2024 14:50
@wdbaruni wdbaruni merged commit fa27190 into main May 22, 2024
12 checks passed
@wdbaruni wdbaruni deleted the job-name-optional branch May 22, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants