Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Fix missing upper-bound guard in LastIndexOf and FindLastIndex - #124161

Merged
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof
Feb 17, 2026
Merged

Fix missing upper-bound guard in LastIndexOf and FindLastIndex#124161
ViveliDuCh merged 2 commits into
dotnet:mainfrom
prozolic:immutablelistlastindexof

Conversation

@prozolic

@prozolicprozolic commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

fixes#70950

Add the missing index < Count validation to LastIndexOf and FindLastIndex on ImmutableList<T>.Node.cs.
Previously, passing index == Count did not throw ArgumentOutOfRangeException and instead returned an incorrect (off-by-one) result silently. This aligns the behavior with ImmutableArray.

Changes:

  • LastIndexOf: Add upper-bound check to the Requires.Range validation (index >= 0 && index < this.Count)
  • FindLastIndex(int, int, Predicate<T>): Add upper-bound check to the Requires.Range validation (startIndex >= 0 && startIndex < this.Count)
  • Both: Return -1 when called with an empty range (starting index is 0 and count is 0)

Add the missing index < Count validation to LastIndexOf and
FindLastIndex on ImmutableList<T>.Node. Previously, passing
index == Count did not throw ArgumentOutOfRangeException and
instead returned an incorrect (off-by-one) result silently.
This aligns the behavior with ImmutableArray.
CopilotAI review requested due to automatic review settings February 9, 2026 02:35
@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Feb 9, 2026
@prozolic
prozolic marked this pull request as ready for review February 9, 2026 02:36
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes an off-by-one/validation hole in ImmutableList<T> search APIs by adding missing upper-bound checks for LastIndexOf and FindLastIndex, aligning behavior with ImmutableArray<T> (notably throwing when index/startIndex == Count) and handling the empty-range case consistently.

Changes:

  • Add index/startIndex < Count validation to ImmutableList<T>.Node.LastIndexOf and ImmutableList<T>.Node.FindLastIndex(startIndex, count, match).
  • Return -1 for the empty-range case (startIndex/index == 0 && count == 0) instead of throwing.
  • Expand test coverage for single-element lists, multiple matches, and the index/startIndex == Count failure mode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

FileDescription
src/libraries/System.Collections.Immutable/tests/IndexOfTests.csExtends shared LastIndexOf test helper to cover single-element cases and index == Count validation.
src/libraries/System.Collections.Immutable/tests/ImmutableListTestBase.csAdds FindLastIndex coverage for single/multi-element lists and multiple matches, including startIndex == Count throwing.
src/libraries/System.Collections.Immutable/tests/ImmutableListTest.csAdds targeted regression tests for multiple matches and consistency with ImmutableArray<T> throwing behavior.
src/libraries/System.Collections.Immutable/src/System/Collections/Immutable/ImmutableList_1.Node.csImplements the missing upper-bound guards and the empty-range -1 behavior in the underlying node search methods.

@stephentoub

Copy link
Copy Markdown
Member

🤖 Copilot Code Review — PR #124161

Holistic Assessment

Motivation: This PR addresses a real bug where ImmutableList<T>.LastIndexOf and FindLastIndex returned incorrect (off-by-one) results when index == Count, silently accepting invalid input instead of throwing. The linked issue #70950 has clear reproduction and was acknowledged as a bug by maintainers.

Approach: The fix correctly adds the missing upper-bound validation (index < this.Count) and handles the empty-range edge case (index == 0 && count == 0) by returning -1 before validation. This matches the existing pattern in ImmutableArray<T> and aligns with List<T> behavior for non-empty collections.

Net positive: ✅ This is a net positive — it fixes a documented bug, aligns behavior with ImmutableArray, and adds comprehensive test coverage.


Detailed Findings

✅ Implementation Matches ImmutableArray Pattern

The implementation follows the exact pattern used in ImmutableArray_1.cs (lines 256-262) and ImmutableArray_1.Builder.cs (lines 891-896):

  • Early return for startIndex == 0 && count == 0 returning -1
  • Then Requires.Range(index >= 0 && index < this.Count, nameof(index))

This ensures consistency across the immutable collection types.

✅ FindLastIndex Also Correctly Fixed

