@aeolun/graphql-redis-subscriptions

<!doctype html> <html lang="en"> <head> <title>Code coverage report for redis-pubsub.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="index.html">All files</a> redis-pubsub.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 95.45% Statements 84/88 </div> <div class='fl pad1y space-right2'> 92.16% Branches 47/51 </div> <div class='fl pad1y space-right2'> 100% Functions 14/14 </div> <div class='fl pad1y space-right2'> 94.94% Lines 75/79 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a> <a name='L153'></a><a href='#L153'>153</a> <a name='L154'></a><a href='#L154'>154</a> <a name='L155'></a><a href='#L155'>155</a> <a name='L156'></a><a href='#L156'>156</a> <a name='L157'></a><a href='#L157'>157</a> <a name='L158'></a><a href='#L158'>158</a> <a name='L159'></a><a href='#L159'>159</a> <a name='L160'></a><a href='#L160'>160</a> <a name='L161'></a><a href='#L161'>161</a> <a name='L162'></a><a href='#L162'>162</a> <a name='L163'></a><a href='#L163'>163</a> <a name='L164'></a><a href='#L164'>164</a> <a name='L165'></a><a href='#L165'>165</a> <a name='L166'></a><a href='#L166'>166</a> <a name='L167'></a><a href='#L167'>167</a> <a name='L168'></a><a href='#L168'>168</a> <a name='L169'></a><a href='#L169'>169</a> <a name='L170'></a><a href='#L170'>170</a> <a name='L171'></a><a href='#L171'>171</a> <a name='L172'></a><a href='#L172'>172</a> <a name='L173'></a><a href='#L173'>173</a> <a name='L174'></a><a href='#L174'>174</a> <a name='L175'></a><a href='#L175'>175</a> <a name='L176'></a><a href='#L176'>176</a> <a name='L177'></a><a href='#L177'>177</a> <a name='L178'></a><a href='#L178'>178</a> <a name='L179'></a><a href='#L179'>179</a> <a name='L180'></a><a href='#L180'>180</a> <a name='L181'></a><a href='#L181'>181</a> <a name='L182'></a><a href='#L182'>182</a> <a name='L183'></a><a href='#L183'>183</a> <a name='L184'></a><a href='#L184'>184</a> <a name='L185'></a><a href='#L185'>185</a> <a name='L186'></a><a href='#L186'>186</a> <a name='L187'></a><a href='#L187'>187</a> <a name='L188'></a><a href='#L188'>188</a> <a name='L189'></a><a href='#L189'>189</a> <a name='L190'></a><a href='#L190'>190</a> <a name='L191'></a><a href='#L191'>191</a> <a name='L192'></a><a href='#L192'>192</a> <a name='L193'></a><a href='#L193'>193</a> <a name='L194'></a><a href='#L194'>194</a> <a name='L195'></a><a href='#L195'>195</a> <a name='L196'></a><a href='#L196'>196</a> <a name='L197'></a><a href='#L197'>197</a> <a name='L198'></a><a href='#L198'>198</a> <a name='L199'></a><a href='#L199'>199</a> <a name='L200'></a><a href='#L200'>200</a> <a name='L201'></a><a href='#L201'>201</a> <a name='L202'></a><a href='#L202'>202</a> <a name='L203'></a><a href='#L203'>203</a> <a name='L204'></a><a href='#L204'>204</a></td><td class="line-coverage quiet">  1x                                     1x   27x 25x                     25x 25x 250x   25x   25x 1x     24x 24x 24x   24x 22x 22x   2x   2x 2x 2x   2x               2x 2x                   24x   24x   24x 24x 24x     1x 39x     25x     47x     25x 25x 25x   25x 21x     25x 25x 4x 4x   21x 21x   21x 21x     21x 21x             1x 18x 18x   18x   16x   12x 12x   12x   4x   16x     1x 7x     1x 1x     1x 1x     1x 3x                                 18x 18x     18x     16x 16x       1x     16x 17x 17x     1x                      </td><td class="text"><pre class="prettyprint lang-js">import {Cluster, Redis, RedisOptions} from 'ioredis'; import {PubSubEngine, PubSubAsyncIterableIterator} from 'graphql-subscriptions-continued';   type RedisClient = Redis | Cluster; type OnMessage<T> = (message: T) => void; type DeserializerContext = { channel: string, pattern?: string };   export interface PubSubRedisOptions { connection?: RedisOptions | string; triggerTransform?: TriggerTransform; connectionListener?: (err: Error) => void; publisher?: RedisClient; subscriber?: RedisClient; reviver?: Reviver; serializer?: Serializer; deserializer?: Deserializer; messageEventName?: string; pmessageEventName?: string; }   export class RedisPubSub extends PubSubEngine {   constructor(options: PubSubRedisOptions = {}) { super();   const { triggerTransform, connection, connectionListener, subscriber, publisher, reviver, serializer, deserializer, messageEventName = 'message', pmessageEventName = 'pmessage', } = options;   this.triggerTransform = triggerTransform || (trigger => trigger as string);   if (reviver && deserializer) { throw new Error("Reviver and deserializer can't be used together"); }   this.reviver = reviver; this.serializer = serializer; this.deserializer = deserializer;   if (subscriber && publisher) { this.redisPublisher = publisher; this.redisSubscriber = subscriber; } else { try { // eslint-disable-next-line @typescript-eslint/no-var-requires const IORedis = require('ioredis'); this.redisPublisher = new IORedis(connection); this.redisSubscriber = new IORedis(connection);   Iif (connectionListener) { this.redisPublisher .on('connect', connectionListener) .on('error', connectionListener); this.redisSubscriber .on('connect', connectionListener) .on('error', connectionListener); } else { this.redisPublisher.on('error', console.error); this.redisSubscriber.on('error', console.error); } } catch (error) { console.error( `No publisher or subscriber instances were provided and the package 'ioredis' wasn't found. Couldn't create Redis clients.`, ); } }   // handle messages received via psubscribe and subscribe this.redisSubscriber.on(pmessageEventName, this.onMessage.bind(this)); // partially applied function passes undefined for pattern arg since 'message' event won't provide it: this.redisSubscriber.on(messageEventName, this.onMessage.bind(this, undefined));   this.subscriptionMap = {}; this.subsRefsMap = new Map<string, Set<number>>(); this.currentSubscriptionId = 0; }   public async publish<T>(trigger: string, payload: T): Promise<void> { await this.redisPublisher.publish(trigger, this.serializer ? this.serializer(payload) : JSON.stringify(payload)); }   public subscribe<T = any>( trigger: string, onMessage: OnMessage<T>, options: unknown = {}, ): Promise<number> {   const triggerName: string = this.triggerTransform(trigger, options); const id = this.currentSubscriptionId++; this.subscriptionMap[id] = [triggerName, onMessage];   if (!this.subsRefsMap.has(triggerName)) { this.subsRefsMap.set(triggerName, new Set()); }   const refs = this.subsRefsMap.get(triggerName); if (refs.size > 0) { refs.add(id); return Promise.resolve(id); } else { return new Promise<number>((resolve, reject) => { const subscribeFn = options['pattern'] ? this.redisSubscriber.psubscribe : this.redisSubscriber.subscribe;   subscribeFn.call(this.redisSubscriber, triggerName, err => { Iif (err) { reject(err); } else { refs.add(id); resolve(id); } }); }); } }   public unsubscribe(subId: number): void { const [triggerName = null] = this.subscriptionMap[subId] || []; const refs = this.subsRefsMap.get(triggerName);   if (!refs) throw new Error(`There is no subscription of id "${subId}"`);   if (refs.size === 1) { // unsubscribe from specific channel and pattern match this.redisSubscriber.unsubscribe(triggerName); this.redisSubscriber.punsubscribe(triggerName);   this.subsRefsMap.delete(triggerName); } else { refs.delete(subId); } delete this.subscriptionMap[subId]; }   public asyncIterator<T>(triggers: string | string[], options?: unknown) { return new PubSubAsyncIterableIterator<T>(this, triggers, options); }   public getSubscriber(): RedisClient { return this.redisSubscriber; }   public getPublisher(): RedisClient { return this.redisPublisher; }   public close(): Promise<'OK'[]> { return Promise.all([ this.redisPublisher.quit(), this.redisSubscriber.quit(), ]); }   private readonly serializer?: Serializer; private readonly deserializer?: Deserializer; private readonly triggerTransform: TriggerTransform; private readonly redisSubscriber: RedisClient; private readonly redisPublisher: RedisClient; private readonly reviver: Reviver;   private readonly subscriptionMap: { [subId: number]: [string, OnMessage<unknown>] }; private readonly subsRefsMap: Map<string, Set<number>>; private currentSubscriptionId: number;   private onMessage(pattern: string, channel: string, message: string) { const subscribers = this.subsRefsMap.get(pattern || channel);   // Don't work for nothing.. if (!subscribers?.size) return;   let parsedMessage; try { parsedMessage = this.deserializer ? this.deserializer(message, { pattern, channel }) : JSON.parse(message, this.reviver); } catch (e) { parsedMessage = message; }   subscribers.forEach(subId => { const [, listener] = this.subscriptionMap[subId]; listener(parsedMessage); }); } }   export type Path = Array<string | number>; export type Trigger = string | Path; export type TriggerTransform = ( trigger: Trigger, channelOptions?: unknown, ) => string; export type Reviver = (key: any, value: any) => any; export type Serializer = (source: any) => string; export type Deserializer = (source: string | Buffer, context: DeserializerContext) => any;  </pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Aug 14 2023 11:24:24 GMT+0900 (Japan Standard Time) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="sorter.js"></script> <script src="block-navigation.js"></script> </body> </html>