https://github.com/parse-community/parse-server-sqs-mq-adapter
Spread work queue accross cluster of parse servers using SQS
https://github.com/parse-community/parse-server-sqs-mq-adapter
Last synced: 5 months ago
JSON representation
Spread work queue accross cluster of parse servers using SQS
- Host: GitHub
- URL: https://github.com/parse-community/parse-server-sqs-mq-adapter
- Owner: parse-community
- License: apache-2.0
- Created: 2017-01-05T19:08:22.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2026-01-20T14:56:04.000Z (5 months ago)
- Last Synced: 2026-01-20T23:12:13.984Z (5 months ago)
- Language: JavaScript
- Size: 2.64 MB
- Stars: 20
- Watchers: 5
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# Parse Server SQS Message Queue Adapter
[](https://github.com/parse-community/parse-server-sqs-mq-adapter/actions?query=workflow%3Aci+branch%3Amain)
[](https://snyk.io/test/github/parse-community/parse-server-sqs-mq-adapter)
[](https://codecov.io/github/parse-community/parse-server-sqs-mq-adapter?branch=main)
[](https://github.com/parse-community/parse-server-sqs-mq-adapter/releases)
[](https://www.npmjs.com/package/@parse/sqs-mq-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](#installation)
- [Usage](#usage)
- [Integrate with Parse Server](#integrate-with-parse-server)
- [Credentials](#credentials)
- [Push Notifications](#push-notifications)
## Installation
`npm install --save @parse/sqs-mq-adapter`
## Usage
```js
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**
```bash
npm install parse-server @parse/sqs-mq-adapter
```
2. **Configure the adapter** in your Parse Server configuration:
```js
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](https://www.npmjs.com/package/sqs-consumer#options) for complete list of configuration options.
### Credentials
By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
```bash
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](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) client:
```js
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`.
```js
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.