Accept and support the upcoming Hive PubSub (#8716)

Author: enisdenjo

.changeset/@graphql-mesh_types-8716-dependencies.md

@@ -0,0 +1,7 @@
+---
+"@graphql-mesh/types": patch
+---
+dependencies updates:
+  - Added dependency [`@graphql-hive/pubsub@next` ↗︎](https://www.npmjs.com/package/@graphql-hive/pubsub/v/next) (to `dependencies`)
+  - Added dependency [`@repeaterjs/repeater@^3.0.6` ↗︎](https://www.npmjs.com/package/@repeaterjs/repeater/v/3.0.6) (to `dependencies`)
+  - Added dependency [`@whatwg-node/disposablestack@^0.0.6` ↗︎](https://www.npmjs.com/package/@whatwg-node/disposablestack/v/0.0.6) (to `dependencies`)

.changeset/cute-ducks-brush.md

@@ -0,0 +1,13 @@
+---
+'@omnigraph/json-schema': patch
+'@graphql-mesh/cache-inmemory-lru': patch
+'@graphql-mesh/plugin-live-query': patch
+'@graphql-mesh/cache-localforage': patch
+'@graphql-mesh/transport-neo4j': patch
+'@graphql-mesh/transport-rest': patch
+'@omnigraph/neo4j': patch
+'@graphql-mesh/utils': patch
+'@graphql-mesh/cache-redis': patch
+---
+
+Accept and support the upcoming and improved `HivePubSub` from `@graphql-hive/pubsub`

.changeset/hungry-suns-appear.md

@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/types': patch
+---
+
+Export the upcoming and improved `HivePubSub` from `@graphql-hive/pubsub` together with a utility to detect and convert it to the legacy `MeshPubSub`

e2e/openapi-additional-resolvers/mesh.config.ts

@@ -23,6 +23,11 @@ export const composeConfig = defineComposeConfig({
 });
 
 export const gatewayConfig = defineGatewayConfig({
+  transportEntries: {
+    '*.rest': {
+      headers: [['user-agent', 'hive-gateway/e2e']],
+    },
+  },
   additionalResolvers: {
     pageview_project: {
       banana() {

e2e/openapi-javascript-wiki/mesh.config.ts

@@ -25,6 +25,11 @@ export const composeConfig = defineComposeConfig({
 });
 
 export const gatewayConfig = defineGatewayConfig({
+  transportEntries: {
+    '*.rest': {
+      headers: [['user-agent', 'hive-gateway/e2e']],
+    },
+  },
   additionalResolvers: {
     Query: {
       async viewsInPastMonth(root, { project }, context: any, info) {

packages/cache/inmemory-lru/src/index.ts

@@ -1,20 +1,27 @@
-import type { KeyValueCache, KeyValueCacheSetOptions, MeshPubSub } from '@graphql-mesh/types';
+import {
+  toMeshPubSub,
+  type HivePubSub,
+  type KeyValueCache,
+  type KeyValueCacheSetOptions,
+  type MeshPubSub,
+} from '@graphql-mesh/types';
 import { createLruCache, type LRUCache } from '@graphql-mesh/utils';
 import { DisposableSymbols } from '@whatwg-node/disposablestack';
 
 export interface InMemoryLRUCacheOptions {
   max?: number;
   ttl?: number;
-  pubsub?: MeshPubSub;
+  pubsub?: MeshPubSub | HivePubSub;
 }
 
 export default class InMemoryLRUCache<V = any> implements KeyValueCache<V>, Disposable {
   private lru: LRUCache;
   private timeouts = new Map<string, ReturnType<typeof setTimeout>>();
   constructor(options?: InMemoryLRUCacheOptions) {
     this.lru = createLruCache(options?.max, options?.ttl);
-    const subId = options?.pubsub?.subscribe?.('destroy', () => {
-      options?.pubsub?.unsubscribe(subId);
+    const pubsub = toMeshPubSub(options?.pubsub);
+    const subId = pubsub?.subscribe?.('destroy', () => {
+      pubsub.unsubscribe(subId);
       this[DisposableSymbols.dispose]();
     });
   }

packages/cache/localforage/src/index.ts

@@ -1,6 +1,7 @@
 import LocalForage from 'localforage';
 import InMemoryLRUCache from '@graphql-mesh/cache-inmemory-lru';
 import type {
+  HivePubSub,
   KeyValueCache,
   KeyValueCacheSetOptions,
   MeshPubSub,
@@ -9,7 +10,7 @@ import type {
 
 export default class LocalforageCache<V = any> implements KeyValueCache<V> {
   private localforage: LocalForage;
-  constructor(config?: YamlConfig.LocalforageConfig & { pubsub?: MeshPubSub }) {
+  constructor(config?: YamlConfig.LocalforageConfig & { pubsub?: MeshPubSub | HivePubSub }) {
     const driverNames = config?.driver || ['INDEXEDDB', 'WEBSQL', 'LOCALSTORAGE'];
     if (driverNames.every(driverName => !LocalForage.supports(driverName))) {
       return new InMemoryLRUCache({ pubsub: config?.pubsub }) as any;

packages/cache/redis/src/index.ts

@@ -2,12 +2,14 @@ import Redis, { type Cluster } from 'ioredis';
 import RedisMock from 'ioredis-mock';
 import { process } from '@graphql-mesh/cross-helpers';
 import { stringInterpolator } from '@graphql-mesh/string-interpolation';
-import type {
-  KeyValueCache,
-  KeyValueCacheSetOptions,
-  Logger,
-  MeshPubSub,
-  YamlConfig,
+import {
+  toMeshPubSub,
+  type HivePubSub,
+  type KeyValueCache,
+  type KeyValueCacheSetOptions,
+  type Logger,
+  type MeshPubSub,
+  type YamlConfig,
 } from '@graphql-mesh/types';
 import { DisposableSymbols } from '@whatwg-node/disposablestack';
 
@@ -18,7 +20,9 @@ function interpolateStrWithEnv(str: string): string {
 export default class RedisCache<V = string> implements KeyValueCache<V>, Disposable {
   private client: Redis | Cluster;
 
-  constructor(options: YamlConfig.Cache['redis'] & { pubsub?: MeshPubSub; logger: Logger }) {
+  constructor(
+    options: YamlConfig.Cache['redis'] & { pubsub?: MeshPubSub | HivePubSub; logger: Logger },
+  ) {
     const lazyConnect = options.lazyConnect !== false;
     if ('startupNodes' in options) {
       const parsedUsername =
@@ -117,10 +121,11 @@ export default class RedisCache<V = string> implements KeyValueCache<V>, Disposa
         this.client = new RedisMock();
       }
     }
+    const pubsub = toMeshPubSub(options.pubsub);
     // TODO: PubSub.destroy will no longer be needed after v0
-    const id = options.pubsub?.subscribe('destroy', () => {
+    const id = pubsub?.subscribe('destroy', () => {
       this.client.disconnect(false);
-      options.pubsub.unsubscribe(id);
+      pubsub.unsubscribe(id);
     });
   }
 

packages/legacy/types/package.json

@@ -35,11 +35,14 @@
     "graphql": "*"
   },
   "dependencies": {
+    "@graphql-hive/pubsub": "next",
     "@graphql-mesh/store": "^0.104.7",
     "@graphql-tools/batch-delegate": "^9.0.10",
     "@graphql-tools/delegate": "^10.0.28",
     "@graphql-tools/utils": "^10.8.0",
     "@graphql-typed-document-node/core": "^3.2.0",
+    "@repeaterjs/repeater": "^3.0.6",
+    "@whatwg-node/disposablestack": "^0.0.6",
     "tslib": "^2.4.0"
   },
   "devDependencies": {

packages/legacy/types/src/index.ts

@@ -14,6 +14,9 @@ import type {
 import type { ExecutionRequest, Executor, IResolvers, MaybePromise } from '@graphql-tools/utils';
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import * as YamlConfig from './config.js';
+import type { MeshPubSub } from './pubsub.js';
+
+export * from './pubsub.js';
 
 export { jsonSchema } from './config-schema.js';
 
@@ -65,25 +68,6 @@ export interface MeshHandlerLibrary<TConfig = any> {
   new (options: MeshHandlerOptions<TConfig>): MeshHandler;
 }
 
-// Hooks
-export type AllHooks = {
-  destroy: void;
-  [key: string]: any;
-};
-export type HookName = keyof AllHooks & string;
-
-export interface MeshPubSub {
-  publish<THook extends HookName>(triggerName: THook, payload: AllHooks[THook]): void;
-  subscribe<THook extends HookName>(
-    triggerName: THook,
-    onMessage: (data: AllHooks[THook]) => void,
-    options?: any,
-  ): number;
-  unsubscribe(subId: number): void;
-  getEventNames(): Iterable<string>;
-  asyncIterator<THook extends HookName>(triggers: THook): AsyncIterable<AllHooks[THook]>;
-}
-
 export interface MeshTransformOptions<Config = any> {
   apiName: string;
   config: Config;