Fix off-by-one error in validation within GetOffsetAtPosition#1669
Merged
andyleejordan merged 1 commit intoJan 24, 2022
masterPowerShell/PowerShellEditorServices:masterfrom
andschwa/fix-getoffsetPowerShell/PowerShellEditorServices:andschwa/fix-getoffsetCopy head branch name to clipboard
Merged
Fix off-by-one error in validation within GetOffsetAtPosition#1669andyleejordan merged 1 commit intomasterPowerShell/PowerShellEditorServices:masterfrom andschwa/fix-getoffsetPowerShell/PowerShellEditorServices:andschwa/fix-getoffsetCopy head branch name to clipboard
GetOffsetAtPosition#1669andyleejordan merged 1 commit into
masterPowerShell/PowerShellEditorServices:masterfrom
andschwa/fix-getoffsetPowerShell/PowerShellEditorServices:andschwa/fix-getoffsetCopy head branch name to clipboard
Conversation
The incoming line number is 1-indexed (not 0-indexed), so while the lower limit was correctly set to 1, the upper limit was set to `FileLines.Count` which could be 0, but 0 lines implies an upper limit of 1 with this indexing. See `ScriptFile.GetLine` for the only other use of this 1-index range validation.
| public int GetOffsetAtPosition(int lineNumber, int columnNumber) | ||
| { | ||
| Validate.IsWithinRange("lineNumber", lineNumber, 1, this.FileLines.Count); | ||
| Validate.IsWithinRange("lineNumber", lineNumber, 1, this.FileLines.Count + 1); |
Collaborator
There was a problem hiding this comment.
Maybe this should just be a separate check for FileLines.Count == 0? I feel like the check is correct here, it just doesn't account for empty? Maybe it should be Math.Max(this.FileLines.Count, 1)?
Member
Author
There was a problem hiding this comment.
The use of IsWithinRange does not work well with 1-indexed lists that could be empty. I agree this looks weird, but it's what's done here too:
Member
Author
|
@SeeminglyScience I'm going to merge this for now so that the user reported issue can be tested. We can revert if needed. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The incoming line number is 1-indexed (not 0-indexed), so while the
lower limit was correctly set to 1, the upper limit was set to
FileLines.Countwhich could be 0, but 0 lines implies an upper limitof 1 with this indexing. See
ScriptFile.GetLinefor the only other useof this 1-index range validation.
Fixes #1663.