feat: Allow retrying completed jobs when using BullMQ

packages/api/src/handlers/queues.ts

@@ -95,6 +95,7 @@ async function getAppQueues(
         pagination,
         readOnlyMode: queue.readOnlyMode,
         allowRetries: queue.allowRetries,
+        allowCompletedRetries: queue.allowCompletedRetries,
         isPaused,
       };
     })

packages/api/src/handlers/retryAll.ts

@@ -1,14 +1,15 @@
 import { BullBoardRequest, ControllerHandlerReturnType } from '../../typings/app';
 import { BaseAdapter } from '../queueAdapters/base';
 import { queueProvider } from '../providers/queue';
-import { STATUSES } from '../constants/statuses';
 
 async function retryAll(
-  _req: BullBoardRequest,
-  queue: BaseAdapter
+  req: BullBoardRequest,
+  queue: BaseAdapter,
 ): Promise<ControllerHandlerReturnType> {
-  const jobs = await queue.getJobs([STATUSES.failed]);
-  await Promise.all(jobs.map((job) => job.retry()));
+  const { queueStatus } = req.params;
+
+  const jobs = await queue.getJobs([queueStatus]);
+  await Promise.all(jobs.map((job) => job.retry(queueStatus)));
 
   return { status: 200, body: {} };
 }

packages/api/src/handlers/retryJob.ts

