Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

graphql-amqp-subscriptions

1.1.1 • Public • Published

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: {
       name: 'exchange',
       type: 'topic',
       options: {
         durable: false,
         autoDelete: true
       }
     },
     queue: {
       name: 'queue'
       options: {
         exclusive: true,
         durable: true,
         autoDelete: true
       },
       unbindOnDispose: false;
       deleteOnDispose: false;
     } */
  });
  // 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"

Tests

You'll need to have a local AMPQ instance such as RabbitMQ running to run tests.

If you have Docker, you can run:

docker run --hostname my-rabbit -p 5672:5672 rabbitmq:3

Then

npm test

Install

npm i graphql-amqp-subscriptions

DownloadsWeekly Downloads

3,111

Version

1.1.1

License

MIT

Unpacked Size

33.2 kB

Total Files

28

Last publish

Collaborators

  • avatar