CIVIMM-480: Update README webhook features after stuck recovery changes

[erawat]

Overview

• Update README webhook features section to reflect changes from PR CIVIMM-480: Add webhook stuck recovery with attempt tracking #16 (stuck recovery with attempt tracking)
• Fix incorrect stuck timeout (was "30 minutes", now correctly says "1 day")
• Add missing features: orphaned webhook re-queuing, optimistic locking, max attempt tracking

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on bringing the project's documentation up-to-date by revising the webhook features section in the README. The primary goal is to ensure that the documentation accurately reflects the current state of the system's webhook handling, especially concerning recovery mechanisms and retry logic, providing clear and correct information for users and developers.

Highlights

• README Update: The README's webhook features section has been updated to accurately reflect recent changes from PR CIVIMM-480: Add webhook stuck recovery with attempt tracking #16, which introduced stuck recovery enhancements.
• Stuck Timeout Correction: The incorrect stuck timeout value in the README was fixed, changing it from '30 minutes' to the correct '1 day'.
• New Features Documented: Previously undocumented features such as orphaned webhook re-queuing, optimistic locking, and max attempt tracking for retries have been added to the README.

Changelog

• README.md
  • Updated the description of automatic retry with exponential backoff to include 'max 3 attempts'.
  • Corrected the stuck webhook recovery detection time from '30 minutes' to '1 day' and added details about retry attempts and permanent error marking.
  • Added 'Orphaned webhook re-queuing' feature description.
  • Added 'Optimistic locking to prevent race conditions between workers' feature description.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the README file to document new and existing features of the webhook processing system, such as stuck recovery, orphaned webhook re-queuing, and optimistic locking. The changes are mostly accurate, but I've suggested a small wording improvement to more precisely describe the stuck webhook retry logic.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

[gemini-code-assist]

The description for stuck webhook recovery is slightly misleading. The phrase "retries up to 3 times" doesn't accurately reflect the behavior.

Based on the current implementation, the attempt counter is incremented both when a task runs and when it's recovered from a stuck state. This means a webhook that gets stuck on its first run will only get one more chance before being marked as a permanent error.

A more accurate description would clarify that stuck attempts contribute to the overall attempt limit, rather than promising a specific number of retries. This will help users better understand the lifecycle of a webhook.

Suggested change

	- Stuck webhook recovery (detects after 1 day, retries up to 3 times then marks as permanent error)
	- Stuck webhook recovery (detects after 1 day; stuck attempts count towards the 'max 3 attempts' limit before being marked as a permanent error)