{Core} Improve autocomplete performance by preventing loading all modules #24765
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
ghost
requested review from
bebound
changed the title
bebound
changed the title
|
autocomplete performance improvement |
bebound
requested review from
evelyn-ys,
jsntcy,
kairu-ms,
zhoxing-ms,
calvinhzy and
necusjz
as code owners
jiasli
reviewed
Dec 7, 2022
Comment on lines
571
to
579
| if not index_modules_extensions and is_autocomplete(): | ||
| # If user type `az acco`, command begin with `acco` will be matched. | ||
| # If the user just installed a new extension which contains a command named `acco`, he can't get the | ||
| # expected suggestion. But it's a rare scenario, and it's okay to ignore. | ||
| logger.debug("In autocomplete mode, load command begin with: '%s'", top_command) | ||
| index_modules_extensions = [] | ||
| for command in index: | ||
| if command.startswith(top_command): | ||
| index_modules_extensions += index[command] |
There was a problem hiding this comment.
Maybe put these lines after L597 for simplicity?
There was a problem hiding this comment.
I put it here as the following code convert index_modules_extensions to index_builtin_modules and index_extensions
4 tasks
3 tasks
️✔️AzureCLI-FullTest
|
bebound
commented
Mar 13, 2023
| if not index_modules_extensions and is_autocomplete(): | ||
| # If user type `az acco`, command begin with `acco` will be matched. | ||
| # If the user just installed a new extension which contains a command named `acco`, he can't get the | ||
| # expected suggestion. But it's a rare scenario, and it's okay to ignore. |
There was a problem hiding this comment.
If the user just installed a new extension which contains a command named
acco, he can't get the
expected suggestion. But it's a rare scenario, and it's okay to ignore.
This does not happen as CommandIndex().invalidate() is called after extension installation/remove/update.
yonzhan
modified the milestones:
Backlog,
May 2023 (2023-05-23) - For Build (Breaking change release)
jiasli
reviewed
May 10, 2023
jiasli
reviewed
May 10, 2023
| # If the command is not complete in autocomplete mode, we should match shorter command. | ||
| # For example, `account sho` should match `account`. | ||
| logger.debug("Could not find a match in the command or command group table for '%s'", raw_cmd) | ||
| raw_cmd = ' '.join(raw_cmd.split()[:-1]) |
There was a problem hiding this comment.
Please avoid reusing existing name. Instead, introduce a new name to make the code easier to read, such as raw_cmd_without_last_word.
Co-authored-by: Jiashuo Li <[email protected]>
jiasli
approved these changes
May 10, 2023
yash-nisar
pushed a commit
to yash-nisar/azure-cli
that referenced
this pull request
May 16, 2023
avgale
pushed a commit
to avgale/azure-cli
that referenced
this pull request
Aug 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Close #24762, related issue #9157, related pr #13294
If the command is not complete, for example:
az account sho, press TAB, cli loads all modules, which takes 1s. It gets worse if user installs many extensions. This make autocomplete slow.This PR prevents module loading in autocomplete mode.
If command is
az acc:accwill be returned inCommandIndex.get().raw_cmdis 'acc'. Trim last word, it becomes'', returnself.command_table.If command is
az account sh:accountmodule is returned inCommandIndex.get().raw_cmdisaccount sh. Trim last word, it becomesaccountand is inself.command_group_table, returnself.command_table.Testing Guide
time IFS=$'\013' _ARC_DEBUG=1 COMP_LINE='az account s' COMP_POINT=12 COMP_TYPE="" _ARGCOMPLETE=1 _ARGCOMPLETE_SUPPRESS_SPACE=0 az 8>&1 1>&1 2>&1 9>&1before: 2.364s
after: 0.269s
This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.