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

Feat: Add button to try and resume pending batches #1529

Merged
merged 3 commits into from
Dec 3, 2024

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Dec 3, 2024

In rare cases, parent runs don't continue after child runs have completed. We are working on a permanent fix for this, but this should help in the meantime.

image

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced the CheckBatchCompletionDialog component for checking batch completion status.
    • Added new batch action options in the batch management interface, enhancing user interaction.
  • Bug Fixes

    • Improved error handling and return values in the batch processing logic to provide clearer feedback to users.
  • Documentation

    • Updated schemas and action functions for batch completion checks to ensure proper validation and user guidance.

Copy link

changeset-bot bot commented Dec 3, 2024

⚠️ No Changeset found

Latest commit: d16f736

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

A new component, CheckBatchCompletionDialog, has been added to facilitate checking the completion status of batch processes. This component accepts batchId and redirectPath as props and utilizes the useNavigation hook from Remix. Additionally, the route.tsx file has been updated to include a new BatchActionsCell component, enhancing the batch management interface. A new action function has been introduced in check-completion.ts for validating and checking batch statuses, while the ResumeBatchRunService class has been modified to improve return values and error handling in its call method.

Changes

File Change Summary
apps/webapp/app/components/runs/v3/CheckBatchCompletionDialog.tsx Added new component CheckBatchCompletionDialog with props batchId and redirectPath.
apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.v3.$projectParam.batches/route.tsx Introduced BatchActionsCell component and updated BatchesTable to include a new actions column.
apps/webapp/app/routes/resources.batches.$batchId.check-completion.ts Added action function for checking batch completion with schema validation using Zod.
apps/webapp/app/services/worker.server.ts Modified v3.resumeBatchRun task handler to await service call without returning the result.
apps/webapp/app/v3/services/resumeBatchRun.server.ts Updated call method in ResumeBatchRunService to return specific string values instead of void.

Possibly related PRs

Suggested reviewers

  • Eric Allam

🐰 In the meadow where batches run,
A dialog checks if they're done.
With props in tow, it spins and sways,
To guide us through the busy days.
Hops of joy as tasks align,
Completion's sweet, oh how divine! 🌼

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/components/runs/v3/CheckBatchCompletionDialog.tsx

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


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>, 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 resolve resolve all the CodeRabbit review comments.
  • @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.

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.

Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (2)
apps/webapp/app/v3/services/resumeBatchRun.server.ts (1)

Line range hint 6-6: Use a union type or enum for return values to enhance type safety

Defining a union type or an enum for the possible return values of the call method improves type safety and maintainability.

You can define the return type as a union:

type ResumeBatchRunResult = "ERROR" | "ALREADY_COMPLETED" | "COMPLETED" | "PENDING";

Or as an enum:

enum ResumeBatchRunResult {
  ERROR = "ERROR",
  ALREADY_COMPLETED = "ALREADY_COMPLETED",
  COMPLETED = "COMPLETED",
  PENDING = "PENDING",
}

Then update the method signature:

public async call(batchRunId: string): Promise<ResumeBatchRunResult> {
  // ...
}

This change promotes better type checking and helps prevent typos or invalid return values.

apps/webapp/app/services/worker.server.ts (1)

566-566: Return the promise from the handler function for consistency

Returning the promise from service.call in the handler function maintains consistency with other handlers and ensures proper error propagation.

Apply this diff to adjust the handler:

"v3.resumeBatchRun": {
  priority: 0,
  maxAttempts: 5,
  handler: async (payload, job) => {
    const service = new ResumeBatchRunService();

-   await service.call(payload.batchRunId);
+   return await service.call(payload.batchRunId);
  },
},
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cf7dc8d and d16f736.

📒 Files selected for processing (5)
  • apps/webapp/app/components/runs/v3/CheckBatchCompletionDialog.tsx (1 hunks)
  • apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.v3.$projectParam.batches/route.tsx (5 hunks)
  • apps/webapp/app/routes/resources.batches.$batchId.check-completion.ts (1 hunks)
  • apps/webapp/app/services/worker.server.ts (1 hunks)
  • apps/webapp/app/v3/services/resumeBatchRun.server.ts (9 hunks)
🔇 Additional comments (2)
apps/webapp/app/components/runs/v3/CheckBatchCompletionDialog.tsx (1)

13-57: LGTM!

The CheckBatchCompletionDialog component is well-structured and follows best practices.

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.v3.$projectParam.batches/route.tsx (1)

251-294: LGTM!

The BatchActionsCell component is correctly implemented and integrates seamlessly with the batches table.

@nicktrn nicktrn changed the title Feat: add button to batches page to try and resume pending ones Feat: Add button to try and resume pending batches Dec 3, 2024
@nicktrn nicktrn merged commit 29d107d into main Dec 3, 2024
7 of 8 checks passed
@nicktrn nicktrn deleted the feat/batch-completion-checker branch December 3, 2024 09:50
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.

1 participant