Consultas persistentes de GraphQL

Última actualización: 2023-12-13

Las consultas persistentes son consultas de GraphQL que se crean y almacenan en el servidor de Adobe Experience Manager (AEM) as a Cloud Service. Las consultas persistentes pueden solicitarlas las aplicaciones cliente con una petición GET. La respuesta de una petición GET se puede almacenar en caché en las capas de Dispatcher y CDN, lo que a la larga mejora el rendimiento de la aplicación cliente solicitante. Esto difiere de las consultas estándar de GraphQL, que se ejecutan mediante peticiones POST en las que la respuesta no se puede almacenar en caché fácilmente.

NOTA

Se recomiendan las consultas persistentes. Consulte Prácticas recomendadas para consultas de GraphQL (Dispatcher) para obtener más información y la configuración de Dispatcher relacionada.

El IDE de GraphiQL está disponible en AEM para que desarrolle, pruebe y mantenga sus consultas de GraphQL antes de la transferencia a su entorno de producción. Para los casos que necesitan personalización (por ejemplo, cuando se personaliza la caché) puede utilizar la API; consulte el ejemplo de cURL que se proporciona en Persistencia de una consulta de GraphQL.

Consultas y puntos de conexión persistentes

Las consultas persistentes siempre deben utilizar el punto de conexión relacionado con la configuración de Sites adecuada, para que puedan usar una o ambas:

  • La configuración global y el punto de conexión
    La consulta tiene acceso a todos los modelos de fragmentos de contenido.
  • Configuraciones de sitios específicas y puntos de conexión
    La creación de una consulta persistente para una configuración de sitios específica requiere un punto de conexión específico de configuración de sitios correspondiente (para proporcionar acceso a los modelos de fragmentos de contenido relacionados).
    Por ejemplo, para crear una consulta persistente específica para la configuración de WKND Sites, se debe crear de antemano una configuración de sitios específica de WKND y un punto de conexión específico de WKND.
NOTA

Consulte Habilitar la funcionalidad de fragmento de contenido en el explorador de configuración para obtener más información.

Las Consultas persistentes de GraphQL deben estar habilitadas para la configuración de sitios adecuada.

Por ejemplo, si hay una consulta en particular llamada my-query, que utiliza un modelo my-model desde la configuración de Sites my-conf:

  • Puede crear una consulta utilizando el punto final my-conf específico, y luego la consulta se guarda de la siguiente manera:
    /conf/my-conf/settings/graphql/persistentQueries/my-query
  • Puede crear la misma consulta utilizando el punto final global, pero la consulta se guarda de la siguiente manera:
    /conf/global/settings/graphql/persistentQueries/my-query
NOTA

Estas son dos consultas distintas: se guardan en rutas diferentes.

Simplemente, utilizan el mismo modelo, pero a través de puntos de conexión diferentes.

Cómo conservar una consulta de GraphQL

Se recomienda mantener las consultas en un entorno de creación de AEM primero, y después transferir la consulta al entorno de publicación de producción de AEM para su uso por parte de las aplicaciones.

Existen varios métodos para hacer que persistan las consultas, entre los que se incluyen los siguientes:

