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

Zacharyb/fix job dispatch status #443

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

zacharyblasczyk
Copy link
Member

@zacharyblasczyk zacharyblasczyk commented Apr 3, 2025

Summary by CodeRabbit

  • Refactor
    • Improved job dispatch workflow so that job progress is updated immediately after a successful dispatch.
    • Removed redundant status updates for valid jobs to streamline job tracking and enhance overall reliability.

@zacharyblasczyk zacharyblasczyk marked this pull request as ready for review April 3, 2025 06:01
Copy link
Contributor

coderabbitai bot commented Apr 3, 2025

Walkthrough

The changes update the job dispatch flow. In the GitHub worker module, the dispatchGithubJob function now chains a .then() on the createWorkflowDispatch call to update the job status to JobStatus.InProgress upon success. Meanwhile, in the job dispatch module, the code that previously updated valid jobs to "InProgress" has been removed. Error handling in both cases remains consistent.

Changes

File(s) Summary
apps/event-worker/.../github.ts Modified the dispatchGithubJob function to chain a .then() that updates job status to JobStatus.InProgress after dispatch success.
packages/job-dispatch/.../job-dispatch.ts Removed the block that updated the job status to InProgress for valid jobs with resolved variables.

Sequence Diagram(s)

sequenceDiagram
    participant Worker as dispatchGithubJob
    participant Octokit as octokit.actions
    participant JobUpdater as updateJob

    Worker->>Octokit: createWorkflowDispatch()
    alt Success
        Octokit-->>Worker: Workflow dispatched
        Worker->>JobUpdater: Update status to InProgress
    else Error
        Octokit-->>Worker: Throws error
        Worker->>JobUpdater: Update status to InvalidJobAgent
    end
Loading

Possibly related PRs

  • fix: Release job agent config #289: Modifies the dispatchGithubJob function to introduce a status update, directly altering how workflow dispatch outcomes are handled.
  • fix: Get externalid from webhook #177: Alters the dispatchGithubJob function by removing the retry mechanism along with associated error handling, impacting job status flows.
  • fix: Show job external url #154: Updates job status handling in the dispatchGithubJob function, including the introduction of new variables, showing a clear code-level relationship.

Suggested reviewers

  • jsbroks

Poem

I’m a rabbit with code so spry,
Hopping through changes, oh my, oh my!
Dispatches now sing a new tune,
With status updates that make bugs swoon.
Bound on, my friend, to a code high!
🐇✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c61a6f and 3679784.

📒 Files selected for processing (2)
  • apps/event-worker/src/workers/job-dispatch/github.ts (1 hunks)
  • packages/job-dispatch/src/job-dispatch.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/job-dispatch/src/job-dispatch.ts
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{ts,tsx}`: **Note on Error Handling:** Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error...

**/*.{ts,tsx}: Note on Error Handling:
Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error handling. These are acceptable as long as they maintain clarity and predictability.

  • apps/event-worker/src/workers/job-dispatch/github.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build (linux/amd64)
  • GitHub Check: Lint
  • GitHub Check: Typecheck
  • GitHub Check: build (linux/amd64)
🔇 Additional comments (1)
apps/event-worker/src/workers/job-dispatch/github.ts (1)

177-190: Improvement: Enhanced status management with Promise chaining

The change correctly moves the responsibility of updating the job status to JobStatus.InProgress directly within the GitHub workflow dispatch flow. This ensures the status is updated only after the dispatch is successfully created, which provides a more accurate representation of the job's actual state.

The Promise chain is clear and follows a logical flow. It maintains good error handling through the surrounding try/catch block while improving the accuracy of the job status transitions.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

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.

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.

2 participants