-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add warning about usage of PreSendRequestHeaders and PreSendRequestContent #4002
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.
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
Conversation
|
Looks good. |
mairaw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution @yaananth. I've left some feedback for you to consider. The same comment would apply to the 2nd change.
xml/System.Web/HttpApplication.xml
Outdated
| For more information about how to handle events, see [NIB: Consuming Events](http://msdn.microsoft.com/en-us/01e4f1bc-e55e-413f-98c7-6588493e5f67). | ||
| > [!WARNING] | ||
| > Do not use `PreSendRequestContent` with managed modules that implement `IHttpModule`. Setting these properties can cause issues with asynchronous requests. We have seen instances where the combination of Application Requested Routing(ARR) and websockets lead to access violation exceptions (iiscore!W3_CONTEXT_BASE::GetIsLastNotification+68 in iiscore.dll has caused an access violation exception (0xC0000005)) that lead to w3wp crashing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing space between term and acronym: Application Requested Routing (ARR)
The use of we is not recommended unless we're using it to refer to we Microsoft recommends. Also the last sentence is a bit hard to parse giving it has lead 2x and that info on parentheses breaking the flow. I'm wondering if that info is really needed.
Maybe something like this?
"The combination of Application Requested Routing (ARR) and websockets might lead to access violation exceptions that can cause w3wp to crash. For example, iiscore!W3_CONTEXT_BASE::GetIsLastNotification+68 in iiscore.dll has caused an access violation exception (0xC0000005)."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mairaw I think that's the MS recommendation.
I like your rewrite.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it's in the style guide @Rick-Anderson. I'm glad you liked it. Thanks!
|
@mairaw Addressed. |
mairaw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making the suggested changes @yaananth. I'll merge as soon as I can verify the build and changes should be live in the next day or so.
see https://github.com/aspnet/Docs/pull/5054/files
I don't know where we place warnings generally, but I placed it under "Remarks"