Class DetSysActionAbstract

constructor

• new DetSysAction(actionOptions: ActionOptions): DetSysAction

  Parameters

  • actionOptions: ActionOptions

  Returns DetSysAction

nixStoreTrust

strictMode

addFact

• addFact(key: string, value: string | boolean): void

  Parameters

  • key: string
  • value: string | boolean

  Returns void

execute

• execute(): void

  Execute the Action as defined.

  Returns void

failOnError

• failOnError(msg: string): void

  A helper function for failing on error only if strict mode is enabled. This is intended only for CI environments testing Actions themselves.

  Parameters

  • msg: string

  Returns void

fetchExecutable

• fetchExecutable(): Promise<string>

  Fetches the executable at the URL determined by the source-* inputs and other facts, chmods it, and returns the path to the executable on disk.

  Returns Promise<string>

getClient

• getClient(): Promise<Got>

  Returns Promise<Got>

getCorrelationHashes

• getCorrelationHashes(): AnonymizedCorrelationHashes

  Returns AnonymizedCorrelationHashes

getCrossPhaseId

• getCrossPhaseId(): string

  Returns string

getDiagnosticsUrl

• getDiagnosticsUrl(): Promise<undefined | URL>

  Returns Promise<undefined | URL>

getFeature

• getFeature(name: string): undefined | Feature

  Parameters

  • name: string

  Returns undefined | Feature

getTemporaryName

• getTemporaryName(): string

  Returns string

getUniqueId

• getUniqueId(): string

  Returns string

Abstractmain

• main(): Promise<void>

  The main execution phase.

  Returns Promise<void>

Abstractpost

• post(): Promise<void>

  The post execution phase.

  Returns Promise<void>

recordEvent

• recordEvent(
      eventName: string,
      context?: Record<string, boolean | string | number | undefined>,
  ): void

  Parameters

  • eventName: string
  • context: Record<string, boolean | string | number | undefined> = {}

  Returns void

stapleFile

• stapleFile(name: string, location: string): void

  Attach a file to the diagnostics data in error conditions.

  The file at location doesn't need to exist when stapleFile is called.

  If the file doesn't exist or is unreadable when trying to staple the attachments, the JS error will be stored in a context value at staple_failure_{name}. If the file is readable, the file's contents will be stored in a context value at staple_value_{name}.

  Parameters

  • name: string
  • location: string

  Returns void

unpackClosure

• unpackClosure(bin: string): Promise<string>

  Unpacks the closure returned by fetchArtifact(), imports the contents into the Nix store, and returns the path of the executable at /nix/store/STORE_PATH/bin/${bin}.

  Parameters

  • bin: string

  Returns Promise<string>