El IDE de GraphiQL es el método preferido para consultas persistentes. Para mantener una consulta determinada utilizando la herramienta línea de comandos cURL:

  1. Prepare la consulta colocándola en la nueva URL de punto de conexión /graphql/persist.json/<config>/<persisted-label>.

    Por ejemplo, cree una consulta persistente:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
        }
      }
    }'
    
  2. En este punto, compruebe la respuesta.

    Por ejemplo, compruebe si se ha realizado correctamente:

    {
      "action": "create",
      "configurationName": "wknd",
      "name": "plain-article-query",
      "shortPath": "/wknd/plain-article-query",
      "path": "/conf/wknd/settings/graphql/persistentQueries/plain-article-query"
    }
    
  3. A continuación, puede solicitar la consulta persistente usando GET en la dirección URL /graphql/execute.json/<shortPath>.

    Por ejemplo, utilice la consulta persistente:

    $ curl -X GET \
        http://localhost:4502/graphql/execute.json/wknd/plain-article-query
    
  4. Actualice una consulta persistente usando POST en una ruta de consulta ya existente.

    Por ejemplo, utilice la consulta persistente:

    $ curl -X POST \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
          referencearticle {
            _path
          }
        }
      }
    }'
    
  5. Cree una consulta sin formato ajustada.

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-wrapped" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }"}'
    
  6. Cree una consulta sencilla ajustada con control de caché.

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
    
  7. Cree una consulta persistente con parámetros:

    Por ejemplo:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-parameters" \
        -d \
    'query GetAsGraphqlModelTestByPath($apath: String!, $withReference: Boolean = true) {
      articleByPath(_path: $apath) {
        item {
          _path
            author
            main {
            plaintext
            }
            referencearticle @include(if: $withReference) {
            _path
            }
          }
        }
      }'
    

Ejecución de una consulta persistente

Para ejecutar una consulta persistente, una aplicación cliente realiza una petición GET utilizando la siguiente sintaxis:

GET <AEM_HOST>/graphql/execute.json/<PERSISTENT_PATH>

Donde PERSISTENT_PATH es una ruta abreviada donde se guarda la consulta persistente.

  1. Por ejemplo, wknd es el nombre de configuración y plain-article-query, el nombre de la consulta persistente. Para ejecutar la consulta:

    $ curl -X GET \
        https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query
    
  2. Ejecución de una consulta con parámetros.

    NOTA

    Las variables y los valores de consulta deben ser codificados correctamente al ejecutar una consulta persistente.

    Por ejemplo:

    $ curl -X GET \
        "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query-parameters%3Bapath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fmagazine%2Falaska-adventure%2Falaskan-adventures%3BwithReference%3Dfalse
    

    Consulte variables de consulta para obtener más información.

Uso de variables de consulta

Las variables de consulta se pueden usar con Consultas persistentes. Las variables de consulta se anexan a la solicitud con el prefijo punto y coma (;) empleando el nombre y valor de la variable. Las variables múltiples se separan con punto y coma.

El patrón tiene el siguiente aspecto:

<AEM_HOST>/graphql/execute.json/<PERSISTENT_QUERY_PATH>;variable1=value1;variable2=value2

Por ejemplo, la siguiente consulta contiene una variable activity para filtrar una lista en función de un valor de actividad:

query getAdventuresByActivity($activity: String!) {
      adventureList (filter: {
        adventureActivity: {
          _expressions: [
            {
              value: $activity
            }
          ]
        }
      }){
        items {
          _path
        adventureTitle
        adventurePrice
        adventureTripLength
      }
    }
  }

Esta consulta se puede mantener en una ruta wknd/adventures-by-activity. Para llamar a la consulta persistente donde activity=Camping la solicitud tendría este aspecto:

<AEM_HOST>/graphql/execute.json/wknd/adventures-by-activity%3Bactivity%3DCamping

La codificación UTF-8 %3B es para ; y %3D es la codificación para =. Las variables de consulta y los caracteres especiales deben ser codificados correctamente para que se ejecute la consulta persistente.

Almacenamiento en caché de las consultas persistentes

Se recomiendan las Consultas persistentes, ya que se pueden almacenar en caché en las capas de Dispatcher y la Red de distribución de contenido (CDN), mejorando finalmente el rendimiento de la aplicación cliente solicitante.

De forma predeterminada, AEM invalidará la caché en función de una definición de tiempo de vida (TTL). Estos TTL se pueden definir mediante los siguientes parámetros. Se puede acceder a estos parámetros de varias formas, con variaciones en los nombres según el mecanismo utilizado:

