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.

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

(chore) Remove some panic! calls from the pq code #3527

Merged
merged 3 commits into from
Aug 2, 2023
Merged

(chore) Remove some panic! calls from the pq code #3527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af0ca22
Replace panics with expect. For lock poisoning this is fine as we can…
Aug 2, 2023
ad1314f
Simplify tests by removing panics and using expect.
Aug 2, 2023
dcf3db6
Changelog
Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changesets/maint_contract_fiancee_ark_grey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Remove some panic! calls from the pq code. ([PR #3527](https://github.com/apollographql/router/pull/3527))

Replace a few `panic!` calls with `expect()` in the persisted query code for code clarity.

By [@BrynCooke](https://github.com/BrynCooke) in https://github.com/apollographql/router/pull/3527
24 changes: 10 additions & 14 deletions apollo-router/src/services/layers/persisted_queries/manifest_poller.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,18 @@ impl PersistedQueryManifestPoller {
}

pub(crate) fn get_operation_body(&self, persisted_query_id: &str) -> Option<String> {
let persisted_query_manifest = self.persisted_query_manifest.read().unwrap_or_else(|e| {
panic!("could not acquire read lock on persisted query manifest: {e}")
});
let persisted_query_manifest = self
.persisted_query_manifest
.read()
.expect("could not acquire read lock on persisted query manifest");
persisted_query_manifest.get(persisted_query_id).cloned()
}

pub(crate) fn is_operation_persisted(&self, query: &str) -> bool {
let persisted_query_bodies = self.persisted_query_bodies.read().unwrap_or_else(|e| {
panic!("could not acquire read lock on persisted query body se: {e}")
});
let persisted_query_bodies = self
.persisted_query_bodies
.read()
.expect("could not acquire read lock on persisted query body set");
persisted_query_bodies.contains(query)
}
}
Expand Down Expand Up @@ -169,15 +171,9 @@ async fn poll_uplink(
// update the set of pq bodies from the values in the new collection
*existing_bodies = new_bodies;
})
.unwrap_or_else(|e| {
panic!(
"could not acquire write lock on persisted query body set: {e}"
)
});
.expect("could not acquire write lock on persisted query body set");
})
.unwrap_or_else(|e| {
panic!("could not acquire write lock on persisted query manifest: {e}")
});
.expect("could not acquire write lock on persisted query manifest");

if !resolved_first_pq_manifest {
send_startup_event(
Expand Down
130 changes: 55 additions & 75 deletions apollo-router/src/services/layers/persisted_queries/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,11 +446,10 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_none());

let result = pq_layer.supergraph_request(incoming_request);
if let Ok(request) = result {
assert_eq!(request.supergraph_request.body().query, Some(body));
} else {
panic!("pq layer returned response instead of putting the query on the request");
}
let request = result
.ok()
.expect("pq layer returned response instead of putting the query on the request");
assert_eq!(request.supergraph_request.body().query, Some(body));
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -481,11 +480,10 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_none());

let result = pq_layer.supergraph_request(incoming_request);
if let Ok(request) = result {
assert!(request.supergraph_request.body().query.is_none());
} else {
panic!("pq layer returned response instead of continuing to APQ layer");
}
let request = result
.ok()
.expect("pq layer returned response instead of continuing to APQ layer");
assert!(request.supergraph_request.body().query.is_none());
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -516,19 +514,16 @@ mod tests {

assert!(incoming_request.supergraph_request.body().query.is_none());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(
response.errors,
vec![graphql_err_operation_not_found(invalid_id)]
);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = pq_layer
.supergraph_request(incoming_request)
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(
response.errors,
vec![graphql_err_operation_not_found(invalid_id)]
);
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -620,18 +615,15 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_some());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(
response.errors,
vec![graphql_err_operation_not_in_safelist()]
);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = result
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(
response.errors,
vec![graphql_err_operation_not_in_safelist()]
);
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -669,18 +661,15 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_none());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(
response.errors,
vec![graphql_err_operation_not_found(invalid_id)]
);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = result
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(
response.errors,
vec![graphql_err_operation_not_found(invalid_id)]
);
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -786,15 +775,12 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_some());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(response.errors, vec![graphql_err_pq_id_required()]);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = result
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(response.errors, vec![graphql_err_pq_id_required()]);
}

#[tokio::test(flavor = "multi_thread")]
Expand Down Expand Up @@ -887,15 +873,12 @@ mod tests {
assert!(incoming_request.supergraph_request.body().query.is_some());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(response.errors, vec![graphql_err_cannot_send_id_and_body()]);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = result
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(response.errors, vec![graphql_err_cannot_send_id_and_body()]);
}

#[tokio::test(flavor = "multi_thread")]
Expand All @@ -921,16 +904,13 @@ mod tests {

assert!(incoming_request.supergraph_request.body().query.is_some());

let result = pq_layer.supergraph_request(incoming_request);
if let Err(mut response) = result {
if let Some(response) = response.next_response().await {
assert_eq!(response.errors, vec![graphql_err_cannot_send_id_and_body()]);
} else {
panic!("could not get response from pq layer");
}
} else {
panic!("pq layer returned request instead of returning an error response");
}
let response = pq_layer
.supergraph_request(incoming_request)
.expect_err("pq layer returned request instead of returning an error response")
.next_response()
.await
.expect("could not get response from pq layer");
assert_eq!(response.errors, vec![graphql_err_cannot_send_id_and_body()]);
}

#[tokio::test(flavor = "multi_thread")]
Expand Down