Visitar URL original
Fix components-key validation timeouts under load by Copilot · Pull Request #3108 · microsoft/OpenAPI.NET · GitHub
Skip to content

Fix components-key validation timeouts under load - #3108

Merged
Vincent Biret (baywet) merged 5 commits into
mainfrom
copilot/fix-components-key-validation-timeout
Oct 9, 2026
Merged

Fix components-key validation timeouts under load#3108
Vincent Biret (baywet) merged 5 commits into
mainfrom
copilot/fix-components-key-validation-timeout

Conversation

Copilot AI commented Oct 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Pull Request

Description

Components-key validation can throw RegexMatchTimeoutException during LoadAsync when scheduling or GC pauses exceed its 100 ms timeout. This change removes timeout-dependent matching while preserving accepted keys and error messages.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other (please describe):

Related Issue(s)

Changes Made

  • .NET 8+: Source-generate the existing regex; its generated matching path contains no timeout checks.
  • .NET Standard 2.0: Use an equivalent linear character scan, preserving the $ anchor’s acceptance of one final newline.
  • Regression coverage: Exercise both matchers across character and newline boundaries, plus LoadAsync with million-character valid and invalid keys.

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • All existing tests pass

Checklist

  • My code follows the code style of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Versions applicability

  • My change applies to the version 1.X of the library, if so PR link:
  • My change applies to the version 2.X of the library, if so PR link:
  • My change applies to the version 3.X of the library, if so PR link:
  • I have evaluated the applicability of my change against the other versions above.

See the contributing guidelines for more information about how patches are applied across multiple versions.

Additional Notes

RegexOptions.NonBacktracking is deliberately omitted: it prevents source generation and falls back to a runtime regex.

Copilot AI linked an issue Oct 9, 2026 that may be closed by this pull request
Components-key validation can fail LoadAsync under load: 100 ms wall-clock timeout on a linear regex #3101
Closed
@baywet
fix(library): avoid components key validation timeouts under load
6bf72b6 
Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix components-key validation timeout issue during LoadAsync Fix components-key validation timeouts under load Oct 9, 2026
baywet
Vincent Biret (baywet) requested changes Oct 9, 2026
View reviewed changes
Comment thread test/Microsoft.OpenApi.Tests/Validations/OpenApiComponentsValidationTests.cs Resolved
Comment thread src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs Resolved
github-advanced-security[bot]
github-advanced-security Bot found potential problems Oct 9, 2026
View reviewed changes
Comment thread src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs Fixed
@baywet
fix(library): use conditional regex fallback for older frameworks
ce2211c 
Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>
@github-code-quality

github-code-quality Bot commented Oct 9, 2026 •
edited
Loading

Copy link
Copy Markdown

Code Coverage Overview

Languages: C#

C# / code-coverage/dotnet

The overall line coverage in commit 0a241bd in the copilot/fix-componen... branch is 61%. The line coverage in commit c719c42 in the main branch is 32%.

Show a line coverage summary of the most impacted files.
File main c719c42 copilot/fix-componen... 0a241bd +/-
/_/src/Humanize...lePrefixSort.cs 0% 0% 0%
/_/src/Humanize...tes/ByteRate.cs 0% 0% 0%
/_/src/Humanize...tes/ByteSize.cs 0% 0% 0%
/_/src/Humanize...zeExtensions.cs 0% 0% 0%
/_/src/Humanize...ngExtensions.cs 0% 0% 0%
/_/src/Humanize...zeExtensions.cs 0% 0% 0%
/_/src/Humanize...tterRegistry.cs 0% 0% 0%
/_/src/Humanize...orExtensions.cs 0% 4% +4%
/_/src/Humanize...s/Vocabulary.cs 0% 68% +68%
/_/src/Humanize...Vocabularies.cs 0% 100% +100%

Updated October 09, 2026 14:29 UTC

@baywet
Vincent Biret (baywet) requested a balanced review from Copilot October 9, 2026 13:26
@baywet
Vincent Biret (baywet) marked this pull request as ready for review October 9, 2026 13:26
@baywet
Vincent Biret (baywet) requested a review from a team as a code owner October 9, 2026 13:26
@baywet
Vincent Biret (baywet) enabled auto-merge (squash) October 9, 2026 13:26
Copilot AI reviewed Oct 9, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The supported netstandard2.0 path retains the finite timeout and is not exercised by the new tests.

2 open findings
What changed in this PR

Fixes nondeterministic component-key validation timeouts during OpenAPI loading.

Changes:

  • Adds source-generated regex matching for .NET 8+.
  • Adds component-key boundary and long-key regression tests.
  • Documents repository regex-handling conventions.
File Description
OpenApiComponentsRules.cs Introduces target-specific regex matching.
OpenApiComponentsValidationTests.cs Adds validation and load regression tests.
agents.md Documents regex conventions.

🧠 Review effort: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs Resolved
Comment thread test/Microsoft.OpenApi.Tests/Validations/OpenApiComponentsValidationTests.cs Resolved
@sonarqubecloud

sonarqubecloud Bot commented Oct 9, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

This was referenced Nov 11, 2026
Closed
Open
Closed
Closed
Closed
Open
Open
Open
Closed
Open
Open
Open
Open
Merged
Open
Open
Closed
Open
Open
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@peombwa Peter Ombwa (peombwa) peombwa approved these changes
@baywet Vincent Biret (baywet) Awaiting requested review from baywet
+1 more reviewer
@github-advanced-security github-advanced-security[bot] github-advanced-security[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@baywet Vincent Biret (baywet)

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Components-key validation can fail LoadAsync under load: 100 ms wall-clock timeout on a linear regex

5 participants

@peombwa @baywet @github-advanced-security