@prefecthq/prefect-ui-library/src/models/FlowRun.ts

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

import { CreatedOrUpdatedBy } from '@/models/CreatedOrUpdatedBy'
import { EmpiricalPolicy } from '@/models/EmpiricalPolicy'
import { State } from '@/models/State'
import { StateType } from '@/models/StateType'
import { StorageItem } from '@/services/storage/StorageItem'
import { PrefectStateNames } from '@/types'
import { SchemaValues } from '@/types/schemas'
import { secondsToApproximateString } from '@/utilities/seconds'

export interface IFlowRun {
  id: string,
  flowId: string,
  flowName: string | null,
  deploymentId: string | null,
  deploymentVersionId: string | null,
  flowVersion: string | null,
  idempotencyKey: string | null,
  expectedStartTime: Date | null,
  nextScheduledStartTime: Date | null,
  parameters: SchemaValues,
  autoScheduled: boolean | null,
  context: unknown,
  empiricalConfig: unknown,
  empiricalPolicy: EmpiricalPolicy | null,
  estimatedRunTime: number,
  estimatedStartTimeDelta: number | null,
  totalRunTime: number,
  startTime: Date | null,
  endTime: Date | null,
  name: string | null,
  parentTaskRunId: string | null,
  stateId: string | null,
  stateName: PrefectStateNames | null,
  stateType: StateType | null,
  state: State | null,
  tags: string[] | null,
  runCount: number | null,
  created: Date,
  createdBy: CreatedOrUpdatedBy | null,
  updated: Date,
  workQueueName: string | null,
  workPoolName: string | null,
  workPoolQueueName: string | null,
  jobVariables: Record<string, unknown>,
}

export class FlowRun extends StorageItem implements IFlowRun {
  public readonly id: string
  public readonly flowId: string
  public readonly flowName: string | null
  public readonly deploymentId: string | null
  public readonly deploymentVersionId: string | null
  public readonly workQueueName: string | null
  public readonly kind = 'flowRun'
  public flowVersion: string | null
  public idempotencyKey: string | null
  public expectedStartTime: Date | null
  public nextScheduledStartTime: Date | null
  public parameters: SchemaValues
  public autoScheduled: boolean | null
  public context: unknown
  public empiricalConfig: unknown
  public empiricalPolicy: EmpiricalPolicy | null
  public estimatedRunTime: number
  public estimatedStartTimeDelta: number | null
  public totalRunTime: number
  public startTime: Date | null
  public endTime: Date | null
  public name: string | null
  public parentTaskRunId: string | null
  public stateId: string | null
  public stateName: PrefectStateNames | null
  public stateType: StateType | null
  public state: State | null
  public tags: string[] | null
  public runCount: number | null
  public created: Date
  public createdBy: CreatedOrUpdatedBy | null
  public updated: Date
  public workPoolName: string | null
  public workPoolQueueName: string | null
  public jobVariables: Record<string, unknown>

  public constructor(flowRun: IFlowRun) {
    super()

    this.id = flowRun.id
    this.deploymentId = flowRun.deploymentId
    this.flowId = flowRun.flowId
    this.deploymentVersionId = flowRun.deploymentVersionId
    this.flowName = flowRun.flowName
    this.flowVersion = flowRun.flowVersion
    this.idempotencyKey = flowRun.idempotencyKey
    this.expectedStartTime = flowRun.expectedStartTime
    this.nextScheduledStartTime = flowRun.nextScheduledStartTime
    this.parameters = flowRun.parameters
    this.autoScheduled = flowRun.autoScheduled
    this.context = flowRun.context
    this.empiricalConfig = flowRun.empiricalConfig
    this.empiricalPolicy = flowRun.empiricalPolicy
    this.estimatedRunTime = flowRun.estimatedRunTime
    this.estimatedStartTimeDelta = flowRun.estimatedStartTimeDelta
    this.totalRunTime = flowRun.totalRunTime
    this.startTime = flowRun.startTime
    this.endTime = flowRun.endTime
    this.name = flowRun.name
    this.parentTaskRunId = flowRun.parentTaskRunId
    this.stateId = flowRun.stateId
    this.stateName = flowRun.stateName
    this.stateType = flowRun.stateType
    this.state = flowRun.state
    this.tags = flowRun.tags
    this.runCount = flowRun.runCount
    this.created = flowRun.created
    this.createdBy = flowRun.createdBy
    this.updated = flowRun.updated
    this.workQueueName = flowRun.workQueueName
    this.workPoolName = flowRun.workPoolName
    this.workPoolQueueName = flowRun.workPoolQueueName
    this.jobVariables = flowRun.jobVariables
  }

  public get duration(): number {
    return this.estimatedRunTime || this.totalRunTime
  }

  public isScheduled(): this is FlowRun & { expectedStartTime: Date } {
    return this.stateType === 'scheduled'
  }

  public get delta(): string | null {
    if (!this.estimatedStartTimeDelta || this.estimatedStartTimeDelta <= 60) {
      return null
    }

    return `(${secondsToApproximateString(this.estimatedStartTimeDelta)} late)`
  }
}