Merge pull request #636 from williamrijksen/feat/graphql-subscriptions-v3

feat: support graphql subscriptions v3

Author: davidyaha

package-lock.json

@@ -37,7 +37,7 @@
     "prepublishOnly": "npm run test"
   },
   "peerDependencies": {
-    "graphql-subscriptions": "^1.0.0 || ^2.0.0"
+    "graphql-subscriptions": "^1.0.0 || ^2.0.0 || ^3.0.0"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
@@ -53,7 +53,7 @@
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.23.0",
     "graphql": "^16.6.0",
-    "graphql-subscriptions": "^2.0.0",
+    "graphql-subscriptions": "^3.0.0",
     "ioredis": "^5.3.2",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",

package.json

@@ -31,7 +31,7 @@ import { PubSubEngine } from 'graphql-subscriptions';
  */
 export class PubSubAsyncIterator<T> implements AsyncIterableIterator<T> {
 
-  constructor(pubsub: PubSubEngine, eventNames: string | string[], options?: unknown) {
+  constructor(pubsub: PubSubEngine, eventNames: string | readonly string[], options?: unknown) {
     this.pubsub = pubsub;
     this.options = options;
     this.pullQueue = [];
@@ -61,7 +61,7 @@ export class PubSubAsyncIterator<T> implements AsyncIterableIterator<T> {
 
   private pullQueue: Array<(data: { value: unknown, done: boolean }) => void>;
   private pushQueue: any[];
-  private eventsArray: string[];
+  private eventsArray: readonly string[];
   private subscriptionIds: Promise<number[]> | undefined;
   private listening: boolean;
   private pubsub: PubSubEngine;

src/pubsub-async-iterator.ts

@@ -168,7 +168,11 @@ export class RedisPubSub implements PubSubEngine {
     delete this.subscriptionMap[subId];
   }
 
-  public asyncIterator<T>(triggers: string | string[], options?: unknown): AsyncIterator<T> {
+  public asyncIterator<T>(triggers: string | string[], options?: unknown) {
+    return new PubSubAsyncIterator<T>(this, triggers, options);
+  }
+
+  public asyncIterableIterator<T>(triggers: string | string[], options?: unknown) {
     return new PubSubAsyncIterator<T>(this, triggers, options);
   }
 

src/redis-pubsub.ts

@@ -64,8 +64,8 @@ describe('PubSubAsyncIterator', function() {
   `);
 
   const pubsub = new RedisPubSub();
-  const origIterator = pubsub.asyncIterator(FIRST_EVENT);
-  const origPatternIterator = pubsub.asyncIterator('SECOND*', { pattern: true });
+  const origIterator = pubsub.asyncIterableIterator(FIRST_EVENT);
+  const origPatternIterator = pubsub.asyncIterableIterator('SECOND*', { pattern: true });
   const returnSpy = mock(origIterator, 'return');
   const schema = buildSchema(origIterator, origPatternIterator);
 
@@ -128,7 +128,7 @@ describe('Subscribe to buffer', () => {
     // when using messageBuffer, with redis instance the channel name is not a string but a buffer
     const pubSub = new RedisPubSub({ messageEventName: 'messageBuffer'});
     const payload = 'This is amazing';
-    
+
     pubSub.subscribe('Posts', message => {
       try {
         expect(message).to.be.instanceOf(Buffer);

src/test/integration-tests.ts

@@ -480,17 +480,17 @@ describe('PubSubAsyncIterator', () => {
   it('should expose valid asyncItrator for a specific event', () => {
     const pubSub = new RedisPubSub(mockOptions);
     const eventName = 'test';
-    const iterator = pubSub.asyncIterator(eventName);
+    const iterator = pubSub.asyncIterableIterator(eventName);
     // tslint:disable-next-line:no-unused-expression
 		expect(iterator).to.exist;
 		// tslint:disable-next-line:no-unused-expression
 		expect(iterator[Symbol.asyncIterator]).not.to.be.undefined;
   });
 
-  it('should trigger event on asyncIterator when published', done => {
+  it('should trigger event on asyncIterableIterator when published', done => {
     const pubSub = new RedisPubSub(mockOptions);
     const eventName = 'test';
-    const iterator = pubSub.asyncIterator(eventName);
+    const iterator = pubSub.asyncIterableIterator(eventName);
 
     iterator.next().then(result => {
       // tslint:disable-next-line:no-unused-expression
@@ -505,10 +505,10 @@ describe('PubSubAsyncIterator', () => {
     pubSub.publish(eventName, { test: true });
   });
 
-  it('should not trigger event on asyncIterator when publishing other event', async () => {
+  it('should not trigger event on asyncIterableIterator when publishing other event', async () => {
     const pubSub = new RedisPubSub(mockOptions);
     const eventName = 'test2';
-    const iterator = pubSub.asyncIterator('test');
+    const iterator = pubSub.asyncIterableIterator('test');
     const triggerSpy = spy(() => undefined);
 
     iterator.next().then(triggerSpy);
@@ -519,7 +519,7 @@ describe('PubSubAsyncIterator', () => {
   it('register to multiple events', done => {
     const pubSub = new RedisPubSub(mockOptions);
     const eventName = 'test2';
-    const iterator = pubSub.asyncIterator(['test', 'test2']);
+    const iterator = pubSub.asyncIterableIterator(['test', 'test2']);
     const triggerSpy = spy(() => undefined);
 
     iterator.next().then(() => {
@@ -530,10 +530,10 @@ describe('PubSubAsyncIterator', () => {
     pubSub.publish(eventName, { test: true });
   });
 
-  it('should not trigger event on asyncIterator already returned', done => {
+  it('should not trigger event on asyncIterableIterator already returned', done => {
     const pubSub = new RedisPubSub(mockOptions);
     const eventName = 'test';
-    const iterator = pubSub.asyncIterator<any>(eventName);
+    const iterator = pubSub.asyncIterableIterator<any>(eventName);
 
     iterator.next().then(result => {
       // tslint:disable-next-line:no-unused-expression