app.ts

import { Job, JobOptions } from 'bull'
import { Job as JobMq, JobsOptions } from 'bullmq'
import * as Redis from 'ioredis'
import React from 'react'
import { Status } from '../ui/components/constants'

export type JobCleanStatus =
  | 'completed'
  | 'wait'
  | 'active'
  | 'delayed'
  | 'failed'

export type JobStatus = Status

export type JobCounts = Record<JobStatus, number>

export interface QueueAdapter {
  readonly readOnlyMode: boolean

  getClient(): Promise<Redis.Redis>

  getName(): string

  getJob(id: string): Promise<Job | JobMq | undefined | null>

  getJobs(
    jobStatuses: JobStatus[],
    start?: number,
    end?: number,
  ): Promise<(Job | JobMq)[]>

  getJobCounts(...jobStatuses: JobStatus[]): Promise<JobCounts>

  clean(queueStatus: JobCleanStatus, graceTimeMs: number): Promise<any>

  setFormatter(
    field: 'data' | 'returnValue',
    formatter: (data: any) => any,
  ): void

  format(field: 'data' | 'returnValue', data: any): any
}

export interface QueueAdapterOptions {
  readOnlyMode: boolean
}

export interface BullBoardQueue {
  queue: QueueAdapter
}

export interface BullBoardQueues {
  [key: string]: BullBoardQueue
}

export interface ValidMetrics {
  total_system_memory: string
  redis_version: string
  used_memory: string
  mem_fragmentation_ratio: string
  connected_clients: string
  blocked_clients: string
}

export interface AppJob {
  id: string | number | undefined
  timestamp: number | null
  processedOn?: number | null
  finishedOn?: number | null
  progress: JobMq['progress']
  attempts: JobMq['attemptsMade']
  failedReason: JobMq['failedReason']
  stacktrace: string[]
  opts: JobsOptions | JobOptions
  data: JobMq['data']
  name: JobMq['name']
  delay: number | undefined
  returnValue: string | Record<string | number, any> | null
}

export interface AppQueue {
  name: string
  counts: Record<Status, number>
  jobs: AppJob[]
  readOnlyMode: boolean
}

export type SelectedStatuses = Record<AppQueue['name'], Status>

export interface QueueActions {
  promoteJob: (queueName: string) => (job: AppJob) => () => Promise<void>
  retryJob: (queueName: string) => (job: AppJob) => () => Promise<void>
  cleanJob: (queueName: string) => (job: AppJob) => () => Promise<void>
  retryAll: (queueName: string) => () => Promise<void>
  cleanAllDelayed: (queueName: string) => () => Promise<void>
  cleanAllFailed: (queueName: string) => () => Promise<void>
  cleanAllCompleted: (queueName: string) => () => Promise<void>
  setSelectedStatuses: React.Dispatch<React.SetStateAction<SelectedStatuses>>
}