Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia
TypeScript apiapi-clientapi-restapi-testingdeveloper-toolsgraphqlhttphttp-clientpwarestrest-apispatestingtesting-toolstoolsvuevuejswebsocket
chore: added message types to PubSub Service
ankitsridhar16a0006f73acc2
diff --git a/packages/hoppscotch-backend/src/pubsub/pubsub.service.ts b/packages/hoppscotch-backend/src/pubsub/pubsub.service.tsindex 475768712..854ef2e92 100644--- a/packages/hoppscotch-backend/src/pubsub/pubsub.service.ts+++ b/packages/hoppscotch-backend/src/pubsub/pubsub.service.ts@@ -4,6 +4,7 @@ import { default as Redis, RedisOptions } from 'ioredis';import { RedisPubSub } from 'graphql-redis-subscriptions';import { PubSub as LocalPubSub } from 'graphql-subscriptions';+import { MessageType } from './subscriptionTopicsDefs';/*** RedisPubSub uses JSON parsing for back and forth conversion, which loses Date objects, hence this reviver brings them back@@ -70,7 +71,10 @@ export class PubSubService implements OnModuleInit {return this.pubsub.asyncIterator(topic, options);}- async publish(topic: string, payload: any) {+ async publish<T extends keyof MessageType>(+ topic: T,+ payload: MessageType[T],+ ) {await this.pubsub.publish(topic, payload);}}diff --git a/packages/hoppscotch-backend/src/pubsub/subscriptionTopicsDefs.ts b/packages/hoppscotch-backend/src/pubsub/subscriptionTopicsDefs.tsnew file mode 100644index 000000000..c860d55a4--- /dev/null+++ b/packages/hoppscotch-backend/src/pubsub/subscriptionTopicsDefs.ts@@ -0,0 +1,14 @@+import { UserEnvironment } from '../user-environment/user-environments.model';+import { PrimitiveTypes } from '../types/primitiveTypes';++// A custom message type that defines the topic and the corresponding payload.+// For every module that publishes a subscription add its type def and the possible subscription type.+export type MessageType = {+ [+ topic: `user_environment/${string}/${+ | 'created'+ | 'updated'+ | 'deleted'+ | 'deleted_many'}`+ ]: UserEnvironment | PrimitiveTypes; // Returning a number hence having a union with `PrimitiveTypes`.+};diff --git a/packages/hoppscotch-backend/src/types/primitive-types.ts b/packages/hoppscotch-backend/src/types/primitiveTypes.tssimilarity index 100%rename from packages/hoppscotch-backend/src/types/primitive-types.tsrename to packages/hoppscotch-backend/src/types/primitiveTypes.ts