Add option to change timeout of 20ms of ICommandPredictor ("ICommandPredictor interface has a 20ms time out for responses from the Predictors")

Open
#4,029 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, powershell
Domain
cli

Research direction

Start with src/System.Management.Automation/engine/Subsystem/PredictionSubsystem/CommandPrediction.cs at the mentioned 20ms timeout, then inspect the Set-PSReadLineOption prediction settings and determine whether configuration belongs in PSReadLine or PowerShell. Done means an agreed configuration entry point, updated documentation, and coverage for changing the predictor timeout without recompiling PowerShell.

Written by the indexing model from the issue text.

Description

Issue-Enhancement Needs-Triage :mag:
Prerequisites
  • Write a descriptive title.
Description of the new feature/enhancement

Currently:
"To ensure a responsive user experience, the ICommandPredictor interface has a 20ms time out for responses from the Predictors. Your predictor code must return results in less than 20ms to be displayed."
see
https://learn.microsoft.com/en-us/powershell/scripting/dev-cross-plat/create-cmdline-predictor?view=powershell-7.4

This seem to be source code, with hard coded timeout of 20ms, see "millisecondsTimeout: 20"

src/System.Management.Automation/engine/Subsystem/PredictionSubsystem/CommandPrediction.cs

The "problem"
I find this value too low, as some of the predictors are use take more time to calculate suggestions.
I wish this value could be configured by user (me), without need to compile PowerShell.

Proposed technical implementation details (optional)

Add option to change this value, eg by using some additional call for Set-PSReadLineOption or other.
Eg, currently the next lines are used to install a predictor.

Set-PSReadLineOption -PredictionSource HistoryAndPlugin
Import-Module .\bin\Debug\net6.0\SamplePredictor.dll

The following command can be added:
Set-PSReadLineOption -PredictionTimeout 30

Technically I'm not sure if this should be Set-PSReadLineOption, or in this repo at all,
because to install the predictor, "Set-PSReadLineOption" is used,
while the timeout code is in https://github.com/PowerShell/PowerShell/

Dominant language
C#
Stars
4.4k
Forks
341
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/PSReadLine

All issues in PowerShell/PSReadLine

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.