@parse/sqs-mq-adapter 2.0.0 → 2.1.1

package/.github/workflows/ci.yml

@@ -20,23 +20,47 @@ jobs:
       - run: npm ci
       - run: npm run lint
   test:
-    name: Node ${{ matrix.node }}
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18', '20', '22' ]
-    timeout-minutes: 30
+        include:
+          - name: Parse Server 8, Node.js 18
+            NODE_VERSION: 18.20.4
+            PARSE_SERVER_VERSION: 8
+          - name: Parse Server 8, Node.js 20
+            NODE_VERSION: 20.15.1
+            PARSE_SERVER_VERSION: 8
+          - name: Parse Server 8, Node.js 22
+            NODE_VERSION: 22.4.1
+            PARSE_SERVER_VERSION: 8
+          - name: Parse Server 7, Node.js 18
+            NODE_VERSION: 18.20.4
+            PARSE_SERVER_VERSION: 7
+          - name: Parse Server 7, Node.js 20
+            NODE_VERSION: 20.15.1
+            PARSE_SERVER_VERSION: 7
+          - name: Parse Server 7, Node.js 22
+            NODE_VERSION: 22.4.1
+            PARSE_SERVER_VERSION: 7
+      fail-fast: false
+    name: ${{ matrix.name }}
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    env:
+      NODE_VERSION: ${{ matrix.NODE_VERSION }}
+      PARSE_SERVER_VERSION: ${{ matrix.PARSE_SERVER_VERSION }}
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Use Node.js ${{ matrix.NODE_VERSION }}
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node }}
+          node-version: ${{ matrix.NODE_VERSION }}
           cache: npm
+      - name: Install Parse Server ${{ matrix.PARSE_SERVER_VERSION }}
+        run: npm i -DE parse-server@${{ matrix.PARSE_SERVER_VERSION }}
       - name: Install dependencies
         run: npm ci
