#39401 make closeContextMenu optional

[daniela-mateescu]

Proposed Change:

What is your change

Change type

Put an x in the boxes that apply

• Bugfix
• New feature

Checklist

• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

[gemini-code-assist]

Summary of Changes

Hello @daniela-mateescu, 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 introduces a minor but significant change to the IActionParamForRun interface by making the closeContextMenu property optional. This modification enhances the flexibility of context menu actions, enabling scenarios where an action might not require or handle the closing of the context menu directly, aligning with the interface's description that the context menu closes by default.

Highlights

• Interface Modification: The closeContextMenu property within the IActionParamForRun interface has been updated to be optional, allowing actions to be defined without necessarily providing a function to close the context menu.

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 makes the closeContextMenu function optional on the IActionParamForRun interface. This is a significant change as it introduces a breaking change for any consumers of the library who have implemented actions that rely on this function. The function was previously guaranteed to exist, but now it may be undefined, which could lead to runtime errors in existing code. It's crucial that this breaking change is clearly communicated and that consumers are guided on how to adapt their code.

[gemini-code-assist]

Making closeContextMenu optional is a breaking change for consumers of this library. Any action implementation that calls params.closeContextMenu() will now fail if the function is not provided. Previously, its presence was guaranteed by the type definition.

All call sites within consumer code will need to be updated to check for the existence of closeContextMenu before calling it, for example:

if (params.closeContextMenu) {
    params.closeContextMenu();
}

or using optional chaining:

params.closeContextMenu?.();

If this breaking change is intentional, it should be clearly documented in the pull request description and reflected in the package's versioning (e.g., a major version bump).

An alternative to making it optional, which would not be a breaking change, is to ensure it's always provided, even if it's a no-op function (() => {}) in contexts where there's no menu to close. This seems to align with the suggestion in the TODO comment on line 5 of this file.

[daniela-mateescu]

This is always populated internally in ContextMenu before passed to handlers. I have added a comment on top of this property