chore: finish wiring OperationCheck error

crates/rover-client/src/error.rs

@@ -143,7 +143,10 @@ pub enum RoverClientError {
  // we nest the CheckResponse here because we want to print the entire response even
  // if there were failures
  #[error("{}", check_response_error_msg(.check_response))]
- OperationCheckFailure { check_response: CheckResponse },
+ OperationCheckFailure {
+ graph_ref: GraphRef,
+ check_response: CheckResponse,
+ },
 
  /// This error occurs when a user has a malformed Graph Ref
  #[error("Graph IDs must be in the format <NAME> or <NAME>@<VARIANT>, where <NAME> can only contain letters, numbers, or the characters `-` or `_`, and must be 64 characters or less. <VARIANT> must be 64 characters or less.")]

crates/rover-client/src/operations/graph/check/runner.rs

@@ -38,9 +38,9 @@ fn get_check_response_from_data(
  data: MutationResponseData,
  graph_ref: GraphRef,
 ) -> Result<CheckResponse, RoverClientError> {
- let service = data
- .service
-  .ok_or(RoverClientError::GraphNotFound { graph_ref })?;
+ let service = data.service.ok_or(RoverClientError::GraphNotFound {
+ graph_ref: graph_ref.clone(),
+ })?;
  let target_url = service.check_schema.target_url;
 
  let diff_to_previous = service.check_schema.diff_to_previous;
@@ -65,5 +65,5 @@ fn get_check_response_from_data(
  num_failures,
  };
 
- check_response.check_for_failures()
+ check_response.check_for_failures(graph_ref)
 }

crates/rover-client/src/operations/subgraph/check/runner.rs

@@ -100,7 +100,7 @@ fn get_check_response_from_data(
  changes,
  change_severity,
  };
- check_response.check_for_failures()
+ check_response.check_for_failures(graph_ref)
  } else {
  let num_failures = query_composition_errors.len();
 

crates/rover-client/src/shared/check_response.rs

@@ -2,6 +2,7 @@ use std::cmp::Ordering;
 use std::fmt;
 use std::str::FromStr;
 
+use crate::shared::GraphRef;
 use crate::RoverClientError;
 
 use serde::Serialize;
@@ -40,10 +41,14 @@ impl CheckResponse {
  }
  }
 
- pub fn check_for_failures(&self) -> Result<CheckResponse, RoverClientError> {
+ pub fn check_for_failures(
+ &self,
+ graph_ref: GraphRef,
+ ) -> Result<CheckResponse, RoverClientError> {
  match &self.num_failures.cmp(&0) {
  Ordering::Equal => Ok(self.clone()),
  Ordering::Greater => Err(RoverClientError::OperationCheckFailure {
+ graph_ref,
  check_response: self.clone(),
  }),
  Ordering::Less => unreachable!("Somehow encountered a negative number of failures."),

docs/source/errors.md

@@ -242,3 +242,7 @@ There are many reasons why you may run into composition errors. This error shoul
 Some composition errors are part of normal workflows. For instance, you may need to publish a subgraph that does not compose if you are trying to [migrate an entity or field](https://www.apollographql.com/docs/federation/entities/#migrating-entities-and-fields-advanced).
 
 
+### E030
+
+This error occurs when an operation check fails. This means that you proposed a schema that would break operations in use by existing clients. You can configure this behavior in the Checks -> Configuration view in [Apollo Studio](https://studio.apollographql.com/), and you can read more about client checks [here](https://www.apollographql.com/docs/studio/schema-checks/).
+

src/error/metadata/mod.rs

@@ -73,13 +73,16 @@ impl From<&mut anyhow::Error> for Metadata {
  Some(Code::E029),
  )
  }
- RoverClientError::OperationCheckFailure { check_response } => {
+ RoverClientError::OperationCheckFailure {
+ graph_ref,
+ check_response,
+ } => {
  print_check_response(check_response);
  (
- Some(Suggestion::Adhoc(
- "TODO: make a new error code and markdown file linking to client checks".to_string(),
- )),
- None,
+ Some(Suggestion::FixOperationsInSchema {
+ graph_ref: graph_ref.clone(),
+ }),
+ Some(Code::E030),
  )
  }
  RoverClientError::SubgraphIntrospectionNotAvailable => {