Tipo de caché Encabezado de HTTP cURL Configuración de OSGi Cloud Manager
Explorador max-age cache-control : max-age cacheControlMaxAge graphqlCacheControl
La red de distribución de contenido (CDN) s-maxage surrogate-control : max-age surrogateControlMaxAge graphqlSurrogateControl
La red de distribución de contenido (CDN) stale-while-revalidate surrogate-control : stale-while-revalidate surrogateControlStaleWhileRevalidate graphqlStaleWhileRevalidate
La red de distribución de contenido (CDN) stale-if-error surrogate-control : stale-if-error surrogateControlStaleIfError graphqlStaleIfError

Instancias de autor

En las instancias de autor, los valores predeterminados son:

  • max-age : 60
  • s-maxage : 60
  • stale-while-revalidate : 86400
  • stale-if-error : 86400

Estos:

  • no se puede sobrescribir:
    • con una configuración de OSGi
  • se puede sobrescribir:

Publicación de instancias

Para las instancias de publicación, los valores predeterminados son:

  • max-age : 60
  • s-maxage : 7200
  • stale-while-revalidate : 86400
  • stale-if-error : 86400

Se pueden sobrescribir:

Administración de encabezados de caché HTTP en el IDE de GraphiQL

El IDE de GraphiQL: consulte Guardado de consultas persistentes

Administración de la caché en el Nivel de consulta persistente

Esto implica publicar la consulta en AEM usando cURL en la interfaz de línea de comandos.

Para ver un ejemplo del método PUT (crear):

curl -u admin:admin -X PUT \
--url "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
--header "Content-Type: application/json" \
--data '{ "query": "{articleList { items { _path author } } }", "cache-control": { "max-age": 300 }, "surrogate-control": {"max-age":600, "stale-while-revalidate":1000, "stale-if-error":1000} }'

Para ver un ejemplo del método POST (actualización):

curl -u admin:admin -X POST \
--url "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
--header "Content-Type: application/json" \
--data '{ "query": "{articleList { items { _path author } } }", "cache-control": { "max-age": 300 }, "surrogate-control": {"max-age":600, "stale-while-revalidate":1000, "stale-if-error":1000} }'

El cache-control se puede configurar en el momento de la creación (PUT) o más tarde (por ejemplo, mediante una petición POST). El control de caché es opcional al crear la consulta persistente, ya que AEM puede proporcionar el valor predeterminado. Consulte Cómo hacer persistir una consulta de GraphQL, para ver un ejemplo de persistencia de una consulta utilizando cURL.

Administración de la caché con variables de Cloud Manager

Variables de entorno de Cloud Manager se puede definir con Cloud Manager para definir los valores necesarios:

Nombre Value Servicio aplicado Tipo
graphqlStaleIfError 86400 según proceda según proceda
graphqlSurrogateControl 600 según proceda según proceda

Administración de la caché con una configuración OSGi

Para administrar la caché globalmente, puede configurar la configuración de OSGi para la Configuración del servicio de consulta persistente.

NOTA

Para el control de caché, la configuración de OSGi solo es adecuada para instancias de publicación. La configuración existe en instancias de autor, pero se ignora.

NOTA

La Configuración del servicio de consultas persistentes también se utiliza para la configuración del código de respuesta de la consulta.

La configuración de OSGi predeterminada para instancias de publicación:

  • lee las variables de Cloud Manager si están disponibles:

    Propiedad de configuración de OSGi lee esto Variable de Cloud Manager
    cacheControlMaxAge lee graphqlCacheControl
    surrogateControlMaxAge lee graphqlSurrogateControl
    surrogateControlStaleWhileRevalidate lee graphqlStaleWhileRevalidate
    surrogateControlStaleIfError lee graphqlStaleIfError
  • y si no está disponible, la configuración de OSGi utiliza la variable valores predeterminados para instancias de publicación.

Configuración del código de respuesta a la consulta

De forma predeterminada, la PersistedQueryServlet envía una respuesta 200 cuando ejecuta una consulta, independientemente del resultado real.

Puede configurar el OSGi para la Configuración del servicio de consultas persistentes para controlar qué código de estado devuelve el punto final/execute.json/persisted-query, cuando hay un error en la consulta persistente.

