Skip to content
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

Style. #1402

Merged
merged 2 commits into from
Feb 10, 2021
Merged

Style. #1402

Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 2 additions & 8 deletions draft-ietf-httpbis-proxy-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Parameters on each member convey additional information about that intermediary'

When adding a value to the Proxy-Status field, intermediaries SHOULD preserve the existing members of the field, to allow debugging of the entire chain of intermediaries handling the request.

Proxy-Status MAY be sent in HTTP trailers. For example, if an intermediary is streaming a response and the upstream connection suddenly terminates, Proxy-Status can be appended to the trailers of the outgoing message (since the headers have already been sent). As with all trailers, it might be silently discarded along the path to the user agent, so this SHOULD NOT be done unless it is not possible to send it in headers, and an intermediary MUST NOT send Proxy-Status as a trailer field unless it has also sent a corresponding Proxy-Status header field in the same message, so that the trailer value's ordering relative to other intermediaries is preserved.
Proxy-Status MAY be sent in HTTP trailers. For example, if an intermediary is streaming a response and the upstream connection suddenly terminates, Proxy-Status can be appended only to the trailers of the outgoing message, since the headers have already been sent. As with all trailers, it might be silently discarded along the path to the user agent, so this SHOULD NOT be done unless it is not possible to send it in headers, and an intermediary MUST NOT send Proxy-Status as a trailer field unless it has also sent a corresponding Proxy-Status header field in the same message, so that the trailer value's ordering relative to other intermediaries is preserved.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Proxy-Status MAY be sent in HTTP trailers. For example, if an intermediary is streaming a response and the upstream connection suddenly terminates, Proxy-Status can be appended only to the trailers of the outgoing message, since the headers have already been sent. As with all trailers, it might be silently discarded along the path to the user agent, so this SHOULD NOT be done unless it is not possible to send it in headers, and an intermediary MUST NOT send Proxy-Status as a trailer field unless it has also sent a corresponding Proxy-Status header field in the same message, so that the trailer value's ordering relative to other intermediaries is preserved.
Proxy-Status MAY be sent in HTTP trailers. For example, if an intermediary is streaming a response and the upstream connection suddenly terminates, Proxy-Status can be appended to the trailers of the outgoing message, since the headers have already been sent. As with all trailers, it might be silently discarded along the path to the user agent, so this SHOULD NOT be done unless it is not possible to send it in headers, and an intermediary MUST NOT send Proxy-Status as a trailer field unless it has also sent a corresponding Proxy-Status header field in the same message, so that the trailer value's ordering relative to other intermediaries is preserved.

'only' seems inappropriate here, since we subsequently advise that it needs to be sent as a header to be included in trailers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I accepted this change, but how am I misreading it? The sentence says:

[...], Proxy-Status can be only appended to the trailers of the outgoing message, since the headers have already been sent.

so we're referring to the case where headers have been already sent, forwarding of the response body has been interrupted, and the only way that we can send Proxy-Status is in the trailers. How is it inappropriate?

I'm not a native speaker, but every time I read it without "only", it just felt wrong.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, never mind, you're correct; I misread. I'll merge this and reinstate it.


Origin servers MUST NOT generate the Proxy-Status field.

Expand Down Expand Up @@ -292,7 +292,7 @@ This section lists the Proxy Error Types defined by this document. See {{registe

### Connection Limit Reached

* Name: connnection_limit_reached
* Name: connection_limit_reached
* Description: The intermediary is configured to limit the number of connections it has to the next hop, and that limit has been passed.
* Extra Parameters: None.
* Recommended HTTP status code: 503
Expand Down Expand Up @@ -325,7 +325,6 @@ Note that additional information about the error can be recorded in the details
* Recommended HTTP status code: 502
* Notes: Responses with this error type might not have been generated by the intermediary.


### HTTP Request Error

* Name: http_request_error
Expand All @@ -343,7 +342,6 @@ Note that additional information about the error can be recorded in the details
* Extra Parameters: None.
* Recommended HTTP status code: 403


### HTTP Incomplete Response

* Name: http_response_incomplete
Expand Down Expand Up @@ -429,7 +427,6 @@ Note that additional information about the error can be recorded in the details
* Extra Parameters: None.
* Recommended HTTP status code:


### Proxy Internal Error

* Name: proxy_internal_error
Expand All @@ -439,7 +436,6 @@ Note that additional information about the error can be recorded in the details

Note that additional information about the error can be recorded in the details parameter (as is the case for all errors).


### Proxy Configuration Error

* Name: proxy_configuration_error
Expand All @@ -449,7 +445,6 @@ Note that additional information about the error can be recorded in the details

Note that additional information about the error can be recorded in the details parameter (as is the case for all errors).


### Proxy Loop Detected

* Name: proxy_loop_detected
Expand All @@ -458,7 +453,6 @@ Note that additional information about the error can be recorded in the details
* Recommended HTTP status code: 502



## Defining New Proxy Error Types {#register-error}

New Proxy Error Types can be defined by registering them in the HTTP Proxy Error Types registry.
Expand Down