Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Tutorial: Solucionadores de canalizaciones

AWS AppSync proporciona una manera sencilla de conectar un campo de GraphQL a un único origen de datos a través de los solucionadores de unidad. Sin embargo, ejecutar una sola operación podría no ser suficiente. Los solucionadores de canalización ofrecen la posibilidad de ejecutar operaciones en serie con respecto a los orígenes de datos. Cree funciones en su API y asócielas a un solucionador de canalización. Cada resultado de ejecución de la función se canaliza a la siguiente hasta que no quede ninguna función que ejecutar. Con los solucionadores de canalización, ahora puede crear flujos de trabajo más complejos directamente en AWS AppSync. En este tutorial, se crea una aplicación sencilla de visualización de imágenes, en la que los usuarios pueden publicar y ver imágenes publicadas por sus amigos.

Configuración en un clic

Si desea configurar automáticamente el punto de conexión de GraphQL en AWS AppSync con todos los solucionadores configurados y los recursos necesarios de AWS, puede utilizar la siguiente plantilla de AWS CloudFormation:

Esta pila crea los siguientes recursos en su cuenta:

Al final del proceso de creación de la pila de AWS CloudFormation, el usuario recibirá un mensaje de correo electrónico para cada uno de los tres usuarios de Amazon Cognito que se hayan creado. Cada correo electrónico contiene una contraseña temporal que se utiliza para iniciar sesión como un usuario de Amazon Cognito en la consola de AWS AppSync. Guarde las contraseñas para el resto del tutorial.

Configuración manual

Si prefiere ir manualmente a través de un proceso paso a paso por la consola de AWS AppSync, siga el proceso de configuración que se indica más abajo.

Configuración de los recursos que no son AWS AppSync

La API se comunica con dos tablas de DynamoDB: una tabla de imágenes que almacena imágenes y una tabla de amigos que almacena las relaciones entre los usuarios. La API está configurada para utilizar el grupo de usuarios de Amazon Cognito como el tipo de autenticación. La siguiente pila de AWS CloudFormation configura estos recursos en la cuenta.

Al final del proceso de creación de la pila de AWS CloudFormation, el usuario recibirá un mensaje de correo electrónico para cada uno de los tres usuarios de Amazon Cognito que se hayan creado. Cada correo electrónico contiene una contraseña temporal que se utiliza para iniciar sesión como un usuario de Amazon Cognito en la consola de AWS AppSync. Guarde las contraseñas para el resto del tutorial.

Creación de la API de GraphQL

Para crear la API de GraphQL en AWS AppSync:

La consola de AWS AppSync crea una nueva API de GraphQL automáticamente utilizando el modo de autenticación de clave de API. Puede utilizar la consola para configurar el resto de la API de GraphQL y ejecutar consultas en ella durante el resto de este tutorial.

Configuración de la API de GraphQL

Debe configurar la API de AWS AppSync con el grupo de usuarios de Amazon Cognito que acaba de crear.

La API ahora está configurada para utilizar el grupo de usuarios de Amazon Cognito como el tipo de autenticación.

Configuración de orígenes de datos para las tablas de DynamoDB

Una vez creadas las tablas de DynamoDB, vaya a la API de GraphQL para AWS AppSync en la consola y elija la pestaña Orígenes de datos. Ahora, va a crear un origen de datos en AWS AppSync para cada una de las tablas de DynamoDB que acaba de crear.

Repita el mismo proceso para la tabla de amigos; el nombre de la tabla de DynamoDB debe ser AppSyncTutorial-Friends si no cambió el parámetro ResourceNamePrefix en el momento de crear la pila de CloudFormation.

Creación del esquema de GraphQL

Ahora que los orígenes de datos están conectados a las tablas de DynamoDB, vamos a crear un esquema de GraphQL. En el editor de esquemas de la consola de AWS AppSync, asegúrese de que su esquema coincida con el siguiente:

schema {
    query: Query
    mutation: Mutation
}