NOTA

La Configuración del servicio de consultas persistentes también se utiliza para administrar caché.

El campo Respond with application/graphql-response+json (responseContentTypeGraphQLResponseJson) se puede definir según sea necesario:

  • false (valor predeterminado):
    No importa si la consulta persistente es correcta o no. El /execute.json/persisted-query devuelve el código de estado 200 y el encabezado Content-Type devuelto es application/json.

  • true:
    el punto final devolverá 400 o 500 según corresponda, cuando haya algún tipo de error al ejecutar la consulta persistente. Además, el Content-Type devuelto es application/graphql-response+json.

    NOTA

    Consulte https://graphql.github.io/graphql-over-http/draft/#sec-Status-Codes

Codificación de la URL de consulta para su uso en una aplicación

Para su uso en una aplicación, cualquier carácter especial utilizado al construir variables de consulta (es decir, punto y coma (;), signo igual (=), barras oblicuas /) debe convertirse para utilizar la codificación UTF-8 correspondiente.

Por ejemplo:

curl -X GET \ "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/adventure-by-path%3BadventurePath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fadventures%2Fbali-surf-camp%2Fbali-surf-camp"

La dirección URL se puede desglosar en las siguientes partes:

Parte URL Descripción
/graphql/execute.json Punto de conexión de consulta persistente
/wknd/adventure-by-path Ruta de consulta persistente
%3B Codificación de ;
adventurePath Variable de consulta
%3D Codificación de =
%2F Codificación de /
%2Fcontent%2Fdam... Ruta codificada al fragmento de contenido

En texto sin formato, el URI de solicitud tiene el siguiente aspecto:

/graphql/execute.json/wknd/adventure-by-path;adventurePath=/content/dam/wknd/en/adventures/bali-surf-camp/bali-surf-camp

Para utilizar una consulta persistente en una aplicación cliente, se debe utilizar el SDK de cliente AEM sin encabezado para JavaScript, Java o NodeJS. El SDK de cliente sin encabezado codificará automáticamente todas las variables de consulta de la forma adecuada en la solicitud.

Transferencia de una consulta persistente al entorno de producción

Las consultas persistentes siempre deben crearse en un servicio de AEM Author y luego publicarse (replicarse) en un servicio de AEM Publish. A menudo, las consultas persistentes se crean y prueban en entornos más bajos, como los entornos locales o de desarrollo. A continuación, es necesario promocionar las consultas persistentes a entornos de nivel superior, para que finalmente estén disponibles en un entorno de publicación de AEM de producción para que las aplicaciones de cliente las consuman.

Empaquetar consultas persistentes

Las consultas persistentes se pueden integrar en Paquetes de AEM. Los paquetes AEM se pueden descargar e instalar en diferentes entornos. Los paquetes AEM también se pueden replicar desde un entorno de AEM Author a entornos de AEM Publish.

Para crear un paquete, haga lo siguiente:

  1. Vaya a Herramientas > Implementación > Paquetes.
  2. Cree un nuevo paquete tocando Crear paquete. Esto abre un cuadro de diálogo para definir el paquete.
  3. En el cuadro de diálogo Definición de paquete, en General introduzca un Nombre como “wknd-persistent-queries”.
  4. Escriba un número de versión como “1.0”.
  5. En Filtros, agregue un nuevo Filtro. Utilice el Buscador de rutas para seleccionar la carpeta persistentQueries debajo de la configuración. Por ejemplo, para la configuración wknd la ruta completa es /conf/wknd/settings/graphql/persistentQueries.
  6. Seleccionar Guardar para guardar la nueva definición del paquete y cerrar el cuadro de diálogo.
  7. Seleccione el Generar en la definición del paquete creada.

Una vez creado el paquete, puede hacer lo siguiente:

  • Descargar el paquete y vuelva a cargarlo en un entorno diferente.
  • Replicar el paquete tocando Más > Replicar. Esto replicará el paquete en el entorno de publicación de AEM conectado.

En esta página