@prefecthq/prefect-ui-library/src/models/workspaceEvent.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 { capitalize } from 'vue'
import { formatDate, formatDateTimeNumeric, formatTimeNumeric } from '@/utilities/dates'
import { removePrefectEventLabelPrefix } from '@/utilities/events'
import { createTuple } from '@/utilities/tuples'

/*
 * This are a list of known resource id prefixes. A resource id is something like `prefect.flow-run.24a73358-f660-462a-9d19-10ae5037415f`
 * We use these as a means to identify specific resources and and create specific ui experiences based on them.
 *
 * Note: Currently we're conflating resource ids and roles. Not everything in this list is even a valid resource id from a prefect perspective.
 * Technically anything is a valid id (users can create their own), but for example `prefect.creator` is never used as a resource id internally.
 * However "creator" is a valid resource role. So you might see this as a related resource on an event
 *
 * {
 *    "prefect.resource.id": "prefect.deployment.8afa5630-d5ee-4d7b-b0db-558fd1aedb22",
 *    "prefect.resource.role": "creator",
 *    "prefect.resource.name": "10611b"
 *  }
 *
 * Notice that the role is "creator". But since we're inferring our list of known roles from this list of known resource id prefixes
 * you'll see `prefect.creator` in this list. Even though that is not a valid resource id prefix. This will hopefully be fixed as a follow up
 * to opens sourcing events in the ui. But priorities may dictate that this wont change for a while.
 */
export const { values: prefectEventPrefixes } = createTuple([
  'prefect.block-document',
  'prefect.deployment',
  'prefect.flow-run',
  'prefect.flow',
  'prefect.task-run',
  'prefect.work-queue',
  'prefect.work-pool',
  'prefect.tag',
  'prefect.concurrency-limit',
  'prefect.artifact-collection',
  'prefect.automation',
  'prefect.creator',

  // cloud only but here for simplicity
  'prefect-cloud.actor',
  'prefect-cloud.automation',
  'prefect-cloud.workspace',
  'prefect-cloud.webhook',
])
export type PrefectEventPrefixes = typeof prefectEventPrefixes[number]

export const prefectResourceRoles = prefectEventPrefixes.map(prefix => prefix.split('.').at(-1)!)
export type PrefectResourceRole = PrefectEventPrefixes extends `${string}.${infer T}` ? T : never

export function isPrefectResourceRole(value: unknown): value is PrefectResourceRole {
  return prefectResourceRoles.includes(value as PrefectResourceRole)
}

export type WorkspaceEventResource = {
  'prefect.resource.id': string,
  'prefect.resource.role'?: string,
  'prefect.resource.name'?: string,
  'prefect.name'?: string,
  'prefect-cloud.name'?: string,
} & Record<string, string | undefined>

export type WorkspaceEventRelatedResource = WorkspaceEventResource & {
  'prefect.resource.role': string,
}

export type IWorkspaceEvent = {
  id: string,
  account: string,
  event: string,
  occurred: Date,
  payload: unknown,
  received: Date,
  related: WorkspaceEventRelatedResource[],
  resource: WorkspaceEventResource,
  workspace: string | null,
}

export class WorkspaceEvent implements IWorkspaceEvent {
  public id: string
  public account: string
  public event: string
  public occurred: Date
  public payload: unknown
  public received: Date
  public related: WorkspaceEventRelatedResource[]
  public resource: WorkspaceEventResource
  public workspace: string | null

  public constructor(event: IWorkspaceEvent) {
    this.id = event.id
    this.account = event.account
    this.event = event.event
    this.occurred = event.occurred
    this.payload = event.payload
    this.received = event.received
    this.related = event.related
    this.resource = event.resource
    this.workspace = event.workspace
  }

  public getRelatedByRole(role: PrefectResourceRole): WorkspaceEventRelatedResource | null {
    return this.related.find(value => value['prefect.resource.role'] === role) ?? null
  }

  public get email(): string {
    const actor = this.getRelatedByRole('actor')

    return actor?.['prefect-cloud.email'] ?? ''
  }

  public get actorName(): string | null {
    const actor = this.getRelatedByRole('actor')

    return actor?.['prefect-cloud.name'] ?? null
  }

  public get workspaceHandle(): string {
    const workspace = this.getRelatedByRole('workspace')

    return workspace?.['prefect-cloud.handle'] ?? ''
  }

  public get occurredFormatted(): string {
    return formatDateTimeNumeric(this.occurred)
  }

  public get eventPrefectWithoutPrefix(): string {
    return removePrefectEventLabelPrefix(this.event)
  }

  public get eventLabel(): string {
    const label = this.eventPrefectWithoutPrefix.replaceAll(/[_.-]/g, ' ')

    return capitalize(label.toLocaleLowerCase())
  }

  public get occurredDate(): string {
    return formatDate(this.occurred)
  }

  public get occurredTime(): string {
    return formatTimeNumeric(this.occurred)
  }

  public get resourceId(): string {
    return this.resource['prefect.resource.id']
  }
}

export function isWorkspaceEvent(value: unknown): value is WorkspaceEvent {
  return value instanceof WorkspaceEvent
}