type Mutation {
    createPicture(input: CreatePictureInput!): Picture!
    @aws_auth(cognito_groups: ["Admins"])
    createFriendship(id: ID!, target: ID!): Boolean
    @aws_auth(cognito_groups: ["Admins"])
}

type Query {
    getPicturesByOwner(id: ID!): [Picture]
    @aws_auth(cognito_groups: ["Admins", "Viewers"])
}

type Picture {
    id: ID!
    owner: ID!
    src: String
}

input CreatePictureInput {
    owner: ID!
    src: String!
}

Elija Save Schema (Guardar esquema) para guardar el esquema.

Algunos de los campos de esquema se han comentado con la directiva @aws_auth. Dado que la API de configuración de acción predeterminada está establecida en DENY (DENEGAR), la API rechaza a todos los usuarios que no son miembros de los grupos mencionados dentro de la directiva @aws_auth. Para obtener más información acerca de cómo proteger la API, puede leer la página de seguridad. En este caso, solo los usuarios administradores tienen acceso a los campos Mutation.createPicture y Mutation.createFriendship mientras que los usuarios que son miembros de los grupos Admins (Administradores) o Viewers (Espectadores) pueden obtener acceso al campo Query.getPicturesByOwner. Todos los demás usuarios no tienen acceso.

Configuración de solucionadores

Ahora que tiene un esquema GraphQL válido y dos orígenes de datos, puede asociar los solucionadores a los campos de GraphQL en el esquema. La API ofrece las siguientes capacidades:

Mutation.createPicture

En el editor de esquemas de la consola de AWS AppSync, elija a la derecha Asociar solucionador para createPicture(input: CreatePictureInput!): Picture!. Elija el origen de datos PicturesDynamoDBTableDynamoDB. En la sección Plantilla de mapeo de solicitudes, añada la siguiente plantilla:

#set($id = $util.autoId())

{
    "version" : "2018-05-29",

    "operation" : "PutItem",

    "key" : {
        "id" : $util.dynamodb.toDynamoDBJson($id),
        "owner": $util.dynamodb.toDynamoDBJson($ctx.args.input.owner)
    },

    "attributeValues" : $util.dynamodb.toMapValuesJson($ctx.args.input)
}

En la sección Plantilla de mapeo de respuestas, añada la siguiente plantilla:

#if($ctx.error)
    $util.error($ctx.error.message, $ctx.error.type)
#end
$util.toJson($ctx.result)

La funcionalidad de creación de imagen está lista. Va a guardar una imagen en la tabla Pictures (Imágenes) utilizando un UUID generado de forma aleatoria como id de la imagen y utilizando el nombre de usuario de Cognito como propietario de la imagen.

Mutation.createFriendship

En el editor de esquemas de la consola de AWS AppSync, elija a la derecha Asociar solucionador para createFriendship(id: ID!, target: ID!): Boolean. Elija el origen de datos DynamoDBFriendsDynamoDBTable. En la sección Plantilla de mapeo de solicitudes, añada la siguiente plantilla:

#set($userToFriendFriendship = { "userId" : "$ctx.args.id", "friendId": "$ctx.args.target" })
#set($friendToUserFriendship = { "userId" : "$ctx.args.target", "friendId": "$ctx.args.id" })
#set($friendsItems = [$util.dynamodb.toMapValues($userToFriendFriendship), $util.dynamodb.toMapValues($friendToUserFriendship)])

{
    "version" : "2018-05-29",
    "operation" : "BatchPutItem",
    "tables" : {
        ## Replace 'AppSyncTutorial-' default below with the ResourceNamePrefix you provided in the CloudFormation template
        "AppSyncTutorial-Friends": $util.toJson($friendsItems)
    }
}

Importante: En la plantilla de solicitud BatchPutItem, el nombre exacto de la tabla de DynamoDB debería estar presente. El valor predeterminado de la tabla es AppSyncTutorial-Friends. Si utiliza el nombre de tabla erróneo, obtiene un error cuando AppSync intenta asumir el rol proporcionado.

En aras de simplificar este tutorial, continúe como si la solicitud de amistad se hubiera aprobado y guarde la entrada de relación directamente en la tabla AppSyncTutorialFriends.