@@ -7,10 +7,12 @@ import { jobProvider } from '../providers/job';
 import { queueProvider } from '../providers/queue';
 
 async function retryJob(
-  _req: BullBoardRequest,
+  req: BullBoardRequest,
   job: QueueJob
 ): Promise<ControllerHandlerReturnType> {
-  await job.retry();
+  const { queueStatus } = req.params;
+
+  await job.retry(queueStatus);
 
   return {
     status: 204,

packages/api/src/queueAdapters/base.ts

@@ -10,13 +10,15 @@ import {
 export abstract class BaseAdapter {
   public readonly readOnlyMode: boolean;
   public readonly allowRetries: boolean;
+  public readonly allowCompletedRetries: boolean;
   public readonly prefix: string;
   public readonly description: string;
   private formatters = new Map<FormatterField, (data: any) => any>();
 
   protected constructor(options: Partial<QueueAdapterOptions> = {}) {
     this.readOnlyMode = options.readOnlyMode === true;
     this.allowRetries = this.readOnlyMode ? false : options.allowRetries !== false;
+    this.allowCompletedRetries = this.allowRetries && options.allowCompletedRetries !== false;
     this.prefix = options.prefix || '';
     this.description = options.description || '';
   }

packages/api/src/queueAdapters/bull.ts

@@ -4,6 +4,7 @@ import { BaseAdapter } from './base';
 
 export class BullAdapter extends BaseAdapter {
   constructor(public queue: Queue, options: Partial<QueueAdapterOptions> = {}) {
+    options.allowCompletedRetries = false; // bull doesn't support this
     super(options);
   }
 

packages/api/src/routes.ts

@@ -28,7 +28,7 @@ export const appRoutes: AppRouteDefs = {
     },
     {
       method: 'put',
-      route: '/api/queues/:queueName/retry',
+      route: '/api/queues/:queueName/retry/:queueStatus',
       handler: retryAllHandler,
     },
     {
@@ -53,7 +53,7 @@ export const appRoutes: AppRouteDefs = {
     },
     {
       method: 'put',
-      route: '/api/queues/:queueName/:jobId/retry',
+      route: '/api/queues/:queueName/:jobId/retry/:queueStatus',
       handler: retryJobHandler,
     },
     {

packages/api/typings/app.ts

@@ -4,6 +4,8 @@ import { BaseAdapter } from '../src/queueAdapters/base';
 
 export type JobCleanStatus = 'completed' | 'wait' | 'active' | 'delayed' | 'failed';
 
+export type JobFinishedStatus = 'completed' | 'failed';
+
 export type Status = keyof typeof STATUSES;
 
 export type JobStatus = keyof Omit<typeof STATUSES, 'latest'>;
@@ -28,7 +30,7 @@ export interface QueueJob {
 
   remove(): Promise<void>;
 
-  retry(): Promise<void>;
+  retry(state?: JobFinishedStatus): Promise<void>;
 
   toJSON(): QueueJobJson;
 }
@@ -94,6 +96,7 @@ export interface AppQueue {
   pagination: Pagination;
   readOnlyMode: boolean;
   allowRetries: boolean;
+  allowCompletedRetries: boolean;
   isPaused: boolean;
 }
 

packages/ui/src/components/JobCard/JobActions/JobActions.tsx

@@ -13,37 +13,43 @@ interface JobActionsProps {
   allowRetries: boolean;
   actions: {
     promoteJob: () => Promise<void>;
-    retryJob: () => Promise<void>;
+    retryFailedJob: () => Promise<void>;
+    retryCompletedJob: () => Promise<void>;
     cleanJob: () => Promise<void>;
   };
 }
 
 interface ButtonType {
   title: string;
   Icon: React.ElementType;
-  actionKey: 'promoteJob' | 'cleanJob' | 'retryJob';
+  actionKey: 'promoteJob' | 'cleanJob' | 'retryFailedJob' | 'retryCompletedJob';
 }
 
 const buttonTypes: Record<string, ButtonType> = {
   promote: { title: 'Promote', Icon: PromoteIcon, actionKey: 'promoteJob' },
   clean: { title: 'Clean', Icon: TrashIcon, actionKey: 'cleanJob' },
-  retry: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryJob' },
+  retryFailed: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryFailedJob' },
+  retryCompleted: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryCompletedJob' },
 };
 
 const statusToButtonsMap: Record<string, ButtonType[]> = {
-  [STATUSES.failed]: [buttonTypes.retry, buttonTypes.clean],
+  [STATUSES.failed]: [buttonTypes.retryFailed, buttonTypes.clean],
   [STATUSES.delayed]: [buttonTypes.promote, buttonTypes.clean],
-  [STATUSES.completed]: [buttonTypes.clean],
+  [STATUSES.completed]: [buttonTypes.retryCompleted, buttonTypes.clean],
   [STATUSES.waiting]: [buttonTypes.clean],
 };
 
+function isRetry(actionKey: ButtonType['actionKey']) {
+  return ['retryFailedJob', 'retryCompletedJob'].includes(actionKey);
+}
+
 export const JobActions = ({ actions, status, allowRetries }: JobActionsProps) => {
   let buttons = statusToButtonsMap[status];
   if (!buttons) {
     return null;
   }
   if (!allowRetries) {
-    buttons = buttons.filter((btn) => btn.actionKey !== 'retryJob');
+    buttons = buttons.filter((btn) => !isRetry(btn.actionKey));
   }
   return (
     <ul className={s.jobActions}>

packages/ui/src/components/JobCard/JobCard.tsx

@@ -14,7 +14,8 @@ interface JobCardProps {
   allowRetries: boolean;
   actions: {
     promoteJob: () => Promise<void>;
-    retryJob: () => Promise<void>;
+    retryFailedJob: () => Promise<void>;
+    retryCompletedJob: () => Promise<void>;
     cleanJob: () => Promise<void>;
     getJobLogs: () => Promise<string[]>;
   };

packages/ui/src/components/QueueActions/QueueActions.tsx

@@ -25,6 +25,13 @@ const CleanAllButton = ({ onClick }: any) => (
   </Button>
 );
 
+const RetryAllButton = ({ onClick }: any) => (
+  <Button onClick={onClick} className={s.button}>
+    <RetryIcon />
+    Retry all
+  </Button>
+);
+
 export const QueueActions = ({ status, actions, queue, allowRetries }: QueueActionProps) => {
   if (!isStatusActionable(status)) {
     return null;
@@ -36,10 +43,7 @@ export const QueueActions = ({ status, actions, queue, allowRetries }: QueueActi
         <>
           {allowRetries && (
             <li>
-              <Button onClick={actions.retryAll(queue.name)} className={s.button}>
-                <RetryIcon />
-                Retry all
-              </Button>
+              <RetryAllButton onClick={actions.retryAllFailed(queue.name)} />
             </li>
           )}
           <li>
@@ -53,9 +57,16 @@ export const QueueActions = ({ status, actions, queue, allowRetries }: QueueActi
         </li>
       )}
       {status === STATUSES.completed && (
-        <li>
-          <CleanAllButton onClick={actions.cleanAllCompleted(queue.name)} />
-        </li>
+        <>
+          {allowRetries && (
+            <li>
+              <RetryAllButton onClick={actions.retryAllCompleted(queue.name)} />
+            </li>
+          )}
+          <li>
+            <CleanAllButton onClick={actions.cleanAllCompleted(queue.name)} />
+          </li>
+        </>
       )}
     </ul>
   );

packages/ui/src/components/QueuePage/QueuePage.tsx

@@ -31,7 +31,7 @@ export const QueuePage = ({
                 queue={queue}
                 actions={actions}
                 status={selectedStatus[queue.name]}
-                allowRetries={queue.allowRetries}
+                allowRetries={(selectedStatus[queue.name] == 'failed' || queue.allowCompletedRetries) && queue.allowRetries}
               />
             )}
           </div>
@@ -46,11 +46,12 @@ export const QueuePage = ({
           actions={{
             cleanJob: actions.cleanJob(queue?.name)(job),
             promoteJob: actions.promoteJob(queue?.name)(job),
-            retryJob: actions.retryJob(queue?.name)(job),
+            retryFailedJob: actions.retryJob(queue?.name)(job, 'failed'),
+            retryCompletedJob: actions.retryJob(queue?.name)(job, 'completed'),
             getJobLogs: actions.getJobLogs(queue?.name)(job),
           }}
           readOnlyMode={queue?.readOnlyMode}
-          allowRetries={queue?.allowRetries}
+          allowRetries={(job.isFailed || queue.allowCompletedRetries) && queue?.allowRetries}
         />
       ))}
     </section>

packages/ui/src/hooks/useStore.ts

@@ -1,4 +1,4 @@
-import { AppJob } from '@bull-board/api/typings/app';
+import { AppJob, JobFinishedStatus } from '@bull-board/api/typings/app';
 import { GetQueuesResponse } from '@bull-board/api/typings/responses';
 import { useState } from 'react';
 import { QueueActions, SelectedStatuses } from '../../typings/app';
@@ -88,9 +88,9 @@ export const useStore = (): Store => {
       confirmJobActions
     );
 
-  const retryJob = (queueName: string) => (job: AppJob) =>
+  const retryJob = (queueName: string) => (job: AppJob, status: JobFinishedStatus) =>
     withConfirmAndUpdate(
-      () => api.retryJob(queueName, job.id),
+      () => api.retryJob(queueName, job.id, status),
       'Are you sure that you want to retry this job?',
       confirmJobActions
     );
@@ -102,10 +102,10 @@ export const useStore = (): Store => {
       confirmJobActions
     );
 
-  const retryAll = (queueName: string) =>
+  const retryAll = (queueName: string, status: JobFinishedStatus) =>
     withConfirmAndUpdate(
-      () => api.retryAll(queueName),
-      'Are you sure that you want to retry all jobs?',
+      () => api.retryAll(queueName, status),
+      'Are you sure that you want to retry all failed jobs?',
       confirmQueueActions
     );
 

packages/ui/src/services/Api.ts

@@ -1,4 +1,4 @@
-import { AppJob, RedisStats, Status } from '@bull-board/api/typings/app';
+import { AppJob, JobFinishedStatus, RedisStats, Status } from '@bull-board/api/typings/app';
 import { GetQueuesResponse } from '@bull-board/api/typings/responses';
 import Axios, { AxiosInstance, AxiosResponse } from 'axios';
 import { toast } from 'react-toastify';
@@ -25,8 +25,8 @@ export class Api {
     return this.axios.get(`/queues`, { params: { activeQueue, status, page, jobsPerPage } });
   }
 
-  public retryAll(queueName: string): Promise<void> {
-    return this.axios.put(`/queues/${encodeURIComponent(queueName)}/retry`);
+  public retryAll(queueName: string, status: JobFinishedStatus): Promise<void> {
+    return this.axios.put(`/queues/${encodeURIComponent(queueName)}/retry/${encodeURIComponent(status)}`);
   }
 
   public cleanAllDelayed(queueName: string): Promise<void> {
@@ -47,9 +47,9 @@ export class Api {
     );
   }
 
-  public retryJob(queueName: string, jobId: AppJob['id']): Promise<void> {
+  public retryJob(queueName: string, jobId: AppJob['id'], status: JobFinishedStatus): Promise<void> {
     return this.axios.put(
-      `/queues/${encodeURIComponent(queueName)}/${encodeURIComponent(`${jobId}`)}/retry`
+      `/queues/${encodeURIComponent(queueName)}/${encodeURIComponent(`${jobId}`)}/retry/${encodeURIComponent(status)}`,
     );
   }
 

packages/ui/typings/app.d.ts

@@ -1,15 +1,15 @@
-import { AppJob, AppQueue, Status } from '@bull-board/api/typings/app';
+import { AppJob, AppQueue, JobFinishedStatus, Status } from '@bull-board/api/typings/app';
 
 export { Status } from '@bull-board/api/typings/app';
 
 export type SelectedStatuses = Record<AppQueue['name'], Status>;
 
 export interface QueueActions {
   promoteJob: (queueName: string) => (job: AppJob) => () => Promise<void>;
-  retryJob: (queueName: string) => (job: AppJob) => () => Promise<void>;
+  retryJob: (queueName: string) => (job: AppJob, status: JobFinishedStatus) => () => Promise<void>;
   cleanJob: (queueName: string) => (job: AppJob) => () => Promise<void>;
   getJobLogs: (queueName: string) => (job: AppJob) => () => Promise<string[]>;
-  retryAll: (queueName: string) => () => Promise<void>;
+  retryAll: (queueName: string, status: JobFinishedStatus) => () => Promise<void>;
   cleanAllDelayed: (queueName: string) => () => Promise<void>;
   cleanAllFailed: (queueName: string) => () => Promise<void>;
   cleanAllCompleted: (queueName: string) => () => Promise<void>;