feat(queue): support getGlobalRateLimit method (#3511)

Author: roggervalf

docs/gitbook/guide/queues/global-rate-limit.md

@@ -9,10 +9,16 @@ import { Queue } from 'bullmq';
 await queue.setGlobalRateLimit(1, 1000);
 ```
 
-And in order to get this value:
+In order to get these values:
 
 ```typescript
-const globalConcurrency = await queue.getRateLimitTtl();
+const { max, duration } = await queue.getGlobalRateLimit();
+```
+
+And in order to get current ttl:
+
+```typescript
+const ttl = await queue.getRateLimitTtl();
 ```
 
 {% hint style="info" %}
@@ -30,5 +36,6 @@ await queue.removeGlobalRateLimit();
 ## Read more:
 
 - 💡 [Set Global Rate Limit API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#setglobalratelimit)
+- 💡 [Get Global Rate Limit API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#getglobalratelimit)
 - 💡 [Get Rate Limit Ttl API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#getratelimitttl)
 - 💡 [Remove Global Rate Limit API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#removeglobalratelimit)

src/classes/queue-getters.ts

@@ -117,6 +117,42 @@ export class QueueGetters<JobBase extends Job = Job> extends QueueBase {
     return client.get(`${this.keys.de}:${id}`);
   }
 
+  /**
+   * Get global concurrency value.
+   * Returns null in case no value is set.
+   */
+  async getGlobalConcurrency(): Promise<number | null> {
+    const client = await this.client;
+    const concurrency = await client.hget(this.keys.meta, 'concurrency');
+    if (concurrency) {
+      return Number(concurrency);
+    }
+    return null;
+  }
+
+  /**
+   * Get global rate limit values.
+   * Returns null in case no value is set.
+   */
+  async getGlobalRateLimit(): Promise<{
+    max: number;
+    duration: number;
+  } | null> {
+    const client = await this.client;
+    const [max, duration] = await client.hmget(
+      this.keys.meta,
+      'max',
+      'duration',
+    );
+    if (max && duration) {
+      return {
+        max: Number(max),
+        duration: Number(duration),
+      };
+    }
+    return null;
+  }
+
   /**
    * Job counts by type
    *

src/classes/queue.ts

@@ -96,33 +96,22 @@ export interface QueueListener<JobBase extends Job = Job>
  */
 type IsAny<T> = 0 extends 1 & T ? true : false;
 // Helper for JobBase type
-type JobBase<T, ResultType, NameType extends string> = IsAny<T> extends true
-  ? Job<T, ResultType, NameType>
-  : T extends Job<any, any, any>
-  ? T
-  : Job<T, ResultType, NameType>;
+type JobBase<T, ResultType, NameType extends string> =
+  IsAny<T> extends true
+    ? Job<T, ResultType, NameType>
+    : T extends Job<any, any, any>
+      ? T
+      : Job<T, ResultType, NameType>;
 
 // Helper types to extract DataType, ResultType, and NameType
-type ExtractDataType<DataTypeOrJob, Default> = DataTypeOrJob extends Job<
-  infer D,
-  any,
-  any
->
-  ? D
-  : Default;
-
-type ExtractResultType<DataTypeOrJob, Default> = DataTypeOrJob extends Job<
-  any,
-  infer R,
-  any
->
-  ? R
-  : Default;
-
-type ExtractNameType<
-  DataTypeOrJob,
-  Default extends string,
-> = DataTypeOrJob extends Job<any, any, infer N> ? N : Default;
+type ExtractDataType<DataTypeOrJob, Default> =
+  DataTypeOrJob extends Job<infer D, any, any> ? D : Default;
+
+type ExtractResultType<DataTypeOrJob, Default> =
+  DataTypeOrJob extends Job<any, infer R, any> ? R : Default;
+
+type ExtractNameType<DataTypeOrJob, Default extends string> =
+  DataTypeOrJob extends Job<any, any, infer N> ? N : Default;
 
 /**
  * Queue
@@ -277,19 +266,6 @@ export class Queue<
     });
   }
 
-  /**
-   * Get global concurrency value.
-   * Returns null in case no value is set.
-   */
-  async getGlobalConcurrency(): Promise<number | null> {
-    const client = await this.client;
-    const concurrency = await client.hget(this.keys.meta, 'concurrency');
-    if (concurrency) {
-      return Number(concurrency);
-    }
-    return null;
-  }
-
   /**
    * Enable and set global concurrency value.
    * @param concurrency - Maximum number of simultaneous jobs that the workers can handle.

tests/test_rate_limiter.ts

@@ -98,6 +98,9 @@ describe('Rate Limiter', function () {
       );
 
       await queue.setGlobalRateLimit(1, 500);
+      const globalRateLimit = await queue.getGlobalRateLimit();
+
+      expect(globalRateLimit).to.deep.equal({ max: 1, duration: 500 });
 
       const result = new Promise<void>((resolve, reject) => {
         queueEvents.on(
@@ -152,6 +155,10 @@ describe('Rate Limiter', function () {
         await queue.setGlobalRateLimit(1, 500);
         await queue.removeGlobalRateLimit();
 
+        const globalRateLimit = await queue.getGlobalRateLimit();
+
+        expect(globalRateLimit).to.be.null;
+
         const result = new Promise<void>((resolve, reject) => {
           queueEvents.on(
             'completed',