Efectivamente, está almacenando dos elementos para cada amistad, ya que la relación es bidireccional. Para obtener información más detallada sobre las prácticas recomendadas de Amazon DynamoDB para representar las relaciones de varios a varios, consulte las prácticas recomendadas de DynamoDB.

En la sección Plantilla de mapeo de respuestas, añada la siguiente plantilla:

#if($ctx.error)
    $util.error($ctx.error.message, $ctx.error.type)
#end
true

Nota: Asegúrese de que su plantilla de solicitud contiene el nombre de la tabla correcto. El nombre predeterminado es AppSyncTutorial-Friends, pero su nombre de tabla que puede ser diferentes si ha cambiado el parámetro ResourceNamePrefix de CloudFormation.

Query.getPicturesByOwner

Ahora que tiene amistades e imágenes, debe proporcionar la capacidad a los usuarios de ver las imágenes de sus amigos. Para cumplir este requisito, debe comprobar primero que el solicitante es amigo con el propietario y, por último, consultar las imágenes.

Dado que esta funcionalidad requiere dos operaciones de origen de datos, va a crear dos funciones. La primera función, isFriend, comprueba si el solicitante y el propietario son amigos. La segunda función, getPicturesByOwner, recupera las imágenes solicitadas dado un ID de propietario. Analicemos el flujo de ejecución por debajo del solucionador propuestos en el campo Query.getPicturesByOwner:

Primero, vamos a crear las funciones.

Función isFriend

Resultado: Ha creado la función isFriend.

Función getPicturesByOwner

Resultado: Ha creado la función getPicturesByOwner. Ahora que las funciones se han creado, adjunte un solucionador de canalización al campo Query.getPicturesByOwner.

En el editor de esquemas de la consola de AWS AppSync, elija a la derecha Asociar solucionador para Query.getPicturesByOwner(id: ID!): [Picture]. En la página siguiente, elija el enlace Convert to pipeline resolver (Convertir a solucionador de canalización) que aparece debajo de la lista desplegable del origen de datos. Use lo siguiente para la plantilla de mapeo de antes:

#set($result = { "owner": $ctx.args.id, "callerId": $ctx.identity.username })
$util.toJson($result)

En la sección after mapping template (plantilla de mapeo de después), use lo siguiente:

#foreach($picture in $ctx.result.items)
    ## prepend "src://" to picture.src property
    #set($picture['src'] = "src://${picture['src']}")
#end
$util.toJson($ctx.result.items)

Elija Create Resolver (Crear solucionador). Acaba de asociar su primer solucionador de canalización. En la misma página, añada las dos funciones que ha creado anteriormente. En sección de funciones, seleccione Add A Function (Añadir una función) y, a continuación, elija o escriba el nombre de la primera función, isFriend. Añada la segunda función siguiendo el mismo proceso para la función getPicturesByOwner. Asegúrese de que la función isFriend aparece primero en la lista seguido de la función getPicturesByOwner. Puede utilizar las flechas hacia arriba y abajo para cambiar el orden de ejecución de las funciones de la canalización.

Ahora que el solucionador de canalización se ha creado y ha asociado las funciones, vamos a probar la nueva API de GraphQL.

Prueba de la API de GraphQL

En primer lugar, debe rellenar las imágenes y amistades ejecutando algunas mutaciones mediante el usuario administrador que ha creado. En el lateral izquierdo de la consola de AWS AppSync, elija la pestaña Consultas.

Mutación createPicture

Vamos a enviar unas mutaciones de createPicture para rellenar la tabla de imágenes. Ejecute la siguiente consulta de GraphQL dentro de la consola:

mutation {
  createPicture(input:{
    owner: "nadia"
    src: "nadia.jpg"
  }) {
    id
    owner
    src
  }
}

La respuesta debe tener un aspecto similar al siguiente:

{
  "data": {
    "createPicture": {
      "id": "c6fedbbe-57ad-4da3-860a-ffe8d039882a",
      "owner": "nadia",
      "src": "nadia.jpg"
    }
  }
}

Agreguemos algunas imágenes más:

