Circle V2 API Docs
    Preparing search index...

    Execute one queued run. Lives in @repo/services to avoid a @repo/jobs <-> @repo/services cycle. The run is claimed with one conditional UPDATE before any work, so a redelivery loses the race without spending a token.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    config: JobConfig = ...

    One attempt: the executor marks the run failed on any error, so a redelivery finds a run claimRun refuses.

    serviceName: "RunFormFillJobbable"

    Stable, human-readable name for the service. Must be set explicitly on each subclass because this.constructor.name gets mangled by minification in production builds, which breaks tracing/observability span names.

    Accessors

    • get logger(): BaseLogger

      Returns BaseLogger

    • get name(): string

      Returns string

    Methods

    • Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns string

    • Derive the queue retentionSeconds from the effective dedup TTL. The queue overloads retentionSeconds — it's BOTH the message lifetime AND the idempotency dedup window (min(retentionSeconds, 24h)). So:

      • take the intended dedup window (ttlHours·3600), capped at 24h (the window can't exceed it);
      • but never go below the message's worst-case time-to-complete (delaySeconds + every retry), else a short TTL would expire the message mid-retry — and the queue hard-rejects delaySeconds > retentionSeconds. ttlHours <= 0 means "no dedup" → undefined: the idempotency key is dropped (see performLater), so there's no dedup window to bound — this just leaves the queue's default message lifetime in place.

      Parameters

      • ttlHours: number
      • delaySeconds: number

      Returns number | undefined

    • Extract an entityId from params for job_executions tracking. Override in subclasses when applicable.

      Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns EntityId

    • One fill per run; a re-run is a NEW run row with a new id, so this dedupes double submissions only.

      Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns string

    • The identity routing is evaluated against. Without one only the flag's fallthrough reaches a job, so override wherever params can name the user or entity.

      Parameters

      • _params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns Promise<FlagContext | undefined>

    • Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns Promise<Safe<void>>

    • Enqueue this job for async processing via the configured queue driver (VQS_DRIVER). Checks for deduplication via job_executions before sending.

      Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId
      • Optionaloptions: PerformLaterOptions

      Returns Promise<EnqueueResult>

    • Parameters

      • params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns Promise<void>

    • Run the job with status tracking. Used by the queue handler. Errors propagate (not caught by safe()) so the RetryHandler can decide.

      parentSpanContext (the enqueuer's span, recovered from the queue envelope) is attached as a span LINK and the run span is started as a new trace root, so each job runs in its own trace rather than collapsing a fan-out into one unbounded trace.

      Parameters

      • ...args: [
            params: {
                chosenContacts?: Record<string, string>;
                entityId: EntityId;
                includeEmr?: boolean;
                runId: FormRunId;
                selectedDocumentIds?: PatientChartId[];
                selectedSessionIds?: SessionId[];
                treatmentEpisodeId?: TreatmentEpisodeId;
            },
            metadata: MessageMetadata,
            parentSpanContext?: SpanContext,
        ]

      Returns Promise<void>

    • Optional hook for subclasses to attach extra non-PII span attributes derived from params. The returned attributes appear on the service.${serviceName} span (and, for jobs, on job.enqueue.* and job.run.* spans too).

      Safe ID-like keys on params (e.g. patientId, templateIds, limit, cursor) are already auto-extracted via toSpanAttributes("service.input", params) — you don't need to enumerate them here. Use this hook for derived/computed attributes (counts, flags, computed names) or for fields you've explicitly verified safe but that aren't in the global allowlist. Hook output overrides auto-extracted attributes on key collision.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII. Never include emails, names, dob, free-text, etc.

      Parameters

      • _params: {
            chosenContacts?: Record<string, string>;
            entityId: EntityId;
            includeEmr?: boolean;
            runId: FormRunId;
            selectedDocumentIds?: PatientChartId[];
            selectedSessionIds?: SessionId[];
            treatmentEpisodeId?: TreatmentEpisodeId;
        }
        • OptionalchosenContacts?: Record<string, string>

          Already authorized by startFormFillRun; carried through the queue because form_runs has no column for it.

        • entityId: EntityId

          Tracking only — the fill resolves its org from the run's frozen snapshot.

        • OptionalincludeEmr?: boolean
        • runId: FormRunId
        • OptionalselectedDocumentIds?: PatientChartId[]
        • OptionalselectedSessionIds?: SessionId[]
        • OptionaltreatmentEpisodeId?: TreatmentEpisodeId

      Returns Attributes

    • Optional hook for subclasses to attach extra non-PII span attributes derived from the successful service result. Only called when run resolves successfully; on error, the span is marked via markSpanError instead.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII (e.g. counts, status flags, computed summaries). Never include emails, names, dob, free-text, etc.

      Parameters

      • _result: void

      Returns Attributes

    • Parameters

      • params: unknown

      Returns params is {
          chosenContacts?: Record<string, string>;
          entityId: EntityId;
          includeEmr?: boolean;
          runId: FormRunId;
          selectedDocumentIds?: PatientChartId[];
          selectedSessionIds?: SessionId[];
          treatmentEpisodeId?: TreatmentEpisodeId;
      }