refactor: start using constants instead of strings

felixmosh · Jun 2, 2021 · 15e3082 · 15e3082
1 parent 19160e5
commit 15e3082
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 14 deletions.
diff --git a/packages/api/src/handlers/queues.ts b/packages/api/src/handlers/queues.ts
@@ -12,6 +12,7 @@ import {
   Status,
   ValidMetrics,
 } from '../../typings/app';
+import { STATUSES } from '../constants/statuses';
 
 type MetricName = keyof ValidMetrics;
 
@@ -62,7 +63,14 @@ const formatJob = (job: QueueJob, queue: BaseAdapter): AppJob => {
   };
 };
 
-const allStatuses: JobStatus[] = ['active', 'completed', 'delayed', 'failed', 'paused', 'waiting'];
+const allStatuses: JobStatus[] = [
+  STATUSES.active,
+  STATUSES.completed,
+  STATUSES.delayed,
+  STATUSES.failed,
+  STATUSES.paused,
+  STATUSES.waiting,
+];
 const JOB_PER_PAGE = 10;
 
 function getPagination(statuses: JobStatus[], counts: JobCounts, currentPage: number): Pagination {

diff --git a/packages/api/src/handlers/retryAll.ts b/packages/api/src/handlers/retryAll.ts
@@ -1,15 +1,13 @@
-import {
-  BullBoardRequest,
-  ControllerHandlerReturnType,
-} from '../../typings/app';
+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
 ): Promise<ControllerHandlerReturnType> {
-  const jobs = await queue.getJobs(['failed']);
+  const jobs = await queue.getJobs([STATUSES.failed]);
   await Promise.all(jobs.map((job) => job.retry()));
 
   return { status: 200, body: {} };

diff --git a/packages/ui/src/components/JobCard/Progress/Progress.tsx b/packages/ui/src/components/JobCard/Progress/Progress.tsx
@@ -2,6 +2,7 @@ import React from 'react';
 import s from './Progress.module.css';
 import cn from 'clsx';
 import { Status } from '@bull-board/api/typings/app';
+import { STATUSES } from '@bull-board/api/src/constants/statuses';
 
 export const Progress = ({
   percentage,
@@ -29,7 +30,7 @@ export const Progress = ({
         cy="70"
         r="70"
         fill="none"
-        stroke={status === 'failed' ? '#F56565' : '#48BB78'}
+        stroke={status === STATUSES.failed ? '#F56565' : '#48BB78'}
         strokeWidth="8"
         strokeLinecap="round"
         strokeDasharray="600"

diff --git a/packages/ui/src/components/JobCard/Timeline/Timeline.tsx b/packages/ui/src/components/JobCard/Timeline/Timeline.tsx
@@ -2,6 +2,7 @@ import { format, formatDistance, getYear, isToday } from 'date-fns';
 import React from 'react';
 import s from './Timeline.module.css';
 import { AppJob, Status } from '@bull-board/api/typings/app';
+import { STATUSES } from '@bull-board/api/src/constants/statuses';
 
 type TimeStamp = number | Date;
 
@@ -23,7 +24,7 @@ export const Timeline = function Timeline({ job, status }: { job: AppJob; status
           <small>Added at</small>
           <time>{formatDate(job.timestamp || 0)}</time>
         </li>
-        {!!job.delay && job.delay > 0 && status === 'delayed' && (
+        {!!job.delay && job.delay > 0 && status === STATUSES.delayed && (
           <li>
             <small>Delayed for</small>
             <time>
@@ -52,7 +53,7 @@ export const Timeline = function Timeline({ job, status }: { job: AppJob; status
                 includeSeconds: true,
               })}
             </small>
-            <small>{status === 'failed' ? 'Failed' : 'Finished'} at</small>
+            <small>{status === STATUSES.failed ? 'Failed' : 'Finished'} at</small>
             <time>{formatDate(job.finishedOn)}</time>
           </li>
         )}

diff --git a/packages/ui/src/components/QueueActions/QueueActions.tsx b/packages/ui/src/components/QueueActions/QueueActions.tsx
@@ -5,16 +5,17 @@ import { TrashIcon } from '../Icons/Trash';
 import { Button } from '../JobCard/Button/Button';
 import s from './QueueActions.module.css';
 import { AppQueue, Status } from '@bull-board/api/typings/app';
+import { STATUSES } from '@bull-board/api/src/constants/statuses';
 
 interface QueueActionProps {
   queue: AppQueue;
   actions: Store['actions'];
   status: Status;
 }
 
-const ACTIONABLE_STATUSES = ['failed', 'delayed', 'completed'];
+const ACTIONABLE_STATUSES = [STATUSES.failed, STATUSES.delayed, STATUSES.completed] as const;
 
-const isStatusActionable = (status: Status): boolean => ACTIONABLE_STATUSES.includes(status);
+const isStatusActionable = (status: Status): boolean => ACTIONABLE_STATUSES.includes(status as any);
 
 const CleanAllButton = ({ onClick }: any) => (
   <Button onClick={onClick} className={s.button}>
@@ -30,7 +31,7 @@ export const QueueActions = ({ status, actions, queue }: QueueActionProps) => {
 
   return (
     <ul className={s.queueActions}>
-      {status === 'failed' && (
+      {status === STATUSES.failed && (
         <>
           <li>
             <Button onClick={actions.retryAll(queue.name)} className={s.button}>
@@ -43,12 +44,12 @@ export const QueueActions = ({ status, actions, queue }: QueueActionProps) => {
           </li>
         </>
       )}
-      {status === 'delayed' && (
+      {status === STATUSES.delayed && (
         <li>
           <CleanAllButton onClick={actions.cleanAllDelayed(queue.name)} />
         </li>
       )}
-      {status === 'completed' && (
+      {status === STATUSES.completed && (
         <li>
           <CleanAllButton onClick={actions.cleanAllCompleted(queue.name)} />
         </li>