feat: Add ThrottledInvoker utility

[bnbajwa]

Common use case is throttling logging.

SDB-9266

[gemini-code-assist]

Summary of Changes

Hello @bnbajwa, 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 PR introduces a ThrottledInvoker utility class for rate-limiting function calls, particularly useful for scenarios like logging. It includes the new class definition in Utility.hpp and a comprehensive unit test in Utility.ut.cpp to validate its behavior.

Highlights

• Intent: This pull request introduces a new ThrottledInvoker utility class to provide a mechanism for rate-limiting function calls. The primary use case mentioned is throttling logging, addressing issue SDB-9266.
• Changes: The core change is the addition of a ThrottledInvoker template class in toolbox/util/Utility.hpp. This class allows a callable to be invoked only if a specified cooldown_interval has passed since its last invocation. It uses ClockT and DurationT for generic time handling. A corresponding unit test, ThrottledInvokerCheck, has been added to toolbox/util/Utility.ut.cpp to verify its functionality, ensuring that the callable is invoked only once within the cooldown period and then again after the period has elapsed.
• Reviewer Activity: No specific reviewer activity has been recorded or provided in the context for this pull request.

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

Thank you for adding the ThrottledInvoker utility. This is a useful component for cases like logging. I've reviewed the changes and have a few suggestions to improve correctness, maintainability, and documentation. My main points are about ensuring the first invocation always happens and improving the test structure. Please see my detailed comments below.

[Shivix]

Thanks!