Configuración del almacenamiento en caché del lado del servidor y la compresión de la carga útil de la API en AWS AppSync

Gracias a las capacidades de almacenamiento en caché de datos en el servidor de AWS AppSync, los datos están disponibles en una caché en memoria de alta velocidad, lo que mejora el rendimiento y reduce la latencia. Esto reduce la necesidad de acceder directamente a los orígenes de datos. El almacenamiento en caché está disponible tanto para los solucionadores de unidades como para los de canalización.

AWS AppSync también te permite comprimir las respuestas de la API para que el contenido de la carga útil se cargue y descargue más rápido. Esto puede reducir la carga de trabajo de las aplicaciones y, al mismo tiempo, reducir los cargos por transferencia de datos. El comportamiento de la compresión es configurable y se puede ajustar según criterio propios.

Consulta esta sección si necesitas ayuda para definir el comportamiento deseado del almacenamiento en caché y la compresión del lado del servidor en tu API. AWS AppSync

Tipos de instancias

AWS AppSync aloja instancias de Amazon ElastiCache (Redis OSS) en la misma AWS cuenta y AWS región que su AWS AppSync API.

Están disponibles los siguientes tipos de instancias ElastiCache (Redis OSS):

Comportamiento del almacenamiento en caché

Los siguientes son los comportamientos relacionados con el almacenamiento en caché.

Cifrado de caché

El cifrado de caché tiene las dos versiones siguientes. Son similares a los ajustes que permite ElastiCache (Redis OSS). Puede habilitar la configuración de cifrado solo cuando habilite por primera vez el almacenamiento en caché para su AWS AppSync API.

Para invalidar las entradas de la caché, puedes realizar una llamada a la API de flush cache mediante la AWS AppSync consola o el AWS Command Line Interface ().AWS CLI

Para obtener más información, consulta el tipo de ApiCachedatos en la referencia de la AWS AppSync API.

Expulsión de caché

Al configurar el almacenamiento en caché AWS AppSync del lado del servidor, puede configurar un TTL máximo. Este valor define la cantidad de tiempo que las entradas almacenadas en caché se almacenan en la memoria. En situaciones en las que deba eliminar entradas específicas de la memoria caché, puede utilizar la utilidad AWS AppSync de evictFromApiCache extensiones en la solicitud o respuesta del solucionador. (Por ejemplo, cuando los datos de los orígenes de datos han cambiado y la entrada de la caché ahora está obsoleta). Para expulsar un elemento de la caché, debe conocer su clave. Por este motivo, si debe expulsar los elementos de forma dinámica, le recomendamos que utilice el almacenamiento en caché por solucionador y que defina de forma explícita una clave para añadir entradas a la caché.

Expulsar una entrada en caché

Para expulsar un elemento de la caché, utilice la utilidad de extensiones evictFromApiCache. Especifique el nombre del tipo y el nombre del campo y, a continuación, proporcione un objeto de elementos clave-valor para crear la clave de la entrada que desee expulsar. En el objeto, cada clave representa una entrada válida del objeto context que se utiliza en la lista cachingKey de solucionadores almacenada en caché. Cada valor es el valor real que se utiliza para crear el valor de la clave. Debe colocar los elementos del objeto en el mismo orden que las claves de almacenamiento en caché de la lista cachingKey del solucionador almacenado en caché.

Por ejemplo, vea el esquema siguiente:

type Note {
  id: ID!
  title: String
  content: String!
}

type Query {
  getNote(id: ID!): Note
}

type Mutation {
  updateNote(id: ID!, content: String!): Note
}

En este ejemplo, puede habilitar el almacenamiento en caché por solucionador y, a continuación, habilitarlo para la consulta getNote. A continuación, puede configurar la clave de almacenamiento en caché para que contenga [context.arguments.id].

Cuando intenta obtener unaNote, para generar la clave de caché, AWS AppSync realiza una búsqueda en su caché del lado del servidor utilizando el id argumento de la getNote consulta.

Al actualizar una Note, debe expulsar la entrada de la nota específica para asegurarse de que la siguiente solicitud la obtenga del origen de datos del backend. Para ello, debe crear un controlador de solicitudes.