The FindLastIndex(int startIndex, int count, Predicate<T> match) overload had the same bug and is fixed with the same pattern. The Requires.NotNull(match, ...) check is correctly kept before the early return, ensuring null arguments are still validated.

✅ Test Coverage is Comprehensive

The tests cover:

  • Empty collections with index=0, count=0 → returns -1
  • Single-element lists with valid and invalid indices
  • Multiple-element lists with multiple matches
  • index == Count → throws ArgumentOutOfRangeException
  • Cross-validation with ImmutableArray behavior (LastIndexOfConsistentWithImmutableArray)
  • Exhaustive iteration through index/count combinations matching List<T> behavior

💡 Minor Suggestion: Consider count == 0 with index > 0 behavior

The current implementation requires index < Count even when count == 0 (except for the special case index == 0 && count == 0). For example, LastIndexOf(item, index: 2, count: 0) on a 2-element list will throw.

List<T>.LastIndexOf with count == 0 returns -1 without throwing (for any valid index <= Count - 1). ImmutableArray has the same behavior as this PR (throws when index >= Length even if count == 0).

Since this matches ImmutableArray, the current behavior is correct for consistency. Just flagging that List<T> differs slightly here.

✅ Breaking Change is Documented and Justified

This is a bucket 2 breaking change (decreasing the range of accepted parameter values). However:

  1. The previous behavior was buggy (returning incorrect indices)
  2. The new behavior aligns with ImmutableArray and List<T> for the index >= Count case
  3. Code relying on the previous behavior was likely already buggy

Summary

LGTM. The fix correctly addresses the off-by-one bug in LastIndexOf and FindLastIndex by adding the missing index < this.Count validation while handling the empty-range edge case. The implementation matches ImmutableArray's pattern exactly, and comprehensive tests verify both the throwing and correct-result behaviors.

@ViveliDuCh
ViveliDuCh self-requested a review February 10, 2026 22:29
@ViveliDuCh

Copy link
Copy Markdown
Member

@prozolic Thanks for picking this up and for the thorough fix! The changes to both LastIndexOf and FindLastIndex look good to me — the added upper-bound guard on index/startIndex brings ImmutableList in line with ImmutableArray, and the tests cover the key scenarios well.

@ViveliDuCh
ViveliDuCh merged commit 786c1e3 into dotnet:mainFeb 17, 2026
90 checks passed
@prozolic
prozolic deleted the immutablelistlastindexof branch February 18, 2026 10:52
ViveliDuCh pushed a commit that referenced this pull request Feb 24, 2026
This PR is a follow-up to #124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
…t#124161)
Add the missing index < Count validation to `LastIndexOf` and
`FindLastIndex` on `ImmutableList<T>.Node.cs`.
Previously, passing index == Count did not throw
`ArgumentOutOfRangeException` and instead returned an incorrect
(off-by-one) result silently. This aligns the behavior with
ImmutableArray.
Changes:
- `LastIndexOf`: Add upper-bound check to the Requires.Range validation
(`index >= 0 && index < this.Count`)
- `FindLastIndex(int, int, Predicate<T>)`: Add upper-bound check to the
Requires.Range validation (`startIndex >= 0 && startIndex < this.Count`)
- Both: Return -1 when called with an empty range (starting index is 0
and count is 0)
dotnet#70950
iremyux pushed a commit to iremyux/dotnet-runtime that referenced this pull request Mar 2, 2026
This PR is a follow-up to dotnet#124161.
Change `Requires.Argument(index - count + 1 >= 0)` to
`Requires.Range(index - count + 1 >= 0, nameof(count))` in
`ImmutableList<T>.Node.LastIndexOf` to align with the validation used in
`ImmutableArray<T>.LastIndexOf`.
Changes:
- Use `Requires.Range` in `ImmutableList<T>.Node.LastIndexOf` for
validating the `index` and `count` parameters.
- Add a test case to verify that an `ArgumentOutOfRangeException` is
thrown when validation of the `index` and `count` parameters in
`LastIndexOf` and `FindLastIndex` fails.
- Fix test case to also validate the parameter name.
- Rename `ImmutableList<T>.Node.LastIndexOf` index param to startIndex
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Mar 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Collectionscommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ImmutableList<T>.LastIndexOf(...) appears to be missing a guard clause

5 participants

@prozolic@stephentoub@ViveliDuCh@jeffhandley