mutation {
  createPicture(input:{
    owner: "shaggy"
    src: "shaggy.jpg"
  }) {
    id
    owner
    src
  }
}

mutation {
  createPicture(input:{
    owner: "rex"
    src: "rex.jpg"
  }) {
    id
    owner
    src
  }
}

Ha agregado tres imágenes usando a nadia como usuario administrador.

Mutación createFriendship

Vamos a añadir una entrada de amistad. Ejecute las siguientes mutaciones en la consola.

Nota: Debe permanecer con la sesión iniciada como usuario administrador (el valor predeterminado es nadia).

mutation {
  createFriendship(id: "nadia", target: "shaggy")
}

La respuesta debe tener un aspecto similar al siguiente:

{
  "data": {
    "createFriendship": true
  }
}

nadia y shaggy son amigos. rex no es amigo de nadie.

Consulta getPicturesByOwner

En este paso, inicie sesión como el usuario nadia con los grupos de usuarios de Cognito, con las credenciales configuradas al principio de este tutorial. Como nadia, recupere las imágenes propiedad de shaggy.

query {
    getPicturesByOwner(id: "shaggy") {
        id
        owner
        src
    }
}

Dado que nadia y shaggy son amigos, la consulta debe devolver la imagen correspondiente.

{
  "data": {
    "getPicturesByOwner": [
      {
        "id": "05a16fba-cc29-41ee-a8d5-4e791f4f1079",
        "owner": "shaggy",
        "src": "src://shaggy.jpg"
      }
    ]
  }
}

Del mismo modo, si nadia intenta recuperar sus propias imágenes, también se ejecuta satisfactoriamente. El solucionador de canalización se ha optimizado para evitar ejecutar la operación isFriend de GetItem en ese caso. Pruebe la siguiente consulta:

query {
    getPicturesByOwner(id: "nadia") {
        id
        owner
        src
    }
}

Si habilita el registro en la API (en el panel Settings (Configuración)), configure el nivel de depuración a ALL (TODO) y ejecute la misma consulta de nuevo, devuelve los registros a la ejecución del campo. Observando los registros, puede determinar si la función isFriend se ha devuelto pronto en la etapa Request Mapping Template (Plantilla de mapeo de solicitud):

{
  "errors": [],
  "mappingTemplateType": "Request Mapping",
  "path": "[getPicturesByOwner]",
  "resolverArn": "arn:aws:appsync:us-west-2:XXXX:apis/XXXX/types/Query/fields/getPicturesByOwner",
  "functionArn": "arn:aws:appsync:us-west-2:XXXX:apis/XXXX/functions/o2f42p2jrfdl3dw7s6xub2csdfs",
  "functionName": "isFriend",
  "earlyReturnedValue": {
    "owner": "nadia",
    "callerId": "nadia"
  },
  "context": {
    "arguments": {
      "id": "nadia"
    },
    "prev": {
      "result": {
        "owner": "nadia",
        "callerId": "nadia"
      }
    },
    "stash": {},
    "outErrors": []
  },
  "fieldInError": false
}

La clave earlyReturnedValue representa los datos que devolvió la directiva #return.

Por último, aunque rex es miembro del grupo Viewers (Espectadores) de Cognito UserPool, dado que rex no es amigo de nadie, no podrá acceder a ninguna de las imágenes propiedad de shaggy o nadia. Si iniciar sesión como rex en la consola y ejecuta la siguiente consulta:

query {
    getPicturesByOwner(id: "nadia") {
        id
        owner
        src
    }
}

Obtiene el siguiente error de no autorizado:

{
  "data": {
    "getPicturesByOwner": null
  },
  "errors": [
    {
      "path": [
        "getPicturesByOwner"
      ],
      "data": null,
      "errorType": "Unauthorized",
      "errorInfo": null,
      "locations": [
        {
          "line": 2,
          "column": 9,
          "sourceName": null
        }
      ],
      "message": "Not Authorized to access getPicturesByOwner on type Query"
    }
  ]
}

Ha implementado con éxito la autorización compleja con los solucionadores de canalización.