Serving GraphQL Subscriptions Using PHP and Drupal

Rate this content

Most people in the GraphQL Galaxy are familiar with JavaScript tools when creating GraphQL servers.

But what do you do if your team’s speciality is PHP and you have all your existing data available in a Drupal based platform?

In this session I’ll take you on a tour of the tools we used to build a PHP based service that handles GraphQL subscriptions powering Open Social’s Real-Time chat, and how you can use our learnings for your own project.

7 min
10 Dec, 2021

AI Generated Video Summary

This Lightning Talk discusses the setup of GraphQL subscriptions in a Drupal-based product, using Rescript and React on the client-side and the Urql GraphQL client. The choice of ReactPHP over AMP for the subscription service is explained, highlighting the use of Fibers in PHP 8.1 for asynchronous task handling.

1. Setting up GraphQL Subscriptions in Drupal

Short description:

In this Lightning Talk, I will explain how we set up GraphQL subscriptions for an existing Drupal-based product. We wanted to add a real-time chat feature to our platform using GraphQL and integrate it with our existing member and group structure. We chose Rescript and React for the client-side and the Urql GraphQL client. The GraphQL PHP library, a PHP port of the JavaScript reference implementation, was the best choice for working with GraphQL in Drupal. However, Drupal's short-lived model posed limitations for subscriptions, requiring an additional service to handle persistent connections.

Hey, GraphQL Galaxy. In this Lightning Talk, I want to take you through what it took to set up GraphQL subscriptions for an existing Drupal-based product. I'm Alexander Farweg or Kingdutch on places like Twitter and GitHub, and I'm the Lead Frontend Engineer and GraphQL Initiative Lead at OpenSocial.

OpenSocial is a community engagement platform that helps organizations connect with their communities online and grow them in the process. OpenSocial is built on top of the Drupal content management framework. To allow quicker communication between members on our platforms, we wanted to use GraphQL to add a real-time chat as a new feature to our existing products. The goal was for the chat to integrate with our existing member and group structure. To build our chats, we chose Rescript and React. And of course, GraphQL to let our server and client communicate. On the client side, we chose the excellent Urql GraphQL client.

In PHP, there are a few libraries that can help you with GraphQL. The best choice in my opinion, and the one used in Drupal, is the GraphQL PHP library. This is a PHP port of the JavaScript reference implementation. I'm a big fan of the library structure. It makes porting new GraphQL features to PHP very easy. For example, one of my first contributions was implementing interfaces extending other interfaces. To achieve this, I could almost copy and paste the JavaScript tests and implementation word-for-word.

Just replacing a bit of the syntax. Drupal itself works with modules that allow you to create a site by bundling together functionality. The Drupal community has provided an excellent Drupal module that utilizes GraphQL-PHP and lets developers easily expose Drupal's data storage as a GraphQL API. As you would expect, queries and mutations work out of the box. The GraphQL-PHP library also supports subscriptions, and the Drupal-GraphQL module does not impose any limitations on defining subscriptions in your schema or resolving them. However, when trying to make GraphQL subscriptions in a framework such as Drupal, we run into some of its limitations. Drupal, like other popular PHP content management systems, such as WordPress, handle individual requests through a web server like Apache or Nginx. This means that once a response to a request is generated, the connection is closed and the memory is cleared for the next request. This short-lived model doesn't work for subscriptions which require a persistent connection and the ability to send data to the client without the client requesting it. This means we need additional service to sit between our client and our web server to handle these persistent connections. We can write these servers in many different languages, such as JavaScript, Rescript, OCaml, Rust or your other favorite language. However, since I was working with an existing team and product, it was important to look at the skills that were already present in our organization. I had to make sure that whatever was built would also be maintainable by others.

2. Choosing ReactPHP for Subscription Service

Short description:

Since OpenSocial's back-end developers are most familiar with PHP, we decided to use it for our subscription service. ReactPHP was chosen over AMP for its syntax and the introduction of Fibers in PHP 8.1. This allowed us to create a long-running PHP process and perform tasks asynchronously.

Or I would risk having to maintain it all by myself. With this in mind, since OpenSocial's back-end developers are most familiar with PHP, we decided to use this for our subscription service too. This does mean that we need some new tools. We now need something that can create a long-running PHP process, and perform tasks asynchronously. There are a few libraries out there already that can help us with this. ReactPHP and AMP are both capable libraries that let you write asynchronous code. The biggest difference is what syntax they use for their promises. Fun fact, the PHP extension for an event loop that both ReactPHP and AMP use actually predates Node.js. More recently, ReactPHP and AMP have bundled their forces to build Revolt, which will make use of Fibers, a feature that has been introduced in PHP 8.1. At OpenSocial, we settled on ReactPHP after trying both it and AMP.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

