Class DetSysActionAbstract

Constructors

constructor

Properties

actionOptions archOs architectureFetchSuffix events exceptionAttachments executionPhase facts featureEventMetadata features identity idsHost nixStoreTrust nixSystem sourceParameters strictMode

Accessors

isMain isPost

Methods

addFact cacheKey checkIn complete determineExecutionPhase execute executeAsync failOnError fetchArtifact fetchExecutable getCachedVersion getCheckInUrl getClient getCorrelationHashes getDiagnosticsUrl getFeature getSourceUrl getTemporaryName getUniqueId main post preflightNixStoreInfo preflightRequireNix recordEvent requestCheckIn saveCachedVersion stapleFile submitEvents unpackClosure

Constructors

constructor

Properties

Private actionOptions

actionOptions: ConfidentActionOptions

Private archOs

archOs: string

Private architectureFetchSuffix

architectureFetchSuffix: string

Private events

events: DiagnosticEvent[]

Private exceptionAttachments

exceptionAttachments: Map<string, PathLike>

Private executionPhase

executionPhase: ExecutionPhase

Private facts

facts: Record<string, string | boolean>

Private featureEventMetadata

featureEventMetadata: {
    [k: string]: string | boolean;
}

Type declaration

  • [k: string]: string | boolean

Private features

features: {
    [k: string]: Feature;
}

Type declaration

Private identity

identity: AnonymizedCorrelationHashes

Private idsHost

idsHost: IdsHost

nixStoreTrust

nixStoreTrust: NixStoreTrust

Private nixSystem

nixSystem: string

Private sourceParameters

sourceParameters: SourceDef

strictMode

strictMode: boolean

Accessors

Private isMain

Private isPost

Methods

addFact

  • addFact(key, value): void

  • Parameters

    • key: string
    • value: string | boolean

    Returns void

Private cacheKey

  • cacheKey(version): string

  • Parameters

    • version: string

    Returns string

Private checkIn

  • checkIn(): Promise<void>

  • Returns Promise<void>

Private complete

  • complete(): Promise<void>

  • Returns Promise<void>

Private determineExecutionPhase

execute

  • execute(): void

  • Execute the Action as defined.

    Returns void

Private executeAsync

  • executeAsync(): Promise<void>

  • Returns Promise<void>

failOnError

  • failOnError(msg): 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

Private fetchArtifact

  • fetchArtifact(): Promise<string>

  • Fetch an artifact, such as a tarball, from the location determined by the source-* inputs. If source-binary is specified, this will return a path to a binary on disk; otherwise, the artifact will be downloaded from the URL determined by the other source-* inputs (source-url, source-pr, etc.).

    Returns Promise<string>

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>

Private getCachedVersion

  • getCachedVersion(version): Promise<undefined | string>

  • Parameters

    • version: string

    Returns Promise<undefined | string>

Private getCheckInUrl

  • getCheckInUrl(): Promise<undefined | URL>

  • Returns Promise<undefined | URL>

getClient

  • getClient(): Promise<Got>

  • Returns Promise<Got>

getCorrelationHashes

getDiagnosticsUrl

  • getDiagnosticsUrl(): Promise<undefined | URL>

  • Returns Promise<undefined | URL>

getFeature

Private getSourceUrl

  • getSourceUrl(): Promise<URL>

  • Returns Promise<URL>

getTemporaryName

  • getTemporaryName(): string

  • Returns string

getUniqueId

Abstract main

  • main(): Promise<void>

  • The main execution phase.

    Returns Promise<void>

Abstract post

  • post(): Promise<void>

  • The post execution phase.

    Returns Promise<void>

Private preflightNixStoreInfo

  • preflightNixStoreInfo(): Promise<void>

  • Returns Promise<void>

Private preflightRequireNix

  • preflightRequireNix(): Promise<boolean>

  • Returns Promise<boolean>

recordEvent

  • recordEvent(eventName, context?): void

  • Parameters

    • eventName: string
    • context: Record<string, unknown> = {}

    Returns void

Private requestCheckIn

  • requestCheckIn(): Promise<undefined | CheckIn>

  • Check in to install.determinate.systems, to accomplish three things:

    1. Preflight the server selected from IdsHost, to increase the chances of success.
    2. Fetch any incidents and maintenance events to let users know in case things are weird.
    3. Get feature flag data so we can gently roll out new features.

    Returns Promise<undefined | CheckIn>

Private saveCachedVersion

  • saveCachedVersion(version, toolPath): Promise<void>

  • Parameters

    • version: string
    • toolPath: string

    Returns Promise<void>

stapleFile

  • stapleFile(name, location): 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

Private submitEvents

  • submitEvents(): Promise<void>

  • Returns Promise<void>

unpackClosure

  • unpackClosure(bin): 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>

Settings

Member Visibility

Theme

On This Page

constructoractionOptionsarchOsarchitectureFetchSuffixeventsexceptionAttachmentsexecutionPhasefactsfeatureEventMetadatafeaturesidentityidsHostnixStoreTrustnixSystemsourceParametersstrictModeisMainisPostaddFactcacheKeycheckIncompletedetermineExecutionPhaseexecuteexecuteAsyncfailOnErrorfetchArtifactfetchExecutablegetCachedVersiongetCheckInUrlgetClientgetCorrelationHashesgetDiagnosticsUrlgetFeaturegetSourceUrlgetTemporaryNamegetUniqueIdmainpostpreflightNixStoreInfopreflightRequireNixrecordEventrequestCheckInsaveCachedVersionstapleFilesubmitEventsunpackClosure