Skip to content

Sharing PathNormalizer Implementations #57178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Aug 6, 2024
Merged

Sharing PathNormalizer Implementations #57178

merged 7 commits into from
Aug 6, 2024

Conversation

@ladeak
Copy link
Contributor

@ladeak ladeak commented Aug 5, 2024 •
edited
Loading

Sharing PathNormalizer Implementations

Sharing PathNormalizer Implementations between HttpSys and Kestrel servers

Description

  • Follow up PR on comment: Remove unsafe from PathNormalizer #56805 (comment)
  • Moving PathNormalizer from Shared\HttpSys to Shared\PathNormalizer (any other suggestions welcome), changing the namespace to Microsoft.AspNetCore.Internal
  • Sharing this file with HttpSys and Kestrel.Core
  • Remaining Kestrel specific code renamed to PathDecoder (open for suggestions)
  • Keeping the tests and benchmarks in Kestrel

Linked to #56534

@ghost ghost added the area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions label Aug 5, 2024
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Aug 5, 2024
@ladeak ladeak mentioned this pull request Aug 5, 2024
Merged
@ladeak ladeak marked this pull request as draft August 5, 2024 20:37
Merging PathNormalizer Implementations
ca16213 
- Follow up on comment: dotnet#56805 (comment)
- Moving PathNormalizer from Shared\HttpSys to Shared\PathNormalizer, changing the namespace to AspNetCore.Internal
- Shares the code between HttpSys and Kestrel.Core
- Remaining Kestrel specific code renamed to PathDecoder
- Keeping the tests and benchmarks in Kestrel
@ladeak ladeak force-pushed the ladeak-56534-merge-pathnormalizer branch from 8e0e0b8 to ca16213 Compare August 5, 2024 20:42
@ladeak ladeak marked this pull request as ready for review August 5, 2024 20:43
@build-analysis build-analysis bot mentioned this pull request Aug 5, 2024
Closed
3 tasks
@BrennanConroy
Copy link
Member

Looks like you missed including the shared file in the httpsys csproj

@ladeak @gfoidl
Update src/Servers/Kestrel/Core/src/Internal/Http/PathDecoder.cs
f786c49 
Co-authored-by: Günther Foidl <gue@korporal.at>
@ladeak
Copy link
Contributor Author

ladeak commented Aug 6, 2024

Thank you @BrennanConroy I will follow up on that.

halter73
halter73 approved these changes Aug 6, 2024
View reviewed changes
Copy link
Member

@halter73 halter73 left a comment

Choose a reason for hiding this comment

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

LGTM, but I'll wait for @BrennanConroy to take a look to merge.

BrennanConroy
BrennanConroy reviewed Aug 6, 2024
View reviewed changes
src/Servers/Kestrel/Core/test/Microsoft.AspNetCore.Server.Kestrel.Core.Tests.csproj Outdated
<Compile Include="$(SharedSourceRoot)test\Shared.Tests\runtime\Http2\*.cs" LinkBase="Shared\runtime\Http2" />
<Compile Include="$(SharedSourceRoot)test\Shared.Tests\runtime\Http3\*.cs" LinkBase="Shared\runtime\Http3" />
<Compile Include="$(SharedSourceRoot)TestResources.cs" LinkBase="Shared" />
<Compile Include="$(SharedSourceRoot)test\Shared.Tests\PathNormalizerTests.cs" LinkBase="/" />
Copy link
Member

Choose a reason for hiding this comment

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

I think this is causing these tests to run again. They should already be running from the Shared.Tests.csproj.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I can remove this line.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. I wonder though how "discoverability" can be improved as the shared files are linked ie. in Kestrel.slnf but changing and finding corresponding unit tests are not that easy as the projects are not linked. Or is there a better slnf to edit.

ie. I did not notice this file exists until the failure in the CI, while I knew about the PathNormaizers.

@BrennanConroy BrennanConroy merged commit 71ddc60 into dotnet:main Aug 6, 2024
@dotnet-policy-service dotnet-policy-service bot added this to the 9.0-rc1 milestone Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@halter73 halter73 halter73 approved these changes

@BrennanConroy BrennanConroy BrennanConroy approved these changes

@JamesNK JamesNK Awaiting requested review from JamesNK JamesNK is a code owner

@mgravell mgravell Awaiting requested review from mgravell

+1 more reviewer

@gfoidl gfoidl gfoidl left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Milestone

9.0-rc1

Development

Successfully merging this pull request may close these issues.

4 participants

@ladeak @BrennanConroy @halter73 @gfoidl