GraphQL Galaxy 2021GraphQL Galaxy 2021
32 min
From GraphQL Zero to GraphQL Hero with RedwoodJS
We all love GraphQL, but it can be daunting to get a server up and running and keep your code organized, maintainable, and testable over the long term. No more! Come watch as I go from an empty directory to a fully fledged GraphQL API in minutes flat. Plus, see how easy it is to use and create directives to clean up your code even more. You're gonna love GraphQL even more once you make things Redwood Easy!
Vue.js London Live 2021Vue.js London Live 2021
24 min
Local State and Server Cache: Finding a Balance
How many times did you implement the same flow in your application: check, if data is already fetched from the server, if yes - render the data, if not - fetch this data and then render it? I think I've done it more than ten times myself and I've seen the question about this flow more than fifty times. Unfortunately, our go-to state management library, Vuex, doesn't provide any solution for this.For GraphQL-based application, there was an alternative to use Apollo client that provided tools for working with the cache. But what if you use REST? Luckily, now we have a Vue alternative to a react-query library that provides a nice solution for working with server cache. In this talk, I will explain the distinction between local application state and local server cache and do some live coding to show how to work with the latter.
GraphQL Galaxy 2022GraphQL Galaxy 2022
29 min
Rock Solid React and GraphQL Apps for People in a Hurry
In this talk, we'll look at some of the modern options for building a full-stack React and GraphQL app with strong conventions and how this can be of enormous benefit to you and your team. We'll focus specifically on RedwoodJS, a full stack React framework that is often called 'Ruby on Rails for React'.
GraphQL Galaxy 2022GraphQL Galaxy 2022
16 min
Step aside resolvers: a new approach to GraphQL execution
Though GraphQL is declarative, resolvers operate field-by-field, layer-by-layer, often resulting in unnecessary work for your business logic even when using techniques such as DataLoader. In this talk, Benjie will introduce his vision for a new general-purpose GraphQL execution strategy whose holistic approach could lead to significant efficiency and scalability gains for all GraphQL APIs.

Workshops on related topic

GraphQL Galaxy 2021GraphQL Galaxy 2021
140 min
Build with SvelteKit and GraphQL
Featured WorkshopFree
Have you ever thought about building something that doesn't require a lot of boilerplate with a tiny bundle size? In this workshop, Scott Spence will go from hello world to covering routing and using endpoints in SvelteKit. You'll set up a backend GraphQL API then use GraphQL queries with SvelteKit to display the GraphQL API data. You'll build a fast secure project that uses SvelteKit's features, then deploy it as a fully static site. This course is for the Svelte curious who haven't had extensive experience with SvelteKit and want a deeper understanding of how to use it in practical applications.

Table of contents:
- Kick-off and Svelte introduction
- Initialise frontend project
- Tour of the SvelteKit skeleton project
- Configure backend project
- Query Data with GraphQL
- Fetching data to the frontend with GraphQL
- Styling
- Svelte directives
- Routing in SvelteKit
- Endpoints in SvelteKit
- Deploying to Netlify
- Navigation
- Mutations in GraphCMS
- Sending GraphQL Mutations via SvelteKit
- Q&A
React Advanced Conference 2022React Advanced Conference 2022
95 min
End-To-End Type Safety with React, GraphQL & Prisma
Featured WorkshopFree
In this workshop, you will get a first-hand look at what end-to-end type safety is and why it is important. To accomplish this, you’ll be building a GraphQL API using modern, relevant tools which will be consumed by a React client.
Prerequisites: - Node.js installed on your machine (12.2.X / 14.X)- It is recommended (but not required) to use VS Code for the practical tasks- An IDE installed (VSCode recommended)- (Good to have)*A basic understanding of Node.js, React, and TypeScript
GraphQL Galaxy 2022GraphQL Galaxy 2022
112 min
GraphQL for React Developers
Featured Workshop
There are many advantages to using GraphQL as a datasource for frontend development, compared to REST APIs. We developers in example need to write a lot of imperative code to retrieve data to display in our applications and handle state. With GraphQL you cannot only decrease the amount of code needed around data fetching and state-management you'll also get increased flexibility, better performance and most of all an improved developer experience. In this workshop you'll learn how GraphQL can improve your work as a frontend developer and how to handle GraphQL in your frontend React application.
React Summit 2022React Summit 2022
173 min
Build a Headless WordPress App with Next.js and WPGraphQL
In this workshop, you’ll learn how to build a Next.js app that uses Apollo Client to fetch data from a headless WordPress backend and use it to render the pages of your app. You’ll learn when you should consider a headless WordPress architecture, how to turn a WordPress backend into a GraphQL server, how to compose queries using the GraphiQL IDE, how to colocate GraphQL fragments with your components, and more.
GraphQL Galaxy 2020GraphQL Galaxy 2020
106 min
Relational Database Modeling for GraphQL
In this workshop we'll dig deeper into data modeling. We'll start with a discussion about various database types and how they map to GraphQL. Once that groundwork is laid out, the focus will shift to specific types of databases and how to build data models that work best for GraphQL within various scenarios.
Table of contentsPart 1 - Hour 1      a. Relational Database Data Modeling      b. Comparing Relational and NoSQL Databases      c. GraphQL with the Database in mindPart 2 - Hour 2      a. Designing Relational Data Models      b. Relationship, Building MultijoinsTables      c. GraphQL & Relational Data Modeling Query Complexities
Prerequisites      a. Data modeling tool. The trainer will be using dbdiagram      b. Postgres, albeit no need to install this locally, as I'll be using a Postgres Dicker image, from Docker Hub for all examples      c. Hasura
GraphQL Galaxy 2021GraphQL Galaxy 2021
48 min
Building GraphQL APIs on top of Ethereum with The Graph
The Graph is an indexing protocol for querying networks like Ethereum, IPFS, and other blockchains. Anyone can build and publish open APIs, called subgraphs, making data easily accessible.

In this workshop you’ll learn how to build a subgraph that indexes NFT blockchain data from the Foundation smart contract. We’ll deploy the API, and learn how to perform queries to retrieve data using various types of data access patterns, implementing filters and sorting.

By the end of the workshop, you should understand how to build and deploy performant APIs to The Graph to index data from any smart contract deployed to Ethereum.