Do not use alias name as key for command info cache to fix the problem where UseCorrectCasing corrects aliases #1216
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
…m where UseCorrectCasing corrects aliases
rjmholt
reviewed
Apr 15, 2019
| // If alias name is given, we store the entry under that, but search with the command name | ||
| var key = new CommandLookupKey(aliasName ?? commandName, commandTypes); | ||
|
|
||
| var key = new CommandLookupKey(commandName, commandTypes); |
There was a problem hiding this comment.
If aliasName is unused, maybe time to remove it from the parameters?
There was a problem hiding this comment.
Ok, done, I also removed the left-over GetCommandInfoInternal function that we moved into the CommandInfoCache a few weeks ago but forgot to delete.
I plan to do another PR with more general tidy up later btw.
…l function from refactoring a few weeks ago
rjmholt
approved these changes
Apr 15, 2019
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.
PR Summary
Fixes PowerShell/vscode-powershell#1842
Because aliases were used as the key for the cache, once those entities are created, it caused the UseCorrectCasing rule to correct aliases, somehow those cache entries could only be populated when and lead to this behaviour when being used via the vscode extension so I assume it must the some of the commands being issued at startup that cause other rules to populate this entry
Writing a test for this turned out to be hard as only when being used via the PowerShell vscode extension, alias key entries were populated in PSSA's command info cache first.
The intention is to have this PR fix the root cause and another PR to a bit of a cleanup.
PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.