Class Activity

Base class for every node in the workflow DAG.

An activity's lifecycle flows top-to-bottom through this file: enter → load state → map data → persist → transition → complete.

Each section delegates to a purpose-specific module inside activity/. Open the module when you need implementation detail; read this file when you need the big picture.

Hierarchy (view full)

Activity

Index

Constructors

constructor

new Activity(config, data, metadata, hook, engine, context?): Activity
Parameters
- config: ActivityType
- data: ActivityData
- metadata: ActivityMetadata
- hook: ActivityData
- engine: EngineService
- Optionalcontext: JobState
Returns Activity
- Defined in services/activities/activity/index.ts:86

Properties

adjacencyList

adjacencyList: StreamData[]

adjacentIndex

adjacentIndex: number = 0

code

code: number = 200

config

config: ActivityType

context

context: JobState

data

data: ActivityData

engine

engine: EngineService

guidLedger

guidLedger: number = 0

hook

hook: ActivityData

leg

leg: ActivityLeg

logger

logger: ILogger

metadata

metadata: ActivityMetadata

status

status: StreamStatus = StreamStatus.SUCCESS

Methods

assertGenerationalId

assertGenerationalId(jobGID, msgGID?): void
Reject stale messages from a prior job generation
Parameters
- jobGID: string
- OptionalmsgGID: string
Returns void
- Defined in services/activities/activity/index.ts:155

authorizeEntry

authorizeEntry(_state): string[]
Parameters
- _state: StringAnyType
Returns string[]
- Defined in services/activities/activity/index.ts:340

bindActivityData

bindActivityData(type): void
Attach inbound data (output or hook) to the activity's context slot
Parameters
- type: "hook" | "output"
Returns void
- Defined in services/activities/activity/index.ts:219

bindActivityError

bindActivityError(data): void
Attach an error response to the activity's context slot
Parameters
- data: Record<string, unknown>
Returns void
- Defined in services/activities/activity/index.ts:224

bindActivityMetadata

bindActivityMetadata(): void
Stamp activity-level timestamps, type, and subtype

Returns void
- Defined in services/activities/activity/index.ts:199

bindActivityMetadataPaths

bindActivityMetadataPaths(): string[]
Activity metadata paths to persist (Trigger overrides; leg-aware)

Returns string[]
- Defined in services/activities/activity/index.ts:350

bindActivityState

bindActivityState(state): void
Flatten activity-level context paths into store-ready key/values
Parameters
- state: StringAnyType
Returns void
- Defined in services/activities/activity/index.ts:209

bindDimensionalAddress

bindDimensionalAddress(state): void
Write the dimensional address into the state payload
Parameters
- state: StringAnyType
Returns void
- Defined in services/activities/activity/index.ts:214

bindJobError

bindJobError(data): void
Promote an unhandled activity error to the job level
Parameters
- data: Record<string, unknown>
Returns void
- Defined in services/activities/activity/index.ts:229

bindJobMetadata

bindJobMetadata(): void
Stamp job-level ju (job_updated) timestamp

Returns void
- Defined in services/activities/activity/index.ts:194

bindJobMetadataPaths

bindJobMetadataPaths(): string[]
Job metadata paths to persist (Trigger overrides with full JOB set)

Returns string[]
- Defined in services/activities/activity/index.ts:345

bindJobState

bindJobState(state): Promise<void>
Flatten job-level context paths into store-ready key/values
Parameters
- state: StringAnyType
Returns Promise<void>
- Defined in services/activities/activity/index.ts:204

bindMarkerData

bindMarkerData(_options?): void
Parameters
- Optional_options: any
Returns void
- Defined in services/activities/activity/index.ts:342

bindSearchData

bindSearchData(_options?): void
Parameters
- Optional_options: any
Returns void
- Defined in services/activities/activity/index.ts:341

executeLeg1StepProtocol

executeLeg1StepProtocol(delta): Promise<boolean>
Leg 1 protocol: save → spawn → complete (Category B activities)
Parameters
- delta: number
Returns Promise<boolean>
- Defined in services/activities/activity/index.ts:314

executeStepProtocol

executeStepProtocol(delta, shouldFinalize): Promise<boolean>
Leg 2 protocol: save → spawn → complete (duplex activities)
Parameters
- delta: number
- shouldFinalize: boolean
Returns Promise<boolean>
- Defined in services/activities/activity/index.ts:309

filterAdjacent

filterAdjacent(): Promise<StreamData[]>
Build the list of child activities to transition to

Returns Promise<StreamData[]>
- Defined in services/activities/activity/index.ts:258

getJobStatus

getJobStatus(): number
Returns number
- Defined in services/activities/activity/index.ts:339

getState

getState(): Promise<void>
Load job state from the store into this.context

