Simplify retry all functionality

felixmosh · Jan 1, 2023 · fec2d72 · fec2d72
1 parent dd7e3eb
commit fec2d72
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 38 deletions.
diff --git a/packages/api/typings/app.ts b/packages/api/typings/app.ts
@@ -4,7 +4,7 @@ import { BaseAdapter } from '../src/queueAdapters/base';
 
 export type JobCleanStatus = 'completed' | 'wait' | 'active' | 'delayed' | 'failed';
 
-export type JobFinishedStatus = 'completed' | 'failed';
+export type JobRetryStatus = 'completed' | 'failed';
 
 export type Status = keyof typeof STATUSES;
 
@@ -15,6 +15,7 @@ export type JobCounts = Record<Status, number>;
 export interface QueueAdapterOptions {
   readOnlyMode: boolean;
   allowRetries: boolean;
+  allowCompletedRetries: boolean;
   prefix: string;
   description: string;
 }
@@ -30,7 +31,7 @@ export interface QueueJob {
 
   remove(): Promise<void>;
 
-  retry(state?: JobFinishedStatus): Promise<void>;
+  retry(state?: JobRetryStatus): Promise<void>;
 
   toJSON(): QueueJobJson;
 }

diff --git a/packages/ui/src/components/App.tsx b/packages/ui/src/components/App.tsx
@@ -33,7 +33,7 @@ export const App = () => {
                   path="/queue/:name"
                   render={() => (
                     <QueuePage
-                      queue={activeQueue || undefined}
+                      queue={activeQueue || null}
                       actions={actions}
                       selectedStatus={selectedStatuses}
                     />

diff --git a/packages/ui/src/components/JobCard/JobActions/JobActions.tsx b/packages/ui/src/components/JobCard/JobActions/JobActions.tsx
@@ -13,44 +13,40 @@ interface JobActionsProps {
   allowRetries: boolean;
   actions: {
     promoteJob: () => Promise<void>;
-    retryFailedJob: () => Promise<void>;
-    retryCompletedJob: () => Promise<void>;
+    retryJob: () => Promise<void>;
     cleanJob: () => Promise<void>;
   };
 }
 
 interface ButtonType {
   title: string;
   Icon: React.ElementType;
-  actionKey: 'promoteJob' | 'cleanJob' | 'retryFailedJob' | 'retryCompletedJob';
+  actionKey: 'promoteJob' | 'cleanJob' | 'retryJob';
 }
 
 const buttonTypes: Record<string, ButtonType> = {
   promote: { title: 'Promote', Icon: PromoteIcon, actionKey: 'promoteJob' },
   clean: { title: 'Clean', Icon: TrashIcon, actionKey: 'cleanJob' },
-  retryFailed: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryFailedJob' },
-  retryCompleted: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryCompletedJob' },
+  retry: { title: 'Retry', Icon: RetryIcon, actionKey: 'retryJob' },
 };
 
 const statusToButtonsMap: Record<string, ButtonType[]> = {
-  [STATUSES.failed]: [buttonTypes.retryFailed, buttonTypes.clean],
+  [STATUSES.failed]: [buttonTypes.retry, buttonTypes.clean],
   [STATUSES.delayed]: [buttonTypes.promote, buttonTypes.clean],
-  [STATUSES.completed]: [buttonTypes.retryCompleted, buttonTypes.clean],
+  [STATUSES.completed]: [buttonTypes.retry, 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) => !isRetry(btn.actionKey));
+    buttons = buttons.filter((btn) => btn.actionKey !== 'retryJob');
   }
+
   return (
     <ul className={s.jobActions}>
       {buttons.map((type) => (

diff --git a/packages/ui/src/components/JobCard/JobCard.tsx b/packages/ui/src/components/JobCard/JobCard.tsx
@@ -14,8 +14,7 @@ interface JobCardProps {
   allowRetries: boolean;
   actions: {
     promoteJob: () => Promise<void>;
-    retryFailedJob: () => Promise<void>;
-    retryCompletedJob: () => Promise<void>;
+    retryJob: () => Promise<void>;
     cleanJob: () => Promise<void>;
     getJobLogs: () => Promise<string[]>;
   };

diff --git a/packages/ui/src/components/QueueActions/QueueActions.tsx b/packages/ui/src/components/QueueActions/QueueActions.tsx
@@ -43,7 +43,7 @@ export const QueueActions = ({ status, actions, queue, allowRetries }: QueueActi
         <>
           {allowRetries && (
             <li>
-              <RetryAllButton onClick={actions.retryAllFailed(queue.name)} />
+              <RetryAllButton onClick={actions.retryAll(queue.name, status)} />
             </li>
           )}
           <li>
@@ -60,7 +60,7 @@ export const QueueActions = ({ status, actions, queue, allowRetries }: QueueActi
         <>
           {allowRetries && (
             <li>
-              <RetryAllButton onClick={actions.retryAllCompleted(queue.name)} />
+              <RetryAllButton onClick={actions.retryAll(queue.name, status)} />
             </li>
           )}
           <li>

diff --git a/packages/ui/src/components/QueuePage/QueuePage.tsx b/packages/ui/src/components/QueuePage/QueuePage.tsx
@@ -4,22 +4,24 @@ import { JobCard } from '../JobCard/JobCard';
 import { QueueActions } from '../QueueActions/QueueActions';
 import { StatusMenu } from '../StatusMenu/StatusMenu';
 import s from './QueuePage.module.css';
-import { AppQueue } from '@bull-board/api/typings/app';
+import { AppQueue, JobRetryStatus } from '@bull-board/api/typings/app';
 import { Pagination } from '../Pagination/Pagination';
 
 export const QueuePage = ({
   selectedStatus,
   actions,
   queue,
 }: {
-  queue: AppQueue | undefined;
+  queue: AppQueue | null;
   actions: Store['actions'];
   selectedStatus: Store['selectedStatuses'];
 }) => {
   if (!queue) {
     return <section>Queue Not found</section>;
   }
 
+  const status = selectedStatus[queue.name];
+
   return (
     <section>
       <div className={s.stickyHeader}>
@@ -31,7 +33,10 @@ export const QueuePage = ({
                 queue={queue}
                 actions={actions}
                 status={selectedStatus[queue.name]}
-                allowRetries={(selectedStatus[queue.name] == 'failed' || queue.allowCompletedRetries) && queue.allowRetries}
+                allowRetries={
+                  (selectedStatus[queue.name] == 'failed' || queue.allowCompletedRetries) &&
+                  queue.allowRetries
+                }
               />
             )}
           </div>
@@ -42,12 +47,11 @@ export const QueuePage = ({
         <JobCard
           key={job.id}
           job={job}
-          status={selectedStatus[queue.name]}
+          status={status}
           actions={{
             cleanJob: actions.cleanJob(queue?.name)(job),
             promoteJob: actions.promoteJob(queue?.name)(job),
-            retryFailedJob: actions.retryJob(queue?.name)(job, 'failed'),
-            retryCompletedJob: actions.retryJob(queue?.name)(job, 'completed'),
+            retryJob: actions.retryJob(queue?.name, status as JobRetryStatus)(job),
             getJobLogs: actions.getJobLogs(queue?.name)(job),
           }}
           readOnlyMode={queue?.readOnlyMode}

diff --git a/packages/ui/src/components/QueueTitle/QueueTitle.tsx b/packages/ui/src/components/QueueTitle/QueueTitle.tsx
@@ -3,7 +3,7 @@ import React from 'react';
 import s from './QueueTitle.module.css';
 
 interface QueueTitleProps {
-  queue: AppQueue;
+  queue: Pick<AppQueue, 'name' | 'description'>;
 }
 export const QueueTitle = ({ queue }: QueueTitleProps) => (
   <div className={s.queueTitle}>

diff --git a/packages/ui/src/hooks/useStore.ts b/packages/ui/src/hooks/useStore.ts
@@ -1,4 +1,4 @@
-import { AppJob, JobFinishedStatus } from '@bull-board/api/typings/app';
+import { AppJob, JobRetryStatus } 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,7 +88,7 @@ export const useStore = (): Store => {
       confirmJobActions
     );
 
-  const retryJob = (queueName: string) => (job: AppJob, status: JobFinishedStatus) =>
+  const retryJob = (queueName: string, status: JobRetryStatus) => (job: AppJob) =>
     withConfirmAndUpdate(
       () => api.retryJob(queueName, job.id, status),
       'Are you sure that you want to retry this job?',
@@ -102,7 +102,7 @@ export const useStore = (): Store => {
       confirmJobActions
     );
 
-  const retryAll = (queueName: string, status: JobFinishedStatus) =>
+  const retryAll = (queueName: string, status: JobRetryStatus) =>
     withConfirmAndUpdate(
       () => api.retryAll(queueName, status),
       `Are you sure that you want to retry all ${status} jobs?`,
@@ -150,7 +150,7 @@ export const useStore = (): Store => {
       'Are you sure that you want to empty the queue?',
       confirmQueueActions
     );
-    
+
   const getJobLogs = (queueName: string) => (job: AppJob) => () =>
     api.getJobLogs(queueName, job.id);
 

diff --git a/packages/ui/src/services/Api.ts b/packages/ui/src/services/Api.ts
@@ -1,4 +1,4 @@
-import { AppJob, JobFinishedStatus, RedisStats, Status } from '@bull-board/api/typings/app';
+import { AppJob, JobRetryStatus, 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,10 @@ export class Api {
     return this.axios.get(`/queues`, { params: { activeQueue, status, page, jobsPerPage } });
   }
 
-  public retryAll(queueName: string, status: JobFinishedStatus): Promise<void> {
-    return this.axios.put(`/queues/${encodeURIComponent(queueName)}/retry/${encodeURIComponent(status)}`);
+  public retryAll(queueName: string, status: JobRetryStatus): Promise<void> {
+    return this.axios.put(
+      `/queues/${encodeURIComponent(queueName)}/retry/${encodeURIComponent(status)}`
+    );
   }
 
   public cleanAllDelayed(queueName: string): Promise<void> {
@@ -47,9 +49,11 @@ export class Api {
     );
   }
 
-  public retryJob(queueName: string, jobId: AppJob['id'], status: JobFinishedStatus): Promise<void> {
+  public retryJob(queueName: string, jobId: AppJob['id'], status: JobRetryStatus): Promise<void> {
     return this.axios.put(
-      `/queues/${encodeURIComponent(queueName)}/${encodeURIComponent(`${jobId}`)}/retry/${encodeURIComponent(status)}`,
+      `/queues/${encodeURIComponent(queueName)}/${encodeURIComponent(
+        `${jobId}`
+      )}/retry/${encodeURIComponent(status)}`
     );
   }
 

diff --git a/packages/ui/typings/app.d.ts b/packages/ui/typings/app.d.ts
@@ -1,15 +1,15 @@
-import { AppJob, AppQueue, JobFinishedStatus, Status } from '@bull-board/api/typings/app';
+import { AppJob, AppQueue, JobRetryStatus, 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, status: JobFinishedStatus) => () => Promise<void>;
+  retryJob: (queueName: string, status: JobRetryStatus) => (job: AppJob) => () => Promise<void>;
   cleanJob: (queueName: string) => (job: AppJob) => () => Promise<void>;
   getJobLogs: (queueName: string) => (job: AppJob) => () => Promise<string[]>;
-  retryAll: (queueName: string, status: JobFinishedStatus) => () => Promise<void>;
+  retryAll: (queueName: string, status: JobRetryStatus) => () => Promise<void>;
   cleanAllDelayed: (queueName: string) => () => Promise<void>;
   cleanAllFailed: (queueName: string) => () => Promise<void>;
   cleanAllCompleted: (queueName: string) => () => Promise<void>;