En el siguiente ejemplo se muestra una forma de gestionar la expulsión mediante este método:

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	extensions.evictFromApiCache('Query', 'getNote', { 'ctx.args.id': ctx.args.id });
	return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export const response = (ctx) => ctx.result;

Otra opción puede consistir en gestionar la expulsión en el controlador de respuestas.

Cuando se procesa la updateNote mutación, AWS AppSync intenta desalojar la entrada. Si una entrada se borra correctamente, la respuesta contiene un valor apiCacheEntriesDeleted en el objeto extensions que muestra cuántas entradas se han borrado:

"extensions": {  "apiCacheEntriesDeleted": 1}

Expulsar una entrada de caché en función de su identidad

Puede crear claves de almacenamiento en caché basadas en varios valores del objeto context.

Por ejemplo, tome el siguiente esquema que usa grupos de usuarios de Amazon Cognito como modo de autenticación predeterminado y está respaldado por un origen de datos de Amazon DynamoDB:

type Note {
  id: ID! # a slug; e.g.: "my-first-note-on-graphql"
  title: String
  content: String!
}

type Query {
  getNote(id: ID!): Note
}

type Mutation {
  updateNote(id: ID!, content: String!): Note
}

Los tipos de objetos de Note se guardan en una tabla de DynamoDB. La tabla tiene una clave compuesta que utiliza el nombre de usuario de Amazon Cognito como clave principal y el id (un slug) de Note como clave de partición. Se trata de un sistema de varios inquilinos que permite que varios usuarios alojen y actualicen sus objetos privados de Note, que nunca se comparten.

Como se trata de un sistema de lectura intensiva, la consulta getNote se almacena en caché por solucionador, con la clave de almacenamiento en caché compuesta por [context.identity.username, context.arguments.id]. Cuando se actualiza una Note, puede desalojar la entrada correspondiente a esa Note específica. Debe añadir los componentes del objeto en el mismo orden en que se especifican en la lista cachingKeys del solucionador.

El ejemplo siguiente muestra esto:

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	extensions.evictFromApiCache('Query', 'getNote', {
		'ctx.identity.username': ctx.identity.username,
		'ctx.args.id': ctx.args.id,
	});
	return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export const response = (ctx) => ctx.result;

Un sistema de backend también puede actualizar la Note y expulsar la entrada. Tomemos por ejemplo esta mutación:

type Mutation {
  updateNoteFromBackend(id: ID!, content: String!, username: ID!): Note @aws_iam
}

Puede expulsar la entrada, pero añadir los componentes de la clave de almacenamiento en caché al objeto cachingKeys.

En el ejemplo siguiente, la expulsión se produce en la respuesta del solucionador:

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
    return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export function response(ctx) {
    extensions.evictFromApiCache('Query', 'getNote', {
        'ctx.identity.username': ctx.args.username,
        'ctx.args.id': ctx.args.id,
    });
    return ctx.result;
}

En los casos en los que los datos de backend se hayan actualizado de AWS AppSync forma externa, puede expulsar un elemento de la caché llamando a una mutación que utilice una NONE fuente de datos.

Compresión de respuestas de API

AWS AppSync permite a los clientes solicitar cargas útiles comprimidas. Si se solicita, las respuestas de la API se comprimen y se devuelven en respuesta a solicitudes que indican que se prefiere el contenido comprimido. Las respuestas de la API comprimida se cargan más rápido, el contenido se descarga más rápido y, además, es posible que también se reduzcan los cobros por transferencia de datos.

AWS AppSync puede comprimir tamaños de carga útil de consultas de GraphQL entre 1000 y 10 000 000 bytes. Para habilitar la compresión, un cliente debe enviar el encabezado Accept-Encoding con el valor gzip. La compresión se puede verificar comprobando el valor del encabezado Content-Encoding en la respuesta (gzip).

El explorador de consultas de la AWS AppSync consola establece automáticamente el valor del encabezado de la solicitud de forma predeterminada. Si ejecuta una consulta que tiene una respuesta lo suficientemente grande, la compresión se puede confirmar con las herramientas de desarrollo de su navegador.