Returns Promise<void>
- Defined in services/activities/activity/index.ts:135

getTriggerConfig

getTriggerConfig(): Promise<ActivityType>
Returns Promise<ActivityType>
- Defined in services/activities/activity/index.ts:354

handleProcessError

handleProcessError(error, telemetry, label): void
Parameters
- error: Error
- telemetry: TelemetryService
- label: string
Returns void
- Defined in services/activities/activity/index.ts:367

initDimensionalAddress

initDimensionalAddress(dad): void
Set the dimensional address for this activity
Parameters
- dad: string
Returns void
- Defined in services/activities/activity/index.ts:150

initPolicies

initPolicies(ctx): void
Resolve expire and persistent policies from config
Parameters
- ctx: JobState
Returns void
- Defined in services/activities/activity/index.ts:145

initSelf

initSelf(ctx): JobState
Bootstrap $self, $job refs and output.metadata.au timestamp
Parameters
- ctx: StringAnyType
Returns JobState
- Defined in services/activities/activity/index.ts:140

isJobComplete

isJobComplete(s): boolean
Parameters
- s: number
Returns boolean
- Defined in services/activities/activity/index.ts:292

jobWasInterrupted

jobWasInterrupted(s): boolean
Parameters
- s: number
Returns boolean
- Defined in services/activities/activity/index.ts:296

mapInputData

mapInputData(): void
Map data INTO this activity (from other activities' outputs)

Returns void
- Defined in services/activities/activity/index.ts:167

mapJobData

mapJobData(): void
Promote activity data to the shared job state via job.maps

Returns void
- Defined in services/activities/activity/index.ts:177

mapOutputData

mapOutputData(): void
Transform this activity's own output via output.maps

Returns void
- Defined in services/activities/activity/index.ts:172

mapStatusThreshold

mapStatusThreshold(): number
Resolve the Dynamic Activation Control threshold (default: 0)

Returns number
- Defined in services/activities/activity/index.ts:182

processEvent

processEvent(status?, code?, type?): Promise<void>
Parameters
- status: StreamStatus = StreamStatus.SUCCESS
- code: number = 200
- type: "hook" | "output" = 'output'
Returns Promise<void>
- Defined in services/activities/activity/index.ts:325

registerTimeout

registerTimeout(): Promise<void>
Returns Promise<void>
- Defined in services/activities/activity/index.ts:338

resolveAdjacentDad

resolveAdjacentDad(): string
Dimensional address for children (appends seed ,0)

Returns string
- Defined in services/activities/activity/index.ts:268

resolveDad

resolveDad(): string
Current dimensional address (accounts for cycle offset)

Returns string
- Defined in services/activities/activity/index.ts:263

resolveStatus

resolveStatus(multi): number
Extract the job status from the last transaction result
Parameters
- multi: TransactionResultList
Returns number
- Defined in services/activities/activity/index.ts:278

resolveThresholdHit

resolveThresholdHit(results): boolean
Did the semaphore reach its threshold? (from transaction results)
Parameters
- results: TransactionResultList
Returns boolean
- Defined in services/activities/activity/index.ts:273

setLeg

setLeg(leg): void
Parameters
- leg: ActivityLeg
Returns void
- Defined in services/activities/activity/index.ts:337

setState

setState(txn?): Promise<string>
Persist the full activity + job state in a single store call
Parameters
- Optionaltxn: ProviderTransaction
Returns Promise<string>
- Defined in services/activities/activity/index.ts:241

setStatus

setStatus(amount, txn?): Promise<any>
Increment/decrement the job semaphore
Parameters
- amount: number
- Optionaltxn: ProviderTransaction
Returns Promise<any>
- Defined in services/activities/activity/index.ts:246

shouldEmit

shouldEmit(): boolean
Should this activity emit to the graph's publishes topic?

Returns boolean
- Defined in services/activities/activity/index.ts:283

shouldPersistJob

shouldPersistJob(): boolean
Should this activity emit completion while keeping the job alive?

Returns boolean
- Defined in services/activities/activity/index.ts:288

verifyEntry

verifyEntry(): Promise<void>
Leg 1 entry for duplex activities (Worker, Await, Cycle)

Returns Promise<void>
- Defined in services/activities/activity/index.ts:112

verifyLeg1Entry

verifyLeg1Entry(): Promise<boolean>
Leg 1 entry for Category B (Hook passthrough, Signal, Interrupt-target). Returns true when resuming from a prior crash (Leg1 already committed).

Returns Promise<boolean>
- Defined in services/activities/activity/index.ts:123

verifyReentry

verifyReentry(): Promise<number>
Leg 2 re-entry for duplex activities; returns the activity ledger

Returns Promise<number>
- Defined in services/activities/activity/index.ts:117