Automation
AutomationAcción de Resolución de Consulta

Acción de Resolución de Consulta

Cuando el servidor GraphQL resuelve una consulta, dispara los siguientes action hooks con la respuesta GraphQL:

  1. gatographql__executed_query:{$operationName} (solo si se proporcionó la operación GraphQL a ejecutar)
  2. gatographql__executed_query

Los action hooks que se disparan son:

// Triggered only if the GraphQL operation to execute was provided
do_action(
  "gatographql__executed_query:{$operationName}",
  $response,
  $isInternalExecution,
  $query,
  $variables,
);
 
// Triggered always
do_action(
  'gatographql__executed_query',
  $response,
  $isInternalExecution,
  $operationName,
  $query,
  $variables,
);

Los parámetros pasados son:

  • $response: Un objeto de la clase PoP\Root\HttpFoundation\Response, que contiene la respuesta GraphQL (incluyendo contenido y cabeceras)
  • $isInternalExecution: true si la consulta se ejecutó mediante el Internal GraphQL Server (por ejemplo: mediante la clase GatoGraphQL\InternalGraphQLServer\GraphQLServer), o false en caso contrario (por ejemplo: mediante el endpoint único)
  • $operationName: Operación GraphQL ejecutada (solo para el segundo action hook; en el primero, es implícita en el nombre del hook)
  • $query: Consulta GraphQL ejecutada
  • $variables: Variables GraphQL proporcionadas

Ejemplos

Gracias al Internal GraphQL Server, podemos reaccionar a la resolución de una consulta GraphQL (ya sea ejecutada contra el Internal GraphQL Server, endpoint único, endpoint personalizado o persisted query), y ejecutar otra consulta GraphQL contra el Internal GraphQL Server.

Un flujo de ejemplo es:

  • Engancharse a la ejecución de una consulta GraphQL, por ejemplo por su nombre de operación (como CreatePost)
  • Enviar una notificación al administrador, ejecutando la mutación _sendEmail mediante GatoGraphQL\InternalGraphQLServer\GraphQLServer::executeQuery

Este código PHP está encadenando 2 ejecuciones de consultas GraphQL:

GraphQLServer::executeQuery(
  <<<GRAPHQL
    mutation CreatePost(
      \$postTitle: String!,
      \$postContent: String!
    ) {
      createPost(input: {
        title: \$postTitle
        contentAs: { html: \$postContent }
      }) {
        status
        errors {
          __typename
          ...on ErrorPayload {
            message
          }
        }
        postID
      }
    }
  GRAPHQL,
  [
    'postTitle' => 'New post',
    'postContent' => 'Some content',
  ],
  'CreatePost'
);
 
add_action(
  "gatographql__executed_query:CreatePost",
  function (Response $response) {
    /** @var string */
    $responseContent = $response->getContent();
    /** @var array<string,mixed> */
    $responseJSON = json_decode($responseContent, true);
    $postID = $responseJSON['data']['createPost']['postID'] ?? null;
    if ($postID === null) {
      // Do nothing
      return;
    }
 
    $post = get_post($postID);
 
    // Execute the chained query!
    GraphQLServer::executeQuery(
      <<<GRAPHQL
        mutation SendEmail(
          \$emailSubject: String!
          \$emailMessage: String!
        ) {
          _sendEmail(
            input: {
              to: "admin@site.com"
              subject: \$emailSubject
              messageAs: {
                html: \$emailMessage
              }
            }
          ) {
            status
          }
        }
      GRAPHQL,
      [
        'emailSubject' => sprintf(__("New post: %s"), $post->post_title),
        'emailMessage' => $post->post_content,
      ]
    );
  }
);