[CmdPal] Refactor ActionRuntime initialization to avoid repeated delays on failure

[lei9444]

Summary of the Pull Request

This PR addresses an issue where ActionRuntime initialization may repeatedly incur delays and fail during runtime usage, especially when the OS supports the API but action creation fails.

Fix:

Introduced ActionRuntimeManager to:

• Manage a shared static ActionRuntime instance
• Perform initialization once, at extension loading time
• Store the result (success or failure) to avoid repeated creation attempts

Consumers now:

• ActionRuntimeManager.InstanceAsync.GetAwaiter().GetResult()

Initialization will only be attempted up to 3 times. After that, runtime is marked as unavailable and no further attempts are made.

PR Checklist

• Closes: The file indexer on Copilot+ PCs may introduce a 500ms delay each time a character is typed. #40228
• Communication: I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected
• Tests: Added/updated and all pass
• Localization: All end-user-facing strings can be localized
• Dev docs: Added/updated
• New binaries: Added on the required places
  • JSON for signing for new binaries
  • WXS for installer for new binaries and localization folder
  • YML for CI pipeline for new test projects
  • YML for signed pipeline
• Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

[dcq01]

Hi! I'm a grad student working on a research project about using large language models to automate code review. Based on your commit d51e2b5 and the changes in src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Indexer/Pages/ActionsListContextItem.cs, my tool generated this comment:

1. Restore the try-catch block around the call to ActionRuntimeManager.WaitForRuntimeAsync() to maintain error handling and ensure exceptions are logged.
2. Ensure that fullPath is validated and sanitized before use to prevent exceptions when calling System.IO.Path.GetExtension(fullPath).
3. The line MoreCommands = [.. actions]; should be corrected to use valid syntax for assignment in C#. If MoreCommands is a list, use MoreCommands = new List<CommandContextItem>(actions);.
4. Consider using await instead of .Wait() on ActionRuntimeManager.WaitForRuntimeAsync() to avoid blocking the thread and potential deadlocks.
5. Enhance logging by including more context in error messages, such as the fullPath, when an error occurs while updating commands.
6. Consider refactoring the logic for determining the entity based on the file extension into a separate method to improve clarity and maintainability.
7. Use a HashSet<string> for supported file extensions to optimize the time complexity of checking if an extension is valid.
8. Consider using a concurrent collection like ConcurrentBag<T> or ConcurrentQueue<T> instead of locking on actions to reduce contention and improve performance in multi-threaded scenarios.
9. Remove the redundant null check for actionRuntime after the try-catch block. Return early if actionRuntime is still null right after the first attempt.

As part of my research, I'm trying to understand how useful these comments are in real-world development. If you have a moment, I'd be super grateful if you could quickly reply to these two yes/no questions:

1. Does this comment provide suggestions from a dimension you hadn’t considered?
2. 2. Do you find this comment helpful?

Thanks a lot for your time and feedback! And sorry again if this message is a bother.

[Copilot]

Pull Request Overview

This PR refactors ActionRuntime initialization to reduce delays and prevent repeated failed attempts by introducing a shared static instance managed by ActionRuntimeManager.

• Introduces ActionRuntimeManager to attempt initialization up to 3 times and cache the result.
• Updates ActionsListContextItem to use the shared ActionRuntime and implement IDisposable for cleanup.
• Modifies IndexerCommandsProvider to conditionally initialize the ActionRuntime based on OS API availability.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Indexer/Pages/ActionsListContextItem.cs	Updated to retrieve runtime from ActionRuntimeManager and implement IDisposable.
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Indexer/IndexerCommandsProvider.cs	Integration of API contract check and initialization call for ActionRuntimeManager.
src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Indexer/Actions/ActionRuntimeManager.cs	New static class to manage and cache ActionRuntime initialization with a maximum of 3 attempts.

[yeelam-gordon]

Let's talk in case.

[lei9444]

Hi! I'm a grad student working on a research project about using large language models to automate code review. Based on your commit d51e2b5 and the changes in src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.Indexer/Pages/ActionsListContextItem.cs, my tool generated this comment:

1. Restore the try-catch block around the call to ActionRuntimeManager.WaitForRuntimeAsync() to maintain error handling and ensure exceptions are logged.
2. Ensure that fullPath is validated and sanitized before use to prevent exceptions when calling System.IO.Path.GetExtension(fullPath).
3. The line MoreCommands = [.. actions]; should be corrected to use valid syntax for assignment in C#. If MoreCommands is a list, use MoreCommands = new List<CommandContextItem>(actions);.
4. Consider using await instead of .Wait() on ActionRuntimeManager.WaitForRuntimeAsync() to avoid blocking the thread and potential deadlocks.
5. Enhance logging by including more context in error messages, such as the fullPath, when an error occurs while updating commands.
6. Consider refactoring the logic for determining the entity based on the file extension into a separate method to improve clarity and maintainability.
7. Use a HashSet<string> for supported file extensions to optimize the time complexity of checking if an extension is valid.
8. Consider using a concurrent collection like ConcurrentBag<T> or ConcurrentQueue<T> instead of locking on actions to reduce contention and improve performance in multi-threaded scenarios.
9. Remove the redundant null check for actionRuntime after the try-catch block. Return early if actionRuntime is still null right after the first attempt.

As part of my research, I'm trying to understand how useful these comments are in real-world development. If you have a moment, I'd be super grateful if you could quickly reply to these two yes/no questions:

1. Does this comment provide suggestions from a dimension you hadn’t considered?
2. 2. Do you find this comment helpful?

Thanks a lot for your time and feedback! And sorry again if this message is a bother.

@dcq01 Thanks.

1. Yes — some points like using HashSet for extension checks and refactoring entity logic into a separate method are good reminders and help improve maintainability.
2. Yes — overall it’s quite thorough. That said, some suggestions (like using await instead of .Wait()) don’t apply in our case since we're explicitly managing fire-and-forget background behavior with a non-async context.

[yeelam-gordon]

Looks great.

[lei9444]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).