Skip to content

Commit

Permalink
Rename RequestHead::uri to RequestHead::target (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeMathWalker committed Jan 2, 2024
1 parent 7597f43 commit 2bbde9e
Show file tree
Hide file tree
Showing 22 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion doc_examples/guide/request_data/path/project-raw_path.snap
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;
pub fn handler(head: &RequestHead) -> StatusCode {
println!("The raw path is: {}", head.uri.path());
println!("The raw path is: {}", head.target.path());
StatusCode::OK
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;

pub fn handler(head: &RequestHead) -> StatusCode {
println!("The raw path is: {}", head.uri.path());
println!("The raw path is: {}", head.target.path());
StatusCode::OK
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;
pub fn handler(head: &RequestHead) -> StatusCode {
if let Some(raw_query /* (1)! */) = head.uri.query() {
if let Some(raw_query /* (1)! */) = head.target.query() {
println!("The raw query is `{raw_query}`");
} else {
println!("There is no query string");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;

pub fn handler(head: &RequestHead) -> StatusCode {
if let Some(raw_query /* (1)! */) = head.uri.query() {
if let Some(raw_query /* (1)! */) = head.target.query() {
println!("The raw query is `{raw_query}`");
} else {
println!("There is no query string");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;
pub fn handler(head: &RequestHead) -> StatusCode {
println!("The request target is {}", head.uri);
println!("The request target is {}", head.target);
// [...]
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ use pavex::http::StatusCode;
use pavex::request::RequestHead;

pub fn handler(head: &RequestHead) -> StatusCode {
println!("The request target is {}", head.uri);
println!("The request target is {}", head.target);
StatusCode::OK
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use pavex::request::RequestHead;
pub fn handler(head: &RequestHead) -> StatusCode {
println!("The HTTP method is {}", head.method);
println!("The HTTP version is {:?}", head.version);
println!("The request target is {}", head.uri);
println!("The request target is {}", head.target);
println!("There are {} headers", head.headers.len());
StatusCode::OK
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use pavex::request::RequestHead;
pub fn handler(head: &RequestHead) -> StatusCode {
println!("The HTTP method is {}", head.method);
println!("The HTTP version is {:?}", head.version);
println!("The request target is {}", head.uri);
println!("The request target is {}", head.target);
println!("There are {} headers", head.headers.len());
StatusCode::OK
}
4 changes: 2 additions & 2 deletions docs/guide/request_data/path/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ more details.

## Injection

Inject [`RequestHead`][RequestHead] to access the raw path via its [`uri`][RequestHead::uri] field:
Inject [`RequestHead`][RequestHead] to access the raw path via its [`target`][RequestHead::target] field:

--8<-- "doc_examples/guide/request_data/path/project-raw_path.snap"

[RequestHead]: ../../../api_reference/pavex/request/struct.RequestHead.html
[RequestHead::uri]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.uri
[RequestHead::target]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.target
2 changes: 1 addition & 1 deletion docs/guide/request_data/path/route_parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ to know more about the underlying mechanism.
[^relationship]: [`RouteParams<T>`][RouteParams] is built on top of [`RawRouteParams`][RawRouteParams].

[RequestHead]: ../../../api_reference/pavex/request/struct.RequestHead.html
[RequestHead::uri]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.uri
[RequestHead::target]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.target
[RouteParams]: ../../../api_reference/pavex/request/route/struct.RouteParams.html
[RouteParamsMacro]: ../../../api_reference/pavex/request/route/attr.RouteParams.html
[serde::Deserialize]: https://docs.rs/serde/latest/serde/trait.Deserialize.html
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/request_data/query/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ out of the raw query.

## Injection

Inject [`RequestHead`][RequestHead] to access the raw query via its [`uri`][RequestHead::uri] field:
Inject [`RequestHead`][RequestHead] to access the raw query via its [`uri`][RequestHead::target] field:

--8<-- "doc_examples/guide/request_data/query/project-raw_query.snap"

1. The query string is an optional component of the request target. It may not be there!

[RequestHead]: ../../../api_reference/pavex/request/struct.RequestHead.html
[RequestHead::uri]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.uri
[RequestHead::target]: ../../../api_reference/pavex/request/struct.RequestHead.html#structfield.target
6 changes: 3 additions & 3 deletions docs/guide/request_data/request_target.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ e.g. `/foo/bar?baz=qux`.

## Injection

Inject [`RequestHead`][RequestHead] to access the request target via its [`uri`][RequestHead::uri] field:
Inject [`RequestHead`][RequestHead] to access the request target via its [`target`][RequestHead::target] field:

--8<-- "doc_examples/guide/request_data/request_target/project-target.snap"

Expand All @@ -33,8 +33,8 @@ to perform more advanced processing—e.g. parsing query parameters or [route pa
[^rfc]: [RFC 7230](https://datatracker.ietf.org/doc/html/rfc7230#section-5.3) allows two other formats of request target,
authority form (e.g. `example.com:443`) and asterisk form (e.g. `*`).
For both alternative formats there is a canonical conversion into a URI (_effective request URI_).
Pavex takes care of the conversion automatically; you can access [`RequestHead::uri`][RequestHead::uri]
Pavex takes care of the conversion automatically; you can access [`RequestHead::target`][RequestHead::target]
without having to worry about it.

[RequestHead]: ../../api_reference/pavex/request/struct.RequestHead.html
[RequestHead::uri]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.uri
[RequestHead::target]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.target
2 changes: 1 addition & 1 deletion docs/guide/request_data/wire_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ You can always inject both types if you need to look at the entire request at on
[RequestHead::version]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.version
[RequestHead::method]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.method
[RequestHead::headers]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.headers
[RequestHead::uri]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.uri
[RequestHead::target]: ../../api_reference/pavex/request/struct.RequestHead.html#structfield.target
[RawIncomingBody]: ../../api_reference/pavex/request/body/struct.RawIncomingBody.html
2 changes: 1 addition & 1 deletion examples/realworld/api_server_sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ async fn route_request(
#[allow(unused)]
let request_body = pavex::request::body::RawIncomingBody::from(request_body);
let request_head: pavex::request::RequestHead = request_head.into();
let matched_route = match server_state.router.at(&request_head.uri.path()) {
let matched_route = match server_state.router.at(&request_head.target.path()) {
Ok(m) => m,
Err(_) => {
let allowed_methods: pavex::router::AllowedMethods = pavex::router::MethodAllowList::from_iter(
Expand Down
2 changes: 1 addition & 1 deletion examples/realworld/conduit_core/src/telemetry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ impl RootSpan {
user_agent.original = %user_agent,
http.response.status_code = tracing::field::Empty,
http.route = %matched_route,
http.target = %request_head.uri.path_and_query().map(|p| p.as_str()).unwrap_or(""),
http.target = %request_head.target.path_and_query().map(|p| p.as_str()).unwrap_or(""),
// 👇 fields that we can't fill out _yet_ because we don't have access to connection info
//
// http.scheme = %$crate::root_span_macro::private::http_scheme(connection_info.scheme()),
Expand Down
2 changes: 1 addition & 1 deletion examples/skeleton/app_server_sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ async fn route_request(
#[allow(unused)]
let request_body = pavex::request::body::RawIncomingBody::from(request_body);
let request_head: pavex::request::RequestHead = request_head.into();
let matched_route = match server_state.router.at(&request_head.uri.path()) {
let matched_route = match server_state.router.at(&request_head.target.path()) {
Ok(m) => m,
Err(_) => {
let allowed_methods: pavex::router::AllowedMethods = pavex::router::MethodAllowList::from_iter(
Expand Down
6 changes: 3 additions & 3 deletions libs/pavex/src/request/body/buffered_body.rs
Original file line number Diff line number Diff line change
Expand Up @@ -262,15 +262,15 @@ mod tests {
fn dummy_request_head() -> RequestHead {
RequestHead {
method: http::Method::GET,
uri: "/".parse().unwrap(),
target: "/".parse().unwrap(),
version: http::Version::HTTP_11,
headers: HeaderMap::new(),
}
}

#[tokio::test]
async fn error_if_body_above_size_limit_without_content_length() {
let body = crate::response::body::body_::Full::new(Bytes::from(vec![0; 1000]));
let body = crate::response::body::raw::Full::new(Bytes::from(vec![0; 1000]));
// Smaller than the size of the body.
let max_n_bytes = 100;
let err = BufferedBody::_extract_with_limit(&dummy_request_head(), body, max_n_bytes)
Expand All @@ -297,7 +297,7 @@ mod tests {
// Smaller than the value declared in the `Content-Length` header,
// even though it's bigger than the actual size of the body.
let max_n_bytes = 100;
let body = crate::response::body::body_::Full::new(Bytes::from(vec![0; 500]));
let body = crate::response::body::raw::Full::new(Bytes::from(vec![0; 500]));
request_head
.headers
.insert("Content-Length", "1000".parse().unwrap());
Expand Down
2 changes: 1 addition & 1 deletion libs/pavex/src/request/body/json.rs
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ mod tests {
let request_head = crate::request::RequestHead {
headers,
method: http::Method::GET,
uri: "/".parse().unwrap(),
target: "/".parse().unwrap(),
version: http::Version::HTTP_11,
};
let body = serde_json::json!({
Expand Down
2 changes: 1 addition & 1 deletion libs/pavex/src/request/query/query_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ impl<T> QueryParams<T> {
where
T: serde::Deserialize<'request>,
{
let query = request_head.uri.query().unwrap_or_default();
let query = request_head.target.query().unwrap_or_default();
parse(query).map(QueryParams)
}
}
Expand Down
4 changes: 2 additions & 2 deletions libs/pavex/src/request/request_head.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use http::{HeaderMap, Method, Uri, Version};
/// [`Blueprint`]: crate::blueprint::Blueprint
pub struct RequestHead {
pub method: Method,
pub uri: Uri,
pub target: Uri,
pub version: Version,
pub headers: HeaderMap,
}
Expand All @@ -24,7 +24,7 @@ impl From<http::request::Parts> for RequestHead {
fn from(parts: http::request::Parts) -> Self {
Self {
method: parts.method,
uri: parts.uri,
target: parts.uri,
version: parts.version,
headers: parts.headers,
}
Expand Down
2 changes: 1 addition & 1 deletion libs/pavexc/src/compiler/codegen.rs
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ fn get_request_dispatcher(
#[allow(unused)]
let request_body = #pavex::request::body::RawIncomingBody::from(request_body);
let request_head: #pavex::request::RequestHead = request_head.into();
let matched_route = match server_state.router.at(&request_head.uri.path()) {
let matched_route = match server_state.router.at(&request_head.target.path()) {
Ok(m) => m,
Err(_) => {
#allowed_methods
Expand Down
2 changes: 1 addition & 1 deletion template/template/{{crate_name}}/src/telemetry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ impl RootSpan {
user_agent.original = %user_agent,
http.response.status_code = tracing::field::Empty,
http.route = %matched_route,
http.target = %request_head.uri.path_and_query().map(|p| p.as_str()).unwrap_or(""),
http.target = %request_head.target.path_and_query().map(|p| p.as_str()).unwrap_or(""),
);
Self(span)
}
Expand Down

0 comments on commit 2bbde9e

Please sign in to comment.