GitAuto: [FEATURE] Handle OpenAI downtime and large requests

[gitauto-ai]

Resolves #149

What is the feature

This feature enhances the resilience and user experience of dotnet-aicommitmessage by addressing two scenarios:

1. OpenAI Downtime/Unresponsiveness:

   • Detect if the OpenAI API is down or unresponsive.
   • Abort the process gracefully, displaying a clear error message to the user.

2. Large Requests (Exceeding OpenAI Limits):

   • If the Git diff output size exceeds acceptable limits:
     • Abort the commit process.
     • Provide an error message instructing the user to reduce the number of staged files or the size of the changes.

Why we need the feature

To ensure dotnet-aicommitmessage remains reliable and user-friendly even during OpenAI API downtime or when processing large commit requests. Handling these scenarios prevents crashes and provides clear guidance to users, thereby improving overall user experience and tool stability.

How to implement and why

1. OpenAI Downtime Handling:

   • Detection: Implement error handling around the OpenAI API call to catch exceptions related to network issues or API unresponsiveness.
   • Graceful Abort: When downtime is detected, abort the commit process and display the predefined error message: "⚠️ OpenAI API is currently unavailable. Please try again later."

2. Handling Large Requests:

   • Size Calculation: Add a mechanism to calculate the size of the Git diff output using Encoding.UTF8.GetByteCount(diff).
   • Validation: Define a maximum allowed size (e.g., 10 KB). Before sending the diff to OpenAI, check if the size exceeds this limit.
   • Abort and Notify: If the diff size exceeds the limit, abort the commit and display the error message: "🚫 The staged changes are too large to process. Please reduce the number of files or size of changes and try again."

3. Robust Error Handling:

   • Ensure that all new error scenarios are handled without causing the tool to crash.
   • Provide clear and actionable error messages to guide the user on resolving the issues.

4. Unit Tests and Documentation:

   • Testing: Write unit tests to verify that both downtime handling and request size validation work as expected.
   • Documentation: Update the README.md or add a dedicated error-handling section to document the new behaviors and error messages.

This step-by-step implementation ensures that the tool gracefully handles exceptional scenarios, enhancing reliability and user trust.

About backward compatibility

Yes, this feature maintains backward compatibility. Existing functionalities remain unchanged for normal operations. The new error handling only intercepts specific scenarios (API downtime and large diffs) without altering the default commit message generation behavior. Users who do not encounter these scenarios will experience no differences.

Test these changes locally

git checkout -b gitauto/issue-149-20241213-000919
git pull origin gitauto/issue-149-20241213-000919

[coderabbitai]

Important

Review skipped

Bot user detected.

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.

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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. (Experiment)
• @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.

[deepsource-io]

Here's the code health analysis summary for commits d83729f..a1513f1. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	⚠️ Artifact not reported	Timed out: Artifact was never reported	View Check ↗
Secrets	✅ Success		View Check ↗
Docker	✅ Success		View Check ↗
C#	❌ Failure	❗ 1 occurence introduced	View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

12:12AM INF scanning for exposed secrets...
12:12AM INF 121 commits scanned.
12:12AM INF scan completed in 91.2ms
12:12AM INF no leaks found