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

Displaying Detailed Job Progress While Using Run Command #4254

Merged
merged 11 commits into from
Jul 26, 2024

Conversation

udsamani
Copy link
Contributor

This PR aims at the following

  • Introduce Live Table Writer
  • Refactor Printer and split out Job Progress Printer Logic
  • Get History Events and Print All Job Progress in Table Format

closes #4233

@udsamani udsamani linked an issue Jul 24, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jul 24, 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.


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

@udsamani udsamani requested review from wdbaruni and frrist July 24, 2024 12:15
@udsamani udsamani marked this pull request as ready for review July 24, 2024 15:13
@udsamani udsamani self-assigned this Jul 24, 2024
Comment on lines 13 to 14
const DefaultRefreshInterval = time.Millisecond
const ESC = 27
Copy link
Member

Choose a reason for hiding this comment

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

are we refreshing every millisecond by default? can we instead refresh whenever there is update?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

Comment on lines 75 to 80
if w.ticker == nil {
w.ticker = time.NewTicker(w.RefreshInterval)
w.tdone = make(chan bool)
}

go w.Listen()
Copy link
Member

Choose a reason for hiding this comment

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

better to make sure we only start once

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done ! Getting rid of listen, start, and stop overall.

Comment on lines 97 to 99
if w.ticker != nil {
_ = w.Flush()
}
Copy link
Member

Choose a reason for hiding this comment

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

unnecessary check since you are existing the for loop when stopping the ticker. Also weird to read a ticker that returns a tick and can be nil. This can be a more readable pattern

func Start() {
  once.do({
      go listen()
  )}
  // done channel should be instantiated in the constructor
}

func listend() {
    ticker := start ticker 
    defer stop ticker
    
    for {...}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done ! Getting rid of listen, start, and stop overall.

Comment on lines 114 to 115
w.tdone <- true
<-w.tdone
Copy link
Member

Choose a reason for hiding this comment

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

you should just close the channel here instead of inside listen. Listen should just exit the for loop if the channel returns

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done ! Getting rid of listen, start, and stop overall.

Comment on lines 35 to 39
jobID string
occurred time.Time
executionID string
eventTopic models.EventTopic
event models.Event
Copy link
Member

Choose a reason for hiding this comment

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

aren't topic and occured already part of the event?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So occurred, inside job history has a logic, where if the event timestamp is not present it returns the history timestamp. Hence tracking it separately.

Comment on lines 71 to 76
// print hint in green
if j.event.Details[models.DetailsKeyHint] != "" {
res += "\n" + fmt.Sprintf(
"%s %s", output.BoldStr(output.GreenStr("* Hint:")), j.event.Details[models.DetailsKeyHint])
}
}
Copy link
Member

Choose a reason for hiding this comment

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

similar to job describe, lets print all details if debug mode is enabled

Comment on lines +180 to +182
func (j *JobProgressPrinter) followLogs(jobID string, cmd *cobra.Command) error {
cmd.Printf("Job successfully submitted. Job ID: %s\n", jobID)
cmd.Printf("Waiting for logs... (Enter Ctrl+C to exit at any time, your job will continue running):\n\n")
Copy link
Member

Choose a reason for hiding this comment

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

can you share snippets in the PR comment of different invocations of job submissions? For example, id-only, wait=false, follow logs, queueing triggered, queueing triggered and fulfilled, and cases with failures

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Acknowledged. Doing that now.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks. Looking at --id-only output, it should only be the id of the job so users can pipe it into other commands, such as bacalhau docker run ubuntu echo hello --id-only | xargs bacalhau job describe

It will wait until job completion, but only print the job id

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense ! Fixing it now :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done with commit 57add2b

@udsamani
Copy link
Contributor Author

id-only

progress-visibility-id-only

wait=false

progress-visibility-wait-false

follow

progress-visibility-follow

@udsamani udsamani requested a review from wdbaruni July 25, 2024 07:31
@udsamani udsamani merged commit 093876f into main Jul 26, 2024
6 of 10 checks passed
@udsamani udsamani deleted the 4233-displaying-paginated-history branch July 26, 2024 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Displaying paginated history as part of job run command
2 participants