Servicio de Suscripciones GraphQL utilizando PHP y Drupal

¡Hola, Galaxia GraphQL! En esta Charla Relámpago, quiero llevarte a través de lo que se necesitó para configurar las suscripciones de GraphQL para un producto existente basado en Drupal. Soy Alexander Farweg o Kingdutch en lugares como Twitter y GitHub, y soy el Ingeniero Principal de Frontend y Líder de Iniciativa GraphQL en OpenSocial.

OpenSocial es una plataforma de participación comunitaria que ayuda a las organizaciones a conectarse con sus comunidades en línea y hacerlas crecer en el proceso. OpenSocial se basa en el marco de gestión de contenido Drupal. Para permitir una comunicación más rápida entre los miembros en nuestras plataformas, queríamos usar GraphQL para agregar una función de chat en tiempo real como una nueva característica a nuestros productos existentes. El objetivo era que el chat se integre con nuestra estructura de miembros y grupos existente. Para construir nuestros chats, elegimos Rescript y React. Y, por supuesto, GraphQL para permitir que nuestro servidor y cliente se comuniquen. En el lado del cliente, elegimos el excelente cliente de GraphQL Urql.

En PHP, hay algunas bibliotecas que pueden ayudarte con GraphQL. La mejor opción en mi opinión, y la que se utiliza en Drupal, es la biblioteca de GraphQL PHP. Esta es una versión en PHP de la implementación de referencia de JavaScript. Soy un gran fan de la estructura de la biblioteca. Hace que sea muy fácil portar nuevas características de GraphQL a PHP. Por ejemplo, una de mis primeras contribuciones fue implementar interfaces que extienden otras interfaces. Para lograr esto, casi pude copiar y pegar las pruebas e implementación de JavaScript palabra por palabra.

Simplemente reemplazando un poco la sintaxis. Drupal en sí trabaja con módulos que te permiten crear un sitio agrupando funcionalidades. La comunidad de Drupal ha proporcionado un excelente módulo de Drupal que utiliza GraphQL-PHP y permite a los desarrolladores exponer fácilmente el almacenamiento de datos de Drupal como una API de GraphQL. Como era de esperar, las consultas y mutaciones funcionan de manera predeterminada. La biblioteca GraphQL-PHP también admite suscripciones, y el módulo Drupal-GraphQL no impone ninguna limitación para definir suscripciones en tu esquema o resolverlas. Sin embargo, al intentar hacer suscripciones de GraphQL en un marco como Drupal, nos encontramos con algunas de sus limitaciones. Drupal, al igual que otros sistemas populares de gestión de contenido en PHP, como WordPress, maneja las solicitudes individuales a través de un servidor web como Apache o Nginx. Esto significa que una vez que se genera una respuesta a una solicitud, la conexión se cierra y la memoria se libera para la próxima solicitud. Este modelo de vida corta no funciona para las suscripciones, que requieren una conexión persistente y la capacidad de enviar datos al cliente sin que el cliente lo solicite. Esto significa que necesitamos un servicio adicional que se sitúe entre nuestro cliente y nuestro servidor web para manejar estas conexiones persistentes. Podemos escribir estos servidores en muchos idiomas diferentes, como JavaScript, Rescript, OCaml, Rust o tu otro lenguaje favorito. Sin embargo, dado que estaba trabajando con un equipo y un producto existentes, era importante tener en cuenta las habilidades que ya estaban presentes en nuestra organización. Tenía que asegurarme de que lo que se construyera también fuera mantenible por otros.

O correría el riesgo de tener que mantenerlo todo por mí mismo. Con esto en mente, dado que los desarrolladores de backend de OpenSocial están más familiarizados con PHP, decidimos usarlo también para nuestro servicio de suscripción. Esto significa que necesitamos algunas herramientas nuevas. Ahora necesitamos algo que pueda crear un proceso PHP de larga duración y realizar tareas de forma asíncrona. Ya existen algunas bibliotecas que pueden ayudarnos con esto. ReactPHP y AMP son dos bibliotecas capaces que te permiten escribir código asíncrono. La mayor diferencia está en la sintaxis que utilizan para sus promesas. Un dato curioso es que la extensión PHP para un bucle de eventos que tanto ReactPHP como AMP utilizan en realidad es anterior a Node.js. Más recientemente, ReactPHP y AMP han unido fuerzas para construir Revolt, que aprovechará Fibers, una característica introducida en PHP 8.1. En OpenSocial, nos decidimos por ReactPHP después de probar ambas opciones. El siguiente paso fue agregar algo que pudiera aceptar nuestras conexiones WebSocket. Aquí también, la comunidad de PHP nos llevaba ventaja al proporcionarnos Rachet, un servidor WebSocket para ReactPHP. Por último, necesitábamos asegurarnos de que los clientes de GraphQL que crearan una conexión WebSocket pudieran hablar en suscripciones de GraphQL. Esto requiere un trabajo personalizado. La biblioteca WebSocket de GraphQL, que es el estándar utilizado por los principales clientes de JavaScript, proporcionaba un protocolo muy claro. Pudimos implementarlo en un nuevo paquete, que se publicó en GitHub y Composer. Veamos lo que hemos construido hasta ahora. Ya tenemos una forma de hacer consultas y mutaciones, que se pueden enviar directamente a nuestro servidor web. Ahora también tenemos algo que puede aceptar suscripciones de GraphQL, aunque este servicio aún no responde a los nuevos datos que llegan al servidor web. Desafortunadamente, Drupal aún no admite la ejecución en un entorno asíncrono, como ReactPHP. Además, no es posible acceder directamente a la base de datos de Drupal porque perderíamos toda nuestra lógica de manejo de acceso. Por lo tanto, necesitamos una forma de que nuestro servidor web informe a nuestro servicio de suscripción que hay nuevos datos disponibles. Para esto, podemos introducir una cola de mensajes. Elegimos RebitMQ porque había una biblioteca fácil de usar disponible para ReactPHP llamada Bunny. Conectando esta última pieza, ahora tenemos un sistema que puede aceptar suscripciones de GraphQL desde nuestro cliente de chat. Cuando un usuario envía un nuevo mensaje de chat, el cliente realiza una mutación de GraphQL que coloca el mensaje en la cola de RebitMQ, notificando al servidor de suscripciones de los nuevos datos. El servidor de suscripciones utiliza ese mensaje para ejecutar una consulta de GraphQL para el cliente basada en la suscripción almacenada en memoria. Luego, traduce el resultado de esta consulta en la forma de la suscripción original y lo envía al cliente entregando el mensaje de chat. Así es como construimos un servicio que sirve suscripciones de GraphQL utilizando PHP y Drupal.