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

allow change resumission times #503

Closed
wants to merge 70 commits into from
Closed

Conversation

thangckt
Copy link
Contributor

@thangckt thangckt commented Oct 15, 2024

solve issue #502
hi @njzjz, please "test" this

Summary by CodeRabbit

  • Bug Fixes

    • Improved the job retry mechanism by simplifying the logic for determining the retry count when a job fails.
  • Chores

    • Minor adjustments made to comments and formatting for clarity.

thangckt and others added 30 commits March 26, 2024 16:25
- add option: "strategy": {"customized_script_header_template_file": ""},

- add option: `sge_pe_name`
Copy link

codecov bot commented Oct 15, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 60.17%. Comparing base (da8e4d8) to head (d28233d).

Files with missing lines Patch % Lines
dpdispatcher/submission.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #503      +/-   ##
==========================================
- Coverage   60.19%   60.17%   -0.03%     
==========================================
  Files          39       39              
  Lines        3859     3859              
==========================================
- Hits         2323     2322       -1     
- Misses       1536     1537       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request focus on the Job class within the dpdispatcher/submission.py file. The primary modification is in the handle_unexpected_job_state method, where the logic for setting the retry_count when a job is terminated has been simplified. Instead of incrementing the retry count conditionally, the new implementation directly assigns the current retry count. Additionally, minor formatting and comment adjustments were made, which do not affect the functionality.

Changes

File Change Summary
dpdispatcher/submission.py Modified handle_unexpected_job_state method to simplify logic for setting retry_count. Minor adjustments in comments and formatting.

Sequence Diagram(s)

sequenceDiagram
    participant Job
    participant Machine
    Job->>Machine: Check current retry count
    Machine-->>Job: Return retry count
    Job->>Job: Set retry_count = current retry count
Loading

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: 0

🧹 Outside diff range and nitpick comments (1)
dpdispatcher/submission.py (1)

Line range hint 851-859: LGTM! Consider minor improvement to error message formatting.

The changes to the error-raising condition and the inclusion of the remote error message improve the error handling and provide more context for debugging. This is a good improvement.

Consider adding a newline character before the "For further actions" part of the error message to improve readability:

 raise RuntimeError(err_msg)
-            self.submit_job()
-            if self.job_state != JobStatus.unsubmitted:
-                dlog.info(
-                    f"job:{self.job_hash} re-submit after terminated; new job_id is {self.job_id}"
-                )
-                time.sleep(0.2)
-                self.get_job_state()
-                dlog.info(
-                    f"job:{self.job_hash} job_id:{self.job_id} after re-submitting; the state now is {repr(self.job_state)}"
+            raise RuntimeError(
+                f"{err_msg}\n"
+                f"For further actions, run the following command with proper flags: dpdisp submission {self.submission_hash}"
+            )
+        self.submit_job()
+        if self.job_state != JobStatus.unsubmitted:
+            dlog.info(
+                f"job:{self.job_hash} re-submit after terminated; new job_id is {self.job_id}"
+            )
+            time.sleep(0.2)
+            self.get_job_state()
+            dlog.info(
+                f"job:{self.job_hash} job_id:{self.job_id} after re-submitting; the state now is {repr(self.job_state)}"
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 848-848: dpdispatcher/submission.py#L848
Added line #L848 was not covered by tests

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between da8e4d8 and d28233d.

📒 Files selected for processing (1)
  • dpdispatcher/submission.py (1 hunks)
🧰 Additional context used
🪛 GitHub Check: codecov/patch
dpdispatcher/submission.py

[warning] 848-848: dpdispatcher/submission.py#L848
Added line #L848 was not covered by tests

🔇 Additional comments (2)
dpdispatcher/submission.py (2)

Line range hint 847-859: Overall improvements to retry mechanism and error handling

The changes in this pull request focus on enhancing the retry mechanism and error handling in the Job class. The modifications simplify the logic, provide more flexibility in configuring retry behavior, and improve error messages for better debugging. These are all positive improvements to the codebase.

Key improvements:

  1. Simplified retry logic using the machine's retry_count directly.
  2. More flexible configuration of retry behavior through the machine object.
  3. Enhanced error messages with additional context for debugging.

These changes will make the code more maintainable and easier to debug. Good job!

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 848-848: dpdispatcher/submission.py#L848
Added line #L848 was not covered by tests


847-849: LGTM! Consider adding a comment to explain the retry mechanism.

The changes to the retry logic simplify the code and improve flexibility by using the machine's retry_count directly. This is a good improvement.

Consider adding a brief comment to explain the retry mechanism, for example:

+ # Use the machine's retry_count to determine the maximum number of retries
if hasattr(self.machine, "retry_count"):
    retry_count = self.machine.retry_count

To ensure the new line is properly tested, please run the following command:

If no tests are found, consider adding a new test case to cover this scenario.

✅ Verification successful

Verification Complete: Retry Mechanism is Properly Tested

The presence of test_handle_unexpected_job_state in tests/test_class_job.py confirms that the retry mechanism is adequately tested.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any tests covering the Job.handle_unexpected_job_state method
rg -i "def test.*handle_unexpected_job_state" tests/

Length of output: 126

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 848-848: dpdispatcher/submission.py#L848
Added line #L848 was not covered by tests

@njzjz
Copy link
Member

njzjz commented Oct 15, 2024

What is the reason to change it?

@thangckt
Copy link
Contributor Author

What is the reason to change it?

To able to set/ disable resubmit fail jobs

@njzjz
Copy link
Member

njzjz commented Oct 16, 2024

It seems to me that this PR just changes the definition of retry_count? This is a breaking change, though.

@thangckt thangckt closed this Oct 18, 2024
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