Repository navigation
Keep the whole catch-all parameter value in formatted HTTP paths - #7884
johnkaram02 wants to merge 1 commit into
Conversation
HttpRouteFormatter took only the first path segment of a catch-all route parameter such as {*path}, so the formatted request path was truncated and the redactor saw only part of the value. Use the rest of the path for catch-all parameters, as HttpRouteParser already does.
|
@johnkaram02 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1647341&view=codecoverage-tab |
Fixes #7883
HttpRouteFormatter.Formatbuilds the logged request path in the defaultFormattedpath logging mode for both incoming (AddHttpLoggingRedaction) and outgoing (AddExtendedHttpClientLogging) HTTP logging. For a catch-all route parameter such as{*path}or{**path}, it took only the first path segment of the value and dropped the rest of the path. For example, routeapi/{userId}/files/{*path}with pathapi/user1/files/a/b/cwas logged asapi/[REDACTED]/files/a, and a redactor forpathreceived onlya.#5466 fixed the same problem in
HttpRouteParser.TryExtractParameters(theStructuredmode). This change applies the same rule in the formatter: a catch-all parameter takes the rest of the path.Changes
HttpRouteFormatter.Formatuses the rest of the path whensegment.IsCatchAllis set, matchingHttpRouteParser.HttpRouteFormatterTests.Format_RouteHasCatchAllParameter_RedactsWholeValueandFormat_RouteHasCatchAllParameter_KeepsWholeValue, which cover{*path},{**path}, a trailing/after the catch-all parameter, and a redacted parameter before it.Testing
dotnet test test/Libraries/Microsoft.Extensions.Telemetry.Tests -f net10.0 -- --filter-class "*HttpRouteFormatterTests"Expected: "api/files/Redacted:a/b/c",Actual: "api/files/Redacted:a".Microsoft.Extensions.Telemetry.Tests,Microsoft.Extensions.Http.Diagnostics.TestsandMicrosoft.AspNetCore.Diagnostics.Middleware.Testsprojects.Microsoft Reviewers: Open in CodeFlow