single job page view (#598)

* initial attempt: add JobPage * add fetch job state to jobHandler * clean up JobPage * fix type mismatch * fix type mismatch * pr review changes --------- Co-authored-by: Felix Mosheev <[email protected]>
felixmosh · Aug 8, 2023 · 91994c5 · 91994c5
1 parent 626d078
commit 91994c5
Show file tree

Hide file tree

Showing 12 changed files with 160 additions and 21 deletions.
diff --git a/packages/api/src/handlers/job.ts b/packages/api/src/handlers/job.ts
@@ -0,0 +1,22 @@
+import { BullBoardRequest, ControllerHandlerReturnType, QueueJob } from '../../typings/app';
+import { queueProvider } from '../providers/queue';
+import { jobProvider } from '../providers/job';
+
+async function getJobState(
+  _req: BullBoardRequest,
+  job: QueueJob
+): Promise<ControllerHandlerReturnType> {
+  const state = await job.getState();
+
+  return {
+    status: 200,
+    body: {
+      job,
+      state,
+    },
+  };
+}
+
+export const jobHandler = queueProvider(jobProvider(getJobState), {
+  skipReadOnlyModeCheck: true,
+});
diff --git a/packages/api/src/providers/job.ts b/packages/api/src/providers/job.ts
@@ -1,15 +1,8 @@
-import {
-  BullBoardRequest,
-  ControllerHandlerReturnType,
-  QueueJob,
-} from '../../typings/app';
+import { BullBoardRequest, ControllerHandlerReturnType, QueueJob } from '../../typings/app';
 import { BaseAdapter } from '../queueAdapters/base';
 
 export function jobProvider(
-  next: (
-    req: BullBoardRequest,
-    job: QueueJob
-  ) => Promise<ControllerHandlerReturnType>
+  next: (req: BullBoardRequest, job: QueueJob) => Promise<ControllerHandlerReturnType>
 ) {
   return async (
     req: BullBoardRequest,

diff --git a/packages/api/src/routes.ts b/packages/api/src/routes.ts
@@ -4,19 +4,20 @@ import { cleanJobHandler } from './handlers/cleanJob';
 import { emptyQueueHandler } from './handlers/emptyQueue';
 import { entryPoint } from './handlers/entryPoint';
 import { jobLogsHandler } from './handlers/jobLogs';
+import { jobHandler } from './handlers/job';
 import { pauseQueueHandler } from './handlers/pauseQueue';
 import { promoteJobHandler } from './handlers/promotJob';
 import { queuesHandler } from './handlers/queues';
 import { redisStatsHandler } from './handlers/redisStats';
 import { resumeQueueHandler } from './handlers/resumeQueue';
 import { retryAllHandler } from './handlers/retryAll';
 import { retryJobHandler } from './handlers/retryJob';
-import { promoteAllHandler } from "./handlers/promoteAll";
+import { promoteAllHandler } from './handlers/promoteAll';
 
 export const appRoutes: AppRouteDefs = {
   entryPoint: {
     method: 'get',
-    route: ['/', '/queue/:queueName'],
+    route: ['/', '/queue/:queueName', '/queue/:queueName/:jobId'],
     handler: entryPoint,
   },
   api: [
@@ -27,6 +28,11 @@ export const appRoutes: AppRouteDefs = {
       route: '/api/queues/:queueName/:jobId/logs',
       handler: jobLogsHandler,
     },
+    {
+      method: 'get',
+      route: '/api/queues/:queueName/:jobId',
+      handler: jobHandler,
+    },
     {
       method: 'put',
       route: '/api/queues/:queueName/retry/:queueStatus',

diff --git a/packages/api/typings/app.ts b/packages/api/typings/app.ts
@@ -33,6 +33,8 @@ export interface QueueJob {
   retry(state?: JobRetryStatus): Promise<void>;
 
   toJSON(): QueueJobJson;
+
+  getState(): Promise<Status | 'stuck' | 'waiting-children' | 'unknown'>;
 }
 
 export interface QueueJobJson {

diff --git a/packages/ui/src/App.tsx b/packages/ui/src/App.tsx
@@ -11,6 +11,10 @@ import { useActiveQueue } from './hooks/useActiveQueue';
 import { useScrollTopOnNav } from './hooks/useScrollTopOnNav';
 import { useStore } from './hooks/useStore';
 
+const JobPageLazy = React.lazy(() =>
+  import('./pages/JobPage/JobPage').then(({ JobPage }) => ({ default: JobPage }))
+);
+
 const QueuePageLazy = React.lazy(() =>
   import('./pages/QueuePage/QueuePage').then(({ QueuePage }) => ({ default: QueuePage }))
 );
@@ -40,6 +44,16 @@ export const App = () => {
             <>
               <Suspense fallback={<Loader />}>
                 <Switch>
+                  <Route
+                    path="/queue/:name/:jobId"
+                    render={() => (
+                      <JobPageLazy
+                        queue={activeQueue || null}
+                        actions={actions}
+                        selectedStatus={selectedStatuses}
+                      />
+                    )}
+                  />
                   <Route
                     path="/queue/:name"
                     render={() => (

diff --git a/packages/ui/src/components/JobCard/JobCard.tsx b/packages/ui/src/components/JobCard/JobCard.tsx
@@ -1,4 +1,5 @@
 import React from 'react';
+import { NavLink } from 'react-router-dom';
 import { Card } from '../Card/Card';
 import { Details } from './Details/Details';
 import { JobActions } from './JobActions/JobActions';
@@ -10,6 +11,7 @@ import { STATUSES } from '@bull-board/api/dist/src/constants/statuses';
 
 interface JobCardProps {
   job: AppJob;
+  jobUrlPath?: string;
   status: Status;
   readOnlyMode: boolean;
   allowRetries: boolean;
@@ -23,10 +25,23 @@ interface JobCardProps {
 
 const greenStatuses = [STATUSES.active, STATUSES.completed];
 
-export const JobCard = ({ job, status, actions, readOnlyMode, allowRetries }: JobCardProps) => (
+export const JobCard = ({
+  job,
+  status,
+  actions,
+  readOnlyMode,
+  allowRetries,
+  jobUrlPath,
+}: JobCardProps) => (
   <Card className={s.card}>
     <div className={s.sideInfo}>
-      <span title={`#${job.id}`}>#{job.id}</span>
+      {jobUrlPath ? (
+        <NavLink to={jobUrlPath}>
+          <span title={`#${job.id}`}>#{job.id}</span>
+        </NavLink>
+      ) : (
+        <span title={`#${job.id}`}>#{job.id}</span>
+      )}
       <Timeline job={job} status={status} />
     </div>
     <div className={s.contentWrapper}>

diff --git a/packages/ui/src/hooks/useActiveQueueName.ts b/packages/ui/src/hooks/useActiveQueueName.ts
@@ -4,10 +4,10 @@ import { useLocation } from 'react-router-dom';
 export function useActiveQueueName(): string {
   const { pathname } = useLocation();
 
-  const match = matchPath<{ name: string }>(pathname, {
-    path: '/queue/:name',
-    exact: true,
-    strict: true,
+  const match = matchPath<{ name: string; jobId: string }>(pathname, {
+    path: ['/queue/:name', '/queue/:name/:jobId'],
+    exact: false,
+    strict: false,
   });
 
   return decodeURIComponent(match?.params.name || '');

diff --git a/packages/ui/src/hooks/useStore.ts b/packages/ui/src/hooks/useStore.ts
@@ -9,7 +9,7 @@ import { useInterval } from './useInterval';
 import { useQuery } from './useQuery';
 import { useSelectedStatuses } from './useSelectedStatuses';
 import { useSettingsStore } from './useSettings';
-import { STATUSES } from "@bull-board/api/dist/src/constants/statuses";
+import { STATUSES } from '@bull-board/api/dist/src/constants/statuses';
 
 type State = {
   data: null | GetQueuesResponse;
@@ -148,6 +148,8 @@ export const useStore = (): Store => {
   const getJobLogs = (queueName: string) => (job: AppJob) => () =>
     api.getJobLogs(queueName, job.id);
 
+  const getJob = (queueName: string) => (jobId: string) => () => api.getJob(queueName, jobId);
+
   return {
     state,
     actions: {
@@ -158,6 +160,7 @@ export const useStore = (): Store => {
       cleanJob,
       cleanAll,
       getJobLogs,
+      getJob,
       pauseQueue,
       resumeQueue,
       emptyQueue,

diff --git a/packages/ui/src/pages/JobPage/JobPage.tsx b/packages/ui/src/pages/JobPage/JobPage.tsx
@@ -0,0 +1,73 @@
+import { useParams, useHistory, useLocation, Link } from 'react-router-dom';
+import { AppJob, AppQueue, JobRetryStatus, Status } from '@bull-board/api/typings/app';
+import React, { useState } from 'react';
+import { Store } from '../../hooks/useStore';
+import s from '../QueuePage/QueuePage.module.css';
+import { JobCard } from '../../components/JobCard/JobCard';
+import { ArrowLeftIcon } from '../../components/Icons/ArrowLeft';
+import { useInterval } from '../../hooks/useInterval';
+
+export const JobPage = ({
+  actions,
+  queue,
+  selectedStatus,
+}: {
+  queue: AppQueue | null;
+  actions: Store['actions'];
+  selectedStatus: Store['selectedStatuses'];
+}) => {
+  const { search } = useLocation();
+  const history = useHistory();
+  const { name, jobId } = useParams<any>();
+  const [job, setJob] = useState<AppJob>();
+  const [status, setStatus] = useState<Status>(selectedStatus[queue?.name || '']);
+
+  useInterval(() => {
+    fetchJob();
+  }, 5000);
+
+  const fetchJob = async () => {
+    const { job, state } = await actions.getJob(name)(jobId)();
+    setJob(job);
+    setStatus(state);
+  };
+
+  if (!queue) {
+    return <section>Queue Not found</section>;
+  }
+
+  if (!job) {
+    return <section>Job Not found</section>;
+  }
+
+  const cleanJob = async () => {
+    await actions.cleanJob(queue?.name)(job)();
+    history.push(`/queue/${queue.name}`);
+  };
+
+  return (
+    <section>
+      <div className={s.stickyHeader}>
+        <div className={s.actionContainer}>
+          <Link to={`/queue/${queue.name}${search}`}>
+            <ArrowLeftIcon />
+          </Link>
+          <div>Status: {status.toLocaleUpperCase()}</div>
+        </div>
+      </div>
+      <JobCard
+        key={job.id}
+        job={job}
+        status={status}
+        actions={{
+          cleanJob,
+          promoteJob: actions.promoteJob(queue?.name)(job),
+          retryJob: actions.retryJob(queue?.name, status as JobRetryStatus)(job),
+          getJobLogs: actions.getJobLogs(queue?.name)(job),
+        }}
+        readOnlyMode={queue?.readOnlyMode}
+        allowRetries={(job.isFailed || queue.allowCompletedRetries) && queue?.allowRetries}
+      />
+    </section>
+  );
+};
diff --git a/packages/ui/src/pages/QueuePage/QueuePage.tsx b/packages/ui/src/pages/QueuePage/QueuePage.tsx
@@ -1,5 +1,6 @@
 import { AppQueue, JobRetryStatus } from '@bull-board/api/typings/app';
 import React from 'react';
+import { useLocation } from 'react-router-dom';
 import { JobCard } from '../../components/JobCard/JobCard';
 import { Pagination } from '../../components/Pagination/Pagination';
 import { QueueActions } from '../../components/QueueActions/QueueActions';
@@ -16,6 +17,8 @@ export const QueuePage = ({
   actions: Store['actions'];
   selectedStatus: Store['selectedStatuses'];
 }) => {
+  const { search } = useLocation();
+
   if (!queue) {
     return <section>Queue Not found</section>;
   }
@@ -47,6 +50,9 @@ export const QueuePage = ({
         <JobCard
           key={job.id}
           job={job}
+          jobUrlPath={`/queue/${encodeURIComponent(queue.name)}/${encodeURIComponent(
+            job.id ?? ''
+          )}${search}`}
           status={status}
           actions={{
             cleanJob: actions.cleanJob(queue?.name)(job),

diff --git a/packages/ui/src/services/Api.ts b/packages/ui/src/services/Api.ts
@@ -38,9 +38,7 @@ export class Api {
   }
 
   public promoteAll(queueName: string): Promise<void> {
-    return this.axios.put(
-      `/queues/${encodeURIComponent(queueName)}/promote`
-    );
+    return this.axios.put(`/queues/${encodeURIComponent(queueName)}/promote`);
   }
 
   public cleanAll(queueName: string, status: JobCleanStatus): Promise<void> {
@@ -75,6 +73,12 @@ export class Api {
     );
   }
 
+  public getJob(queueName: string, jobId: AppJob['id']): Promise<any> {
+    return this.axios.get(
+      `/queues/${encodeURIComponent(queueName)}/${encodeURIComponent(`${jobId}`)}`
+    );
+  }
+
   public pauseQueue(queueName: string) {
     return this.axios.put(`/queues/${encodeURIComponent(queueName)}/pause`);
   }

diff --git a/packages/ui/typings/app.d.ts b/packages/ui/typings/app.d.ts
@@ -15,6 +15,7 @@ export interface QueueActions {
   retryJob: (queueName: string, status: JobRetryStatus) => (job: AppJob) => () => Promise<void>;
   cleanJob: (queueName: string) => (job: AppJob) => () => Promise<void>;
   getJobLogs: (queueName: string) => (job: AppJob) => () => Promise<string[]>;
+  getJob: (queueName: string) => (jobId: string) => () => Promise<any>;
   retryAll: (queueName: string, status: JobRetryStatus) => () => Promise<void>;
   promoteAll: (queueName: string) => () => Promise<void>;
   cleanAll: (queueName: string, status: JobCleanStatus) => () => Promise<void>;