Parse Server SQS Message Queue Adapter

The Parse Server AWS SQS Message Queue Adapter integrates Amazon SQS as the underlying message queue for Parse Server. It allows push notifications, jobs and LiveQuery events to be distributed across multiple Parse Server instances.

• Installation
• Usage
  • Integrate with Parse Server
  • Credentials
  • Push Notifications

Installation

npm install --save @parse/sqs-mq-adapter

Usage

const ParseServer = require('parse-server').ParseServer;
const SQSEventEmitterMQ = require('@parse/sqs-mq-adapter').SQSEventEmitterMQ;

config = {
  ....
  queueOptions: {
    messageQueueAdapter: SQSEventEmitterMQ,
    queueUrl: 'https://sqs.us-east-1.amazonaws.com/XXX/Parse-Queue', // required
    region: 'us-east-1',
  },
};

const parseServer = new ParseServer(config);

Integrate with Parse Server

1. Install dependencies

   npm install parse-server @parse/sqs-mq-adapter

2. Configure the adapter in your Parse Server configuration:

   const { ParseServer } = require('parse-server');
   const { SQSEventEmitterMQ } = require('@parse/sqs-mq-adapter');
   
   const config = {
     databaseURI: 'mongodb://localhost:27017/app',
     appId: 'myAppId',
     masterKey: 'myMasterKey',
     serverURL: 'https://example.com/parse',
     queueOptions: {
       messageQueueAdapter: SQSEventEmitterMQ,
       queueUrl: 'https://sqs.us-east-1.amazonaws.com/XXX/Parse-Queue',
       region: 'us-east-1',
     },
   };
   
   const server = new ParseServer(config);

3. Start Parse Server and the adapter will listen to the configured SQS queue.

See: sqs-consumer for complete list of configuration options.

Credentials

By default the consumer will look for AWS credentials in the places specified by the AWS SDK. The simplest option is to export your credentials as environment variables:

export AWS_SECRET_ACCESS_KEY=...
export AWS_ACCESS_KEY_ID=...

If you need to specify your credentials manually, you can use a pre-configured instance of the AWS SQS client:

const ParseServer = require('parse-server').ParseServer;
const SQSEventEmitterMQ = require('@parse/sqs-mq-adapter').SQSEventEmitterMQ;
const AWS = require('aws-sdk');

AWS.config.update({
  region: 'eu-west-1',
  accessKeyId: '...',
  secretAccessKey: '...'
});

config = {
  ....
  messageQueueAdapter: SQSEventEmitterMQ,
  SQSEventEmitterMQOptions: {
    queueUrl: 'https://sqs.us-east-1.amazonaws.com/XXX/Parse-Queue',
    sqs: new AWS.SQS(),
  },
};

const parseServer = new ParseServer(config);

Push Notifications

Parse Server sends push notifications as part of its workload using an internal push queue. When sending large amounts of push notifications this may impact other parts of the workload. This adapter allows Parse Server to only enqueue push notifications into a shared push queue so that another, dedicated Parse Server instance can process the push queue and send the push notification to the push service provider.

The Parse Server instance that should only enqueue pushes must have set disablePushWorker: true. The Parse Server instance that should process and send the enqueued pushes must omit this option, or set disablePushWorker: false.

const { ParseServer } = require('parse-server');
const { SQSEventEmitterMQ } = require('@parse/sqs-mq-adapter');

const config = {
  push: {
    adapter: new MyPushAdapter(),
    queueOptions: {
      messageQueueAdapter: SQSEventEmitterMQ,
      queueUrl: 'https://sqs.us-east-1.amazonaws.com/XXX/Push-Queue',
      region: 'us-east-1',
      disablePushWorker: true,
    },
  },
};

const server = new ParseServer(config);

This works for any instance constellation, with one or multiple instances enqueuing pushes and one or multiple instances sending pushes.