feat(queue-details): add button to remove rate limit key (#688)

Author: roggervalf

public/dashboard.js

@@ -519,4 +519,31 @@ $(document).ready(() => {
       $(this).prop('disabled', false);
     }
   });
+
+  $('.js-remove-rate-limit-key').on('click', function (e) {
+    e.preventDefault();
+    const queueName = $(this).data('queue-name');
+    const queueHost = $(this).data('queue-host');
+
+    const response = window.confirm(
+      `Are you sure you want to remove the Rate Limit key for the queue "${queueHost}/${queueName}"?`
+    );
+    if (response) {
+      $.ajax({
+        method: 'DELETE',
+        url: `${basePath}/api/queue/${encodeURIComponent(
+          queueHost
+        )}/${encodeURIComponent(queueName)}/rate-limit-key`,
+      })
+        .done(() => {
+          window.location.reload();
+        })
+        .fail((jqXHR) => {
+          window.alert(`Request failed, check console for error.`);
+          console.error(jqXHR.responseText);
+        });
+    } else {
+      $(this).prop('disabled', false);
+    }
+  });
 });

screenshots/screen1.png

@@ -15,6 +15,7 @@ const bulkJobsRetry = require('./bulkJobsRetry');
 const queuePause = require('./queuePause');
 const queueResume = require('./queueResume');
 const queueUpdateMeta = require('./queueUpdateMeta');
+const queueRemoveRateLimitKey = require('./queueRemoveRateLimitKey');
 
 router.post('/queue/:queueHost/:queueName/job', jobAdd);
 router.post('/flow/:flowHost/:connectionName/flow', addFlow);
@@ -34,5 +35,9 @@ router.put('/queue/:queueHost/:queueName/resume', queueResume);
 router.put('/queue/:queueHost/:queueName/update-meta', queueUpdateMeta);
 router.delete('/queue/:queueHost/:queueName/job/:id', jobRemove);
 router.delete('/queue/:queueHost/:queueName/jobs/bulk', bulkJobsClean);
+router.delete(
+  '/queue/:queueHost/:queueName/rate-limit-key',
+  queueRemoveRateLimitKey
+);
 
 module.exports = router;

screenshots/screen1_sm.png

@@ -0,0 +1,17 @@
+async function handler(req, res) {
+  const {queueName, queueHost} = req.params;
+
+  const {Queues} = req.app.locals;
+
+  const queue = await Queues.get(queueName, queueHost);
+  if (!queue) return res.status(404).json({error: 'queue not found'});
+
+  try {
+    await queue.removeRateLimitKey();
+  } catch (err) {
+    return res.status(500).json({error: err.message});
+  }
+  return res.sendStatus(200);
+}
+
+module.exports = handler;

src/server/views/api/index.js

@@ -15,7 +15,7 @@ async function handler(req, res) {
       hasFlows: Flows.hasFlows(),
     });
 
-  let jobCounts, isPaused, globalConfig;
+  let jobCounts, hasRateLimitTtl, isPaused, globalConfig;
   if (queue.IS_BEE) {
     jobCounts = await queue.checkHealth();
     delete jobCounts.newestJob;
@@ -31,6 +31,12 @@ async function handler(req, res) {
   } else {
     jobCounts = await queue.getJobCounts();
   }
+
+  if (queue.IS_BULLMQ) {
+    const rateLimitTtl = await queue.getRateLimitTtl();
+    hasRateLimitTtl = rateLimitTtl > 0;
+  }
+
   const stats = await QueueHelpers.getStats(queue);
 
   if (!queue.IS_BEE) {
@@ -39,6 +45,7 @@ async function handler(req, res) {
 
   return res.render('dashboard/templates/queueDetails', {
     basePath,
+    hasRateLimitTtl,
     isPaused,
     queueName,
     queueHost,

src/server/views/api/queueRemoveRateLimitKey.js

@@ -14,6 +14,15 @@
 {{/if}}
 {{/unless}}
 
+{{#if queueIsBullMQ}}
+{{#if hasRateLimitTtl}}
+<button class="btn btn-xs btn-default js-remove-rate-limit-key" style="margin-bottom: 12px;" data-queue-host="{{ queueHost }}"
+  data-queue-name="{{ queueName }}">
+  Remove Rate Limit Key
+</button>
+{{/if}}
+{{/if}}
+
 <div class="row">
   <div class="col-sm-6">
     <div class="panel panel-default">