@commercial-tribe/graphql-amqp-subscriptions

GraphQL AMQP Subscriptions

Usage no npm install needed!

<script type="module">
  import commercialTribeGraphqlAmqpSubscriptions from 'https://cdn.skypack.dev/@commercial-tribe/graphql-amqp-subscriptions';
</script>

README

graphql-amqp-subscriptions

This package implements the PubSubEngine Interface from the graphql-subscriptions package. It allows you to connect your subscriptions manager to a AMQP PubSub mechanism.

This package is influenced by graphql-redis-subscriptions and graphql-rabbitmq-subscriptions.

npm Version npm Downloads CircleCI Known Vulnerabilities

Basic usage

import { AMQPPubSub } from 'graphql-amqp-subscriptions';
import amqp from 'amqplib';

amqp.connect('amqp://guest:guest@localhost:5672?heartbeat=30')
.then(conn => {
  const pubsub = new AMQPPubSub({
    connection: conn
    /* exchange: 'graphql_subscriptions' */
  });
  // Use the pubsub instance from here on
})
.catch(err => {
  console.error(err);
});

Benefits

  • Reusing existing amqplib Connection
  • Reusing channels (one for subscriptions, one for publishing)
  • Performance/Ressource-usage benefits on AMQP (RabbitMQ) because of the aforementioned reasons more info
  • Using Topic Exchange (e.g. you publish to agreements.eu.berlin.headstore and subscribe to agreements.eu.#) more info

Debug

This package uses Debug. To show the logs run your app with the environment variable DEBUG="AMQPPubSub"