feat(queue): add removeGlobalRateLimit method (#3481)

Author: roggervalf

docs/gitbook/guide/queues/global-concurrency.md

@@ -18,7 +18,16 @@ const globalConcurrency = await queue.getGlobalConcurrency();
 Note that if you choose a concurrency level in your workers, it will not override the global one, it will just be the maximum jobs a given worker can process in parallel but never more than the global one.
 {% endhint %}
 
+### Remove Global Concurrency
+
+It can be done using the following method:
+
+```typescript
+await queue.removeGlobalConcurrency();
+```
+
 ## Read more:
 
 - 💡 [Set Global Concurrency API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#setglobalconcurrency)
 - 💡 [Get Global Concurrency API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#getglobalconcurrency)
+- 💡 [Remove Global Concurrency API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#removeglobalconcurrency)

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

@@ -19,7 +19,16 @@ const globalConcurrency = await queue.getRateLimitTtl();
 Note that if you choose a rate limit level in your workers, it won't override the global one.
 {% endhint %}
 
+### Remove Global Rate Limit
+
+It can be done using the following method:
+
+```typescript
+await queue.removeGlobalRateLimit();
+```
+
 ## Read more:
 
 - 💡 [Set Global Rate Limit API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html#setglobalratelimit)
 - 💡 [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)

docs/gitbook/python/changelogs/changelog-v1.md

@@ -33,54 +33,57 @@
 
 * **job:** add isWaiting method [python] ([#2328](https://github.com/taskforcesh/bullmq/issues/2328)) ([5db9f95](https://github.com/taskforcesh/bullmq/commit/5db9f957939cd873eea0224d34569189e5520e84))
 
-## v1.19.0 (2023-12-12)
+# [1.19.0](https://github.com/taskforcesh/bullmq/compare/vpy1.18.0...vpy1.19.0) (2023-12-12)
 
-### Feature
 
-- **job:** Add promote method [python] ([#2323](https://github.com/taskforcesh/bullmq/issues/2323)) ([`61f4ba3`](https://github.com/taskforcesh/bullmq/commit/61f4ba3e99486aa36e5cc3d9b448b8080c567eb1))
+### Features
 
-## v1.18.0 (2023-12-10)
+* **job:** add promote method [python] ([#2323](https://github.com/taskforcesh/bullmq/issues/2323)) ([61f4ba3](https://github.com/taskforcesh/bullmq/commit/61f4ba3e99486aa36e5cc3d9b448b8080c567eb1))
 
-### Fix
+# [1.18.0](https://github.com/taskforcesh/bullmq/compare/vpy1.17.0...vpy1.18.0) (2023-12-10)
 
-- **retry:** Pass right redis command name into retryJob script (#2321) [python] ([`6bb21a0`](https://github.com/taskforcesh/bullmq/commit/6bb21a07c9754659fa5aa1734df1046a6da5d16a))
-- **flows:** Add meta key to queues created with flows ([`272ec69`](https://github.com/taskforcesh/bullmq/commit/272ec69557f601a138e1aaba739f7e7878d5344b))
-- **update-progress:** Remove old updateProgress script to prevent conflict (#2298) (python) ([`e65b819`](https://github.com/taskforcesh/bullmq/commit/e65b819101f8e0e8fdef8c51cfdf9a52f5e73f13))
-- **worker:** Should cap update progress events ([`2cab9e9`](https://github.com/taskforcesh/bullmq/commit/2cab9e94f65c7bdd053e3fb5944bcda6e3ebaa39))
 
-## v1.17.0 (2023-11-24)
+### Bug Fixes
 
-### Feature
+* **retry:** pass right redis command name into retryJob script ([#2321](https://github.com/taskforcesh/bullmq/issues/2321)) [python] ([6bb21a0](https://github.com/taskforcesh/bullmq/commit/6bb21a07c9754659fa5aa1734df1046a6da5d16a))
+* **flows:** add meta key to queues created with flows ([272ec69](https://github.com/taskforcesh/bullmq/commit/272ec69557f601a138e1aaba739f7e7878d5344b))
+* **update-progress:** remove old updateProgress script to prevent conflict ([#2298](https://github.com/taskforcesh/bullmq/issues/2298)) (python) ([e65b819](https://github.com/taskforcesh/bullmq/commit/e65b819101f8e0e8fdef8c51cfdf9a52f5e73f13))
+* **worker:** should cap update progress events ([2cab9e9](https://github.com/taskforcesh/bullmq/commit/2cab9e94f65c7bdd053e3fb5944bcda6e3ebaa39))
 
-- **worker:** Better handling of concurrency when fetching jobs ([#2242](https://github.com/taskforcesh/bullmq/issues/2242)) ([`d2e2035`](https://github.com/taskforcesh/bullmq/commit/d2e203588878ee64cb21e67141f73b32867dfb40))
+# [1.17.0](https://github.com/taskforcesh/bullmq/compare/vpy1.16.1...vpy1.17.0) (2023-11-24)
 
-### Fix
 
-- **worker:** Do not wait for slow jobs fixes #2290 ([`568d758`](https://github.com/taskforcesh/bullmq/commit/568d7585edb1f2ef15991d4ae4a2425e6834046a))
+### Features
 
-## v1.16.1 (2023-11-09)
+* **worker:** better handling of concurrency when fetching jobs ([#2242](https://github.com/taskforcesh/bullmq/issues/2242)) ([d2e2035](https://github.com/taskforcesh/bullmq/commit/d2e203588878ee64cb21e67141f73b32867dfb40))
 
-### Fix
+## [1.16.1](https://github.com/taskforcesh/bullmq/compare/vpy1.16.0...vpy1.16.1) (2023-11-09)
 
-- **job:** Set delay value on current job instance when it is retried (#2266) (python) ([`76e075f`](https://github.com/taskforcesh/bullmq/commit/76e075f54d5745b6cec3cb11305bf3110d963eae))
 
-## v1.16.0 (2023-11-08)
+### Bug Fixes
 
-### Fix
+* **job:** set delay value on current job instance when it is retried ([#2266](https://github.com/taskforcesh/bullmq/issues/2266)) (python) ([76e075f](https://github.com/taskforcesh/bullmq/commit/76e075f54d5745b6cec3cb11305bf3110d963eae))
 
-- **backoff:** Fix builtin backoff type (#2265) [python] ([`76959eb`](https://github.com/taskforcesh/bullmq/commit/76959eb9d9495eb1b6d2d31fab93c8951b5d3b93))
+# [1.16.0](https://github.com/taskforcesh/bullmq/compare/vpy1.15.4...vpy1.16.0) (2023-11-08)
 
-## v1.15.4 (2023-11-05)
 
-### Fix
+### Bug Fixes
 
-- Update delay job property when moving to delayed set ([#2261](https://github.com/taskforcesh/bullmq/issues/2261)) ([`69ece08`](https://github.com/taskforcesh/bullmq/commit/69ece08babd7716c14c38c3dd50630b44c7c1897))
+* **backoff:** fix builtin backoff type ([#2265](https://github.com/taskforcesh/bullmq/issues/2265)) [python] ([76959eb](https://github.com/taskforcesh/bullmq/commit/76959eb9d9495eb1b6d2d31fab93c8951b5d3b93))
 
-## v1.15.3 (2023-11-05)
+## [1.15.4](https://github.com/taskforcesh/bullmq/compare/vpy1.15.3...vpy1.15.4) (2023-11-05)
 
-### Fix
 
-- **add-job:** Trim events when waiting-children event is published (#2262) (python) ([`198bf05`](https://github.com/taskforcesh/bullmq/commit/198bf05fa5a4e1ce50081296033a2e0f26ece498))
+### Bug Fixes
+
+* update delay job property when moving to delayed set ([#2261](https://github.com/taskforcesh/bullmq/issues/2261)) ([69ece08](https://github.com/taskforcesh/bullmq/commit/69ece08babd7716c14c38c3dd50630b44c7c1897))
+
+## [1.15.3](https://github.com/taskforcesh/bullmq/compare/vpy1.15.2...vpy1.15.3) (2023-11-05)
+
+
+### Bug Fixes
+
+* **add-job:** trim events when waiting-children event is published ([#2262](https://github.com/taskforcesh/bullmq/issues/2262)) (python) ([198bf05](https://github.com/taskforcesh/bullmq/commit/198bf05fa5a4e1ce50081296033a2e0f26ece498))
 
 ## v1.15.2 (2023-10-18)
 

src/classes/queue.ts

@@ -309,6 +309,14 @@ export class Queue<
     return client.hdel(this.keys.meta, 'concurrency');
   }
 
+  /**
+   * Remove global rate limit values.
+   */
+  async removeGlobalRateLimit() {
+    const client = await this.client;
+    return client.hdel(this.keys.meta, 'max', 'duration');
+  }
+
   /**
    * Adds a new job to the queue.
    *

tests/test_rate_limiter.ts

@@ -130,6 +130,60 @@ describe('Rate Limiter', function () {
       await result;
       await worker.close();
     });
+
+    describe('when rate limit is removed', () => {
+      it('should execute jobs without rate limit', async function () {
+        this.timeout(2000);
+
+        const numJobs = 10;
+
+        const worker = new Worker(
+          queueName,
+          async () => {
+            const currentTtl = await queue.getRateLimitTtl();
+            expect(currentTtl).to.be.equal(-2); // -2 means no rate limit
+          },
+          {
+            connection,
+            prefix,
+          },
+        );
+
+        await queue.setGlobalRateLimit(1, 500);
+        await queue.removeGlobalRateLimit();
+
+        const result = new Promise<void>((resolve, reject) => {
+          queueEvents.on(
+            'completed',
+            // after every job has been completed
+            after(numJobs, async () => {
+              try {
+                const timeDiff = new Date().getTime() - startTime;
+                expect(timeDiff).to.be.lte(150);
+                resolve();
+              } catch (err) {
+                reject(err);
+              }
+            }),
+          );
+
+          queueEvents.on('failed', async err => {
+            await worker.close();
+            reject(err);
+          });
+        });
+
+        const jobs = Array.from(Array(numJobs).keys()).map(() => ({
+          name: 'rate test',
+          data: {},
+        }));
+        const startTime = new Date().getTime();
+        await queue.addBulk(jobs);
+
+        await result;
+        await worker.close();
+      });
+    });
   });
 
   it('should obey the rate limit', async function () {