Fix IndexOutOfRangeException in InjectSnippetsIntoFile at end of file#315
Merged
rgregg-msft merged 3 commits intoOneDrive:masterfrom Mar 16, 2026
Merged
Conversation
Add bounds check before accessing ElementAt(insertionLine + 1) after Splice shrinks the collection. When snippet injection occurs at or near the end of a file, the index would exceed collection bounds. Also extracts the core snippet injection logic into a testable internal method (ProcessSnippetInjection) and adds a new test project (ApiDoctor.Console.UnitTests) with 12 tests covering FileSplicer and snippet injection scenarios including the end-of-file boundary case. Fixes OneDrive#314 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
MIchaelMainer
approved these changes
Mar 10, 2026
…alsVisibleTo - Make ProcessSnippetInjection return type nullable (IEnumerable<string>?) to match the null return path - Remove redundant <InternalsVisibleTo> from csproj since it's already declared in AssemblyInfo.cs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
@MIchaelMainer good points, addressed both |
MIchaelMainer
approved these changes
Mar 10, 2026
Collaborator
|
Blocked by required check that may no longer be running. |
MIchaelMainer
approved these changes
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a crash in
InjectSnippetsIntoFilewhen snippet injection occurs at or near the end of a documentation file.Problem
After
Spliceremoves the old snippet tab section, the collection shrinks. The code then unconditionally accessesupdatedFileContents.ElementAt(insertionLine + 1)without checking bounds, causing anArgumentOutOfRangeException.Changes
ElementAt(insertionLine + 1)in theInsertSnippetsblockProcessSnippetInjectioninternal method, keeping file I/O in the original wrapperApiDoctor.Console.UnitTestsproject with 12 NUnit tests coveringFileSplicerand snippet injection scenarios, including the end-of-file boundary case that triggered the crashTesting
microsoft-graph-docsrepo (18,467 files) withgenerate-snippetscommand - no crashesFixes #314