-      - run: npm run coverage
-        env:
-          CI: true
+      - name: Run tests
+        run: npm run test
       - name: Upload code coverage
         uses: codecov/codecov-action@v4
         with:

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.1.1](https://github.com/parse-community/parse-server-sqs-mq-adapter/compare/2.1.0...2.1.1) (2026-01-31)
+
+
+### Bug Fixes
+
+* Security upgrade qs from 6.14.0 to 6.14.1 ([#268](https://github.com/parse-community/parse-server-sqs-mq-adapter/issues/268)) ([a6cf866](https://github.com/parse-community/parse-server-sqs-mq-adapter/commit/a6cf866f76864aea4fabe3f758800c969da4c9b8))
+
+# [2.1.0](https://github.com/parse-community/parse-server-sqs-mq-adapter/compare/2.0.0...2.1.0) (2025-07-06)
+
+
+### Features
+
+* Add official support for Parse Server 7 and 8 ([#162](https://github.com/parse-community/parse-server-sqs-mq-adapter/issues/162)) ([e7e76b3](https://github.com/parse-community/parse-server-sqs-mq-adapter/commit/e7e76b3db52cc29964db1be33c08298fe166f9b6))
+
 # [2.0.0](https://github.com/parse-community/parse-server-sqs-mq-adapter/compare/1.4.0...2.0.0) (2025-07-05)
 
 

package/README.md

@@ -9,13 +9,15 @@
 
 ---
 
-The Parse Server AWS SQS Message Queue Adapter. This adapter allows a work queue to be spread across a cluster of machines.
+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`
@@ -38,6 +40,38 @@ config = {
 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
@@ -74,3 +108,30 @@ config = {
 
 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.

package/eslint.config.mjs

@@ -0,0 +1,45 @@
+import js from '@eslint/js';
+import globals from 'globals';
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.js'],
+    ignores: ['node_modules/**'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        Parse: 'readonly'
+      }
+    },
+    rules: {
+      indent: ["error", 2, { SwitchCase: 1 }],
+      "linebreak-style": ["error", "unix"],
+      "no-trailing-spaces": "error",
+      "eol-last": "error",
+      "space-in-parens": ["error", "never"],
+      "no-multiple-empty-lines": "warn",
+      "prefer-const": "error",
+      "space-infix-ops": "error",
+      "no-useless-escape": "off",
+      "require-atomic-updates": "off",
+      "object-curly-spacing": ["error", "always"],
+      curly: ["error", "all"],
+      "block-spacing": ["error", "always"],
+      "no-unused-vars": "off",
+      "no-console": "warn"
+    },
+  },
+  {
+    files: ['spec/**/*.js'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jasmine,
+        Parse: 'readonly'
+      }
+    }
+  }
+];

package/lib/SQSEventEmitterMQ.js

@@ -1,7 +1,7 @@
 const events = require('events');
 const { logger } = require('parse-server');
-const SQSProducer = require('sqs-producer');
-const SQSConsumer = require('sqs-consumer');
+const { Producer: SQSProducer } = require('sqs-producer');
+const { Consumer: SQSConsumer } = require('sqs-consumer');
 
 class Publisher {
   constructor(config) {
@@ -18,9 +18,21 @@ class Publisher {
       payload = Object.assign({ id: '0', body: message }, channel ? { groupId: channel } : {});
     }
 
-    this.emitter.send(payload, (err) => {
-      if (err) logger.error(err);
-    });
+    // basic validation to keep error logging synchronous for invalid payloads
+    if (typeof payload === 'object' && !Array.isArray(payload) && payload.body === undefined) {
+      logger.error(new Error("Object messages must have 'body' prop"));
+      return;
+    }
+    try {
+      const result = this.emitter.send(payload);
+      if (result && typeof result.catch === 'function') {
+        result.catch((err) => {
+          logger.error(err);
+        });
+      }
+    } catch (err) {
+      logger.error(err);
+    }
   }
 }
 
@@ -36,9 +48,8 @@ class Consumer extends events.EventEmitter {
   subscribe(channel) {
     this.unsubscribe(channel);
 
-    const handleMessage = (message, done) => {
+    const handleMessage = async (message) => {
       this.emit('message', channel, message.Body);
-      done();
     };
 
     const createOptions = Object.assign(this.config, { handleMessage });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parse/sqs-mq-adapter",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Spread work queue across cluster of parse servers using SQS",
   "main": "index.js",
   "repository": {
@@ -10,30 +10,39 @@
   "author": "Parse Platform",
   "license": "Apache-2.0",
   "dependencies": {
-    "sqs-consumer": "3.8.0",
-    "sqs-producer": "1.6.3"
+    "@aws-sdk/client-sqs": "3.972.0",
+    "sqs-consumer": "12.0.0",
+    "sqs-producer": "7.0.0"
   },
   "peerDependencies": {
     "parse-server": "*"
   },
   "devDependencies": {
+    "@eslint/js": "9.32.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "13.0.1",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "11.0.3",
-    "@semantic-release/npm": "12.0.1",
-    "@semantic-release/release-notes-generator": "14.0.3",
-    "eslint": "9.30.1",
-    "jasmine": "2.99.0",
-    "nyc": "15.1.0",
-    "parse-server": "5.5.6",
-    "semantic-release": "24.2.5",
-    "sinon": "14.0.0"
+    "@semantic-release/github": "12.0.2",
+    "@semantic-release/npm": "13.1.3",
+    "@semantic-release/release-notes-generator": "14.1.0",
+    "eslint": "9.39.2",
+    "globals": "17.1.0",
+    "jasmine": "6.0.0",
+    "jasmine-spec-reporter": "7.0.0",
+    "mongodb-runner": "6.5.4",
+    "nyc": "17.1.0",
+    "parse-server": "9.1.1",
+    "semantic-release": "25.0.2"
   },
   "scripts": {
     "lint": "eslint --cache ./index.js ./lib/** ./spec/**/*.js",
     "lint-fix": "eslint --cache --fix ./index.js ./lib/** ./spec/**/*.js",
-    "test": "jasmine",
+    "pretest": "npm run test:mongodb:runnerstart",
+    "posttest": "npm run test:mongodb:runnerstop",
+    "test": "npm run test:only",
+    "test:only": "TESTING=1 nyc jasmine",
+    "test:mongodb:runnerstart": "mongodb-runner start -t standalone -- --port 27017",
+    "test:mongodb:runnerstop": "mongodb-runner stop --all",
     "coverage": "nyc jasmine"
   },
   "engines": {

package/spec/SQSEventEmitterMQ.spec.js

@@ -1,51 +1,36 @@
-const sinon = require('sinon');
 const { ParseMessageQueue } = require('../node_modules/parse-server/lib/ParseMessageQueue');
 const { SQSEventEmitterMQ } = require('../');
 const { logger } = require('parse-server');
+const { getServerConfig } = require('./support/server.js');
+const { getMockSqsOptions } = require('./mocks/sqs.js');
 
 let config;
 
 describe('SMSEventEmitterMQ', () => {
   beforeEach(() => {
-    const response = {
-      Messages: [{
-        ReceiptHandle: 'receipt-handle',
-        MessageId: '123',
-        Body: 'body',
-      }],
-    };
-
-    const sqs = sinon.mock();
-    sqs.sendMessageBatch = sinon.stub();
-    sqs.receiveMessage = sinon.stub().yieldsAsync(null, response);
-    sqs.receiveMessage.onSecondCall().returns();
-    sqs.deleteMessage = sinon.stub();
-
-    config = {
-      messageQueueAdapter: SQSEventEmitterMQ,
-      queueUrl: 'test-queue',
-      region: 'mock',
-      sqs,
-    };
+    config = getMockSqsOptions();
   });
 
-  xit('a test for real that can be done against a live queue', (done) => {
-    const CHANNEL = 'foo';
-    const MESSAGE = 'hi';
-
-    const subscriber = ParseMessageQueue.createSubscriber(config);
-    const publisher = ParseMessageQueue.createPublisher(config);
+  describe('integration', () => {
+    it('publishes a message', done => {
+      const options = getServerConfig().queueOptions;
+      const subscriber = ParseMessageQueue.createSubscriber(options);
+      const publisher = ParseMessageQueue.createPublisher(options);
+      const channel = 'foo';
+      const message = 'hi';
+
+      subscriber.subscribe(channel);
+      subscriber.on('message', (channel, message) => {
+        expect(channel).toBe(channel);
+        expect(message).toBe(message);
+
+        // Give aws-sdk some time to mark the message to avoid flaky test
+        setTimeout(done, 200);
+      });
 
-    subscriber.subscribe(CHANNEL);
-    subscriber.on('message', (channel, message) => {
-      expect(channel).toBe(CHANNEL);
-      expect(message).toBe(MESSAGE);
-      // need to give the aws-sdk some time to mark the message
-      setTimeout(done, 500);
+      publisher.publish(channel, message);
     });
-
-    publisher.publish(CHANNEL, MESSAGE);
-  }).pend('configure options for a real sqs endpoint');
+  });
 
   describe('subscriber', () => {
     it('should only have one subscription map', () => {
@@ -73,7 +58,7 @@ describe('SMSEventEmitterMQ', () => {
       subscriber.subscribe('message_processed');
       subscriber.on('message', (event, message) => {
         expect(event).toBe('message_processed');
-        expect(message).toBe('body');
+        expect(message).toBe('hi');
         done();
       });
     });
@@ -110,7 +95,7 @@ describe('SMSEventEmitterMQ', () => {
         { id: '0', body: 'foo', groupId: 'channel' },
         { id: '1', body: 'bar', groupId: 'channel' },
       ];
-      expect(publisher.emitter.send).toHaveBeenCalledWith(payload, jasmine.any(Function));
+      expect(publisher.emitter.send).toHaveBeenCalledWith(payload);
     });
 
     it('should process a batch with no channel', () => {
@@ -121,7 +106,7 @@ describe('SMSEventEmitterMQ', () => {
         { id: '0', body: 'foo' },
         { id: '1', body: 'bar' },
       ];
-      expect(publisher.emitter.send).toHaveBeenCalledWith(payload, jasmine.any(Function));
+      expect(publisher.emitter.send).toHaveBeenCalledWith(payload);
     });
   });
 });

package/spec/integration.spec.js

@@ -0,0 +1,3 @@
+
+
+

package/spec/mocks/sqs.js

@@ -0,0 +1,34 @@
+const { SQSEventEmitterMQ } = require('../../');
+
+function getMockSqsOptions() {
+  const response = {
+    Messages: [
+      {
+        ReceiptHandle: 'receipt-handle',
+        MessageId: '123',
+        Body: 'hi',
+      },
+    ],
+  };
+
+  let call = 0;
+  const sqs = {
+    sendMessageBatch: () => Promise.resolve({}),
+    send: () => {
+      call += 1;
+      if (call === 1) {
+        return Promise.resolve(response);
+      }
+      return Promise.resolve({});
+    },
+  };
+
+  return {
+    messageQueueAdapter: SQSEventEmitterMQ,
+    queueUrl: 'test-queue',
+    region: 'mock',
+    sqs,
+  };
+}
+
+module.exports = { getMockSqsOptions };

package/spec/support/helper.js

@@ -0,0 +1,16 @@
+'use strict';
+const { startServer, stopServer, reconfigureServer } = require('./server');
+
+jasmine.DEFAULT_TIMEOUT_INTERVAL = process.env.TESTING_TIMEOUT || '360000';
+
+beforeAll(async () => {
+  await startServer();
+});
+
+afterAll(async () => {
+  await stopServer();
+});
+
+beforeEach(async () => {
+  await reconfigureServer();
+});

package/spec/support/jasmine.js

@@ -0,0 +1,12 @@
+const semver = require('semver');
+
+const satisfiesParseServerVersion = version => {
+  const envVersion = process.env.PARSE_SERVER_VERSION;
+  const semverVersion = semver.coerce(envVersion);
+  return !envVersion || !semverVersion || semver.satisfies(semverVersion, version);
+};
+
+global.it_only_parse_server_version = version => satisfiesParseServerVersion(version) ? it : xit;
+global.fit_only_parse_server_version = version => satisfiesParseServerVersion(version) ? fit : xit;
+global.describe_only_parse_server_version = version => satisfiesParseServerVersion(version) ? describe : xdescribe;
+global.fdescribe_only_parse_server_version = version => satisfiesParseServerVersion(version) ? fdescribe : xdescribe;

package/spec/support/jasmine.json

@@ -0,0 +1,13 @@
+{
+  "spec_dir": "spec",
+  "spec_files": [
+    "**/*[sS]pec.js"
+  ],
+  "helpers": [
+    "support/helper.js",
+    "support/jasmine.js",
+    "support/reporter.js"
+  ],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}

package/spec/support/reporter.js

@@ -0,0 +1,12 @@
+const { SpecReporter } = require('jasmine-spec-reporter');
+
+jasmine.getEnv().clearReporters();
+jasmine.getEnv().addReporter(
+  new SpecReporter({
+    spec: {
+      displayPending: true,
+      displayDuration: true,
+      displayStacktrace: 'pretty',
+    },
+  })
+);

package/spec/support/server.js

@@ -0,0 +1,81 @@
+const { ParseServer } = require('parse-server');
+const express = require('express');
+const http = require('http');
+const { getMockSqsOptions } = require('../mocks/sqs');
+const Config = require('../../node_modules/parse-server/lib/Config.js');
+
+const expressApp = express();
+const queueOptions = getMockSqsOptions();
+
+let serverState = {};
+
+const defaultConfig = {
+  databaseURI: 'mongodb://127.0.0.1:27017/sqs-mq-adapter',
+  appId: 'test',
+  masterKey: 'test',
+  maintenanceKey: 'test-maintenance-key',
+  serverURL: 'http://127.0.0.1:1327/api/parse',
+  port: 1327,
+  mountPath: '/api/parse',
+  verbose: false,
+  silent: true,
+  queueOptions,
+  verifyUserEmails: false,
+};
+
+async function startServer(config = {}) {
+  if (!process.env.TESTING) {
+    throw 'requires test environment to run';
+  }
+
+  const serverConfig = Object.assign({}, config, defaultConfig);
+  const parseServer = ParseServer(serverConfig);
+  await parseServer.start();
+  expressApp.use(serverConfig.mountPath, parseServer.app);
+
+  const httpServer = http.createServer(expressApp);
+  await new Promise((resolve, reject) => {
+    httpServer
+      .listen(serverConfig.port)
+      .once('listening', resolve)
+      .once('error', (e) => reject(e));
+  }).catch((e) => {
+    throw new Error(`parse-server failed to launch with error: ${e}`);
+  });
+
+  Object.assign(serverState, {
+    parseServer,
+    httpServer,
+    serverConfig,
+  });
+}
+
+async function stopServer() {
+  if (!process.env.TESTING) {
+    throw 'requires test environment to run';
+  }
+
+  await Parse.User.logOut();
+  const app = Config.get(defaultConfig.appId);
+  await app?.database.deleteEverything(true);
+
+  const { httpServer } = serverState;
+  await new Promise((resolve) => httpServer.close(resolve));
+  serverState = {};
+}
+
+async function reconfigureServer(config = {}) {
+  await stopServer();
+  return await startServer(config);
+}
+
+function getServerConfig() {
+  return serverState.serverConfig || defaultConfig;
+}
+
+module.exports = {
+  reconfigureServer,
+  startServer,
+  stopServer,
+  getServerConfig,
+};

package/eslint.config.js

@@ -1,41 +0,0 @@
-import js from '@eslint/js';
-import globals from 'globals';
-
-export default [
-  js.configs.recommended,
-  {
-    files: ['**/*.js'],
-    ignores: ['node_modules/**'],
-    languageOptions: {
-      ecmaVersion: 6,
-      sourceType: 'module',
-      globals: {
-        ...globals.node,
-        Parse: 'readonly'
-      }
-    },
-    rules: {
-      indent: ['error', 2, { SwitchCase: 1 }],
-      'linebreak-style': ['error', 'unix'],
-      'no-trailing-spaces': 2,
-      'eol-last': 2,
-      'space-in-parens': ['error', 'never'],
-      'no-multiple-empty-lines': 1,
-      'prefer-const': 'error',
-      'space-infix-ops': 'error',
-      'no-useless-escape': 'off',
-      'require-atomic-updates': 'off',
-      'object-curly-spacing': ['error', 'always']
-    }
-  },
-  {
-    files: ['spec/**/*.js'],
-    languageOptions: {
-      globals: {
-        ...globals.node,
-        ...globals.jasmine,
-        Parse: 'readonly'
-      }
-    }
-  }
-];