@ronaldphilipsen/local-action 0.0.0-stage → 7.1.0

package/src/stubs/artifact/internal/download/download-artifact.ts

@@ -0,0 +1,309 @@
+/**
+ * Last Reviewed Commit: 9b08f07cd305c6060f08e4b64d1805429a773711
+ * Last Reviewed Date: 2026-01-16
+ */
+
+import * as httpClient from '@actions/http-client'
+import * as crypto from 'crypto'
+import fs from 'fs'
+import path from 'path'
+import * as stream from 'stream'
+import { finished } from 'stream/promises'
+import unzip from 'unzip-stream'
+import { EnvMeta } from '../../../../stubs/env.js'
+import * as core from '../../../core/core.js'
+import { getOctokit } from '../../../github/github.js'
+import { getGitHubWorkspaceDir } from '../shared/config.js'
+import { ArtifactNotFoundError } from '../shared/errors.js'
+import type {
+  Artifact,
+  DownloadArtifactOptions,
+  DownloadArtifactResponse
+} from '../shared/interfaces.js'
+import { StreamExtractResponse } from '../shared/interfaces.js'
+import { getUserAgentString } from '../shared/user-agent.js'
+
+/**
+ * Removes query parameters from a URL.
+ *
+ * @remarks
+ *
+ * - Exporting the function to make it available for testing.
+ *
+ * @param url URL
+ * @returns URL without query parameters
+ */
+export const scrubQueryParameters = (url: string): string => {
+  const parsed = new URL(url)
+  parsed.search = ''
+  return parsed.toString()
+}
+
+/**
+ * Checks if a path exists
+ *
+ * @remarks
+ *
+ * - Exporting the function to make it available for testing.
+ * - Use `accessSync` instead of `access`.
+ *
+ * @param path Path
+ * @returns `true` if the path exists, `false` otherwise
+ */
+export function exists(path: string): boolean {
+  try {
+    fs.accessSync(path)
+    return true
+  } catch (error: any) {
+    if (error.code === 'ENOENT') return false
+    else throw error
+  }
+}
+
+/**
+ * Extract the artifact from the given URL to the specified directory.
+ *
+ * @param url URL
+ * @param directory Directory
+ */
+/* istanbul ignore next */
+async function streamExtract(
+  url: string,
+  directory: string
+): Promise<StreamExtractResponse> {
+  let retryCount = 0
+  while (retryCount < 5) {
+    try {
+      return await streamExtractExternal(url, directory)
+    } catch (error: any) {
+      retryCount++
+      core.debug(
+        `Failed to download artifact after ${retryCount} retries due to ${error.message}. Retrying in 5 seconds...`
+      )
+      // wait 5 seconds before retrying
+      await new Promise(resolve => setTimeout(resolve, 5000))
+    }
+  }
+
+  throw new Error(`Artifact download failed after ${retryCount} retries.`)
+}
+
+/**
+ * Extract the artifact from the given URL to the specified directory.
+ *
+ * @remarks
+ *
+ * - Removed digest verification from the original implementation.
+ *
+ * @param url URL
+ * @param directory Directory
+ */
+/* istanbul ignore next */
+export async function streamExtractExternal(
+  url: string,
+  directory: string,
+  opts: { timeout: number } = { timeout: 30 * 1000 }
+): Promise<StreamExtractResponse> {
+  const client = new httpClient.HttpClient(getUserAgentString())
+  const response = await client.get(url)
+  if (response.message.statusCode !== 200)
+    throw new Error(
+      `Unexpected HTTP response from blob storage: ${response.message.statusCode} ${response.message.statusMessage}`
+    )
+
+  let sha256Digest: string | undefined = undefined
+
+  return new Promise((resolve, reject) => {
+    const timerFn = (): void => {
+      const timeoutError = new Error(
+        `Blob storage chunk did not respond in ${opts.timeout}ms`
+      )
+      response.message.destroy(timeoutError)
+      reject(timeoutError)
+    }
+    const timer = setTimeout(timerFn, opts.timeout)
+
+    const hashStream = crypto.createHash('sha256').setEncoding('hex')
+    const passThrough = new stream.PassThrough()
+
+    response.message.pipe(passThrough)
+    passThrough.pipe(hashStream)
+    const extractStream = passThrough
+
+    extractStream
+      .on('data', () => {
+        timer.refresh()
+      })
+      .on('error', (error: Error) => {
+        core.debug(
+          `response.message: Artifact download failed: ${error.message}`
+        )
+        clearTimeout(timer)
+        reject(error)
+      })
+      .pipe(unzip.Extract({ path: directory }))
+      .on('close', () => {
+        clearTimeout(timer)
+        if (hashStream) {
+          hashStream.end()
+          sha256Digest = hashStream.read() as string
+          core.info(`SHA256 digest of downloaded artifact is ${sha256Digest}`)
+        }
+        resolve({ sha256Digest: `sha256:${sha256Digest}` })
+      })
+      .on('error', (error: Error) => {
+        reject(error)
+      })
+  })
+}
+
+/**
+ * Download an artifact from the given repository to the specified directory.
+ *
+ * @remarks
+ *
+ * - Removed digest verification from the original implementation.
+ *
+ * @param artifactId Artifact ID
+ * @param repositoryOwner Repository Owner
+ * @param repositoryName Repository Name
+ * @param token Token
+ * @param options Options
+ * @returns Download Artifact Response
+ */
+/* istanbul ignore next */
+export async function downloadArtifactPublic(
+  artifactId: number,
+  repositoryOwner: string,
+  repositoryName: string,
+  token: string,
+  options?: DownloadArtifactOptions
+): Promise<DownloadArtifactResponse> {
+  const downloadPath = await resolveOrCreateDirectory(options?.path)
+
+  const api = getOctokit(token)
+
+  let digestMismatch = false
+
+  core.info(
+    `Downloading artifact '${artifactId}' from '${repositoryOwner}/${repositoryName}'`
+  )
+
+  const { headers, status } = await api.rest.actions.downloadArtifact({
+    owner: repositoryOwner,
+    repo: repositoryName,
+    artifact_id: artifactId,
+    archive_format: 'zip',
+    request: {
+      redirect: 'manual'
+    }
+  })
+
+  if (status !== 302)
+    throw new Error(`Unable to download artifact. Unexpected status: ${status}`)
+
+  const { location } = headers
+  if (!location) throw new Error(`Unable to redirect to artifact download url`)
+
+  core.info(
+    `Redirecting to blob download url: ${scrubQueryParameters(location)}`
+  )
+
+  try {
+    core.info(`Starting download of artifact to: ${downloadPath}`)
+    const extractResponse = await streamExtract(location, downloadPath)
+    core.info(`Artifact download completed successfully.`)
+    if (options?.expectedHash)
+      if (options?.expectedHash !== extractResponse.sha256Digest) {
+        digestMismatch = true
+        core.debug(`Computed digest: ${extractResponse.sha256Digest}`)
+        core.debug(`Expected digest: ${options.expectedHash}`)
+      }
+  } catch (error: any) {
+    throw new Error(
+      `Unable to download and extract artifact: ${error.message}`,
+      { cause: error }
+    )
+  }
+
+  return { downloadPath, digestMismatch }
+}
+
+/**
+ * Downloads an artifact from the current repository to the specified directory.
+ *
+ * @remarks
+ *
+ * - Removed digest verification from the original implementation.
+ * - Downloads from local filesystem instead of GitHub.
+ *
+ * @param artifactId Artifact ID
+ * @param options Options
+ * @returns Download Artifact Response
+ */
+export async function downloadArtifactInternal(
+  artifactId: number,
+  options?: DownloadArtifactOptions
+): Promise<DownloadArtifactResponse> {
+  const downloadPath = await resolveOrCreateDirectory(options?.path)
+
+  // Check the current list of artifacts for one with a matching ID.
+  const artifacts: Artifact[] = EnvMeta.artifacts.filter(
+    (artifact: Artifact) => artifact.id === artifactId
+  )
+
+  if (artifacts.length === 0)
+    throw new ArtifactNotFoundError(
+      `No artifacts found for ID: ${artifactId}\nAre you trying to download from a different run? Try specifying a github-token with \`actions:read\` scope.`
+    )
+
+  if (artifacts.length > 1)
+    core.warning('Multiple artifacts found, defaulting to first.')
+
+  try {
+    core.info(`Starting download of artifact to: ${downloadPath}`)
+
+    // Extract the file to the specified directory. The archive will be
+    // available at `${LOCAL_ACTION_ARTIFACT_PATH}/${artifact.id}`.
+    const readStream = fs.createReadStream(
+      path.join(
+        process.env.LOCAL_ACTION_ARTIFACT_PATH!,
+        `${artifacts[0].name}.zip`
+      )
+    )
+
+    readStream.pipe(unzip.Extract({ path: downloadPath }))
+
+    await finished(readStream)
+
+    core.info(`Artifact download completed successfully.`)
+  } catch (error: any) {
+    throw new Error(
+      `Unable to download and extract artifact: ${error.message}`,
+      { cause: error }
+    )
+  }
+
+  return { downloadPath, digestMismatch: false }
+}
+
+/**
+ * Resolves or creates a directory.
+ *
+ * @param downloadPath Download Path
+ * @returns Download Path
+ */
+/* istanbul ignore next */
+async function resolveOrCreateDirectory(
+  downloadPath = getGitHubWorkspaceDir()
+): Promise<string> {
+  if (!exists(downloadPath)) {
+    core.debug(
+      `Artifact destination folder does not exist, creating: ${downloadPath}`
+    )
+    fs.mkdirSync(downloadPath, { recursive: true })
+  } else
+    core.debug(`Artifact destination folder already exists: ${downloadPath}`)
+
+  return downloadPath
+}

package/src/stubs/artifact/internal/find/get-artifact.ts

@@ -0,0 +1,135 @@
+/**
+ * Last Reviewed Commit: d5c8a0fa274d832846b6c3a409b017a6b76b787e
+ * Last Reviewed Date: 2026-01-16
+ */
+
+import type { OctokitOptions } from '@octokit/core'
+import { requestLog } from '@octokit/plugin-request-log'
+import { retry } from '@octokit/plugin-retry'
+import { EnvMeta } from '../../../../stubs/env.js'
+import * as core from '../../../core/core.js'
+import { getOctokit } from '../../../github/github.js'
+import { defaults as defaultGitHubOptions } from '../../../github/utils.js'
+import {
+  ArtifactNotFoundError,
+  InvalidResponseError
+} from '../shared/errors.js'
+import type { Artifact, GetArtifactResponse } from '../shared/interfaces.js'
+import { getUserAgentString } from '../shared/user-agent.js'
+import { getRetryOptions } from './retry-options.js'
+
+/**
+ * Gets the artifact from the GitHub API.
+ *
+ * @remarks
+ *
+ * - Removed digest from the artifact interface.
+ *
+ * @param artifactName Artifact Name
+ * @param workflowRunId Workflow Run ID
+ * @param repositoryOwner Repository Owner
+ * @param repositoryName Repository Name
+ * @param token Token
+ * @returns Get Artifact Response
+ */
+export async function getArtifactPublic(
+  artifactName: string,
+  workflowRunId: number,
+  repositoryOwner: string,
+  repositoryName: string,
+  token: string
+): Promise<GetArtifactResponse> {
+  const [retryOpts, requestOpts] = getRetryOptions(defaultGitHubOptions)
+
+  const opts: OctokitOptions = {
+    log: undefined,
+    userAgent: getUserAgentString(),
+    previews: undefined,
+    retry: retryOpts,
+    request: requestOpts
+  }
+
+  const github = getOctokit(token, opts, retry as any, requestLog as any)
+
+  const getArtifactResp = await github.request(
+    'GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts{?name}',
+    {
+      owner: repositoryOwner,
+      repo: repositoryName,
+      run_id: workflowRunId,
+      name: artifactName
+    }
+  )
+
+  if (getArtifactResp.status !== 200)
+    throw new InvalidResponseError(
+      `Invalid response from GitHub API: ${getArtifactResp.status} (${getArtifactResp?.headers?.['x-github-request-id']})`
+    )
+
+  if (getArtifactResp.data.artifacts.length === 0)
+    throw new ArtifactNotFoundError(
+      `Artifact not found for name: ${artifactName}
+        Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
+        For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
+    )
+
+  let artifact = getArtifactResp.data.artifacts[0]
+  if (getArtifactResp.data.artifacts.length > 1) {
+    artifact = getArtifactResp.data.artifacts.sort(
+      (a: Artifact, b: Artifact) => b.id - a.id
+    )[0]
+    core.debug(
+      `More than one artifact found for a single name, returning newest (id: ${artifact.id})`
+    )
+  }
+
+  return {
+    artifact: {
+      name: artifact.name,
+      id: artifact.id,
+      size: artifact.size_in_bytes,
+      createdAt: artifact.created_at ? new Date(artifact.created_at) : undefined
+    }
+  }
+}
+
+/**
+ * Gets the artifact from this workflow run.
+ *
+ * @remarks
+ *
+ * - Removed digest from the artifact interface.
+ * - Gets artifacts from environment metadata.
+ *
+ * @param artifactName Artifact Name
+ * @returns Get Artifact Response
+ */
+export async function getArtifactInternal(
+  artifactName: string
+): Promise<GetArtifactResponse> {
+  // Get all artifacts with a matching name, sorted by latest (highest ID).
+  const artifacts = EnvMeta.artifacts
+    .filter(artifact => artifact.name === artifactName)
+    .sort((a, b) => Number(b.id) - Number(a.id))
+
+  if (artifacts.length === 0)
+    throw new ArtifactNotFoundError(
+      `Artifact not found for name: ${artifactName}
+        Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
+        For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
+    )
+
+  if (artifacts.length > 1)
+    core.debug(
+      `More than one artifact found for a single name, returning newest (id: ${artifacts[0].id})`
+    )
+
+  return {
+    artifact: {
+      name: artifacts[0].name,
+      id: Number(artifacts[0].id),
+      size: Number(artifacts[0].size),
+      createdAt: artifacts[0].createdAt
+    }
+  }
+}

package/src/stubs/artifact/internal/find/list-artifacts.ts

@@ -0,0 +1,188 @@
+/**
+ * Last Reviewed Commit: fea4f6b5c527a8f231cfb9e2530a2f367e971faa
+ * Last Reviewed Date: 2026-01-16
+ */
+
+import type { OctokitOptions } from '@octokit/core'
+import { requestLog } from '@octokit/plugin-request-log'
+import { retry } from '@octokit/plugin-retry'
+import { EnvMeta } from '../../../../stubs/env.js'
+import * as core from '../../../core/core.js'
+import { getOctokit } from '../../../github/github.js'
+import { defaults as defaultGitHubOptions } from '../../../github/utils.js'
+import { getMaxArtifactListCount } from '../shared/config.js'
+import type { Artifact, ListArtifactsResponse } from '../shared/interfaces.js'
+import { getUserAgentString } from '../shared/user-agent.js'
+import { getRetryOptions } from './retry-options.js'
+
+const paginationCount = 100
+
+/**
+ * Lists artifacts for a given workflow run.
+ *
+ * @remarks
+ *
+ * - Removed digest from the artifact interface.
+ *
+ * @param workflowRunId Workflow Run ID
+ * @param repositoryOwner Repository Owner
+ * @param repositoryName Repository Name
+ * @param token Token
+ * @param latest Latest
+ * @returns List Artifacts Response
+ */
+export async function listArtifactsPublic(
+  workflowRunId: number,
+  repositoryOwner: string,
+  repositoryName: string,
+  token: string,
+  latest = false
+): Promise<ListArtifactsResponse> {
+  core.info(
+    `Fetching artifact list for workflow run ${workflowRunId} in repository ${repositoryOwner}/${repositoryName}`
+  )
+
+  let artifacts: Artifact[] = []
+  const [retryOpts, requestOpts] = getRetryOptions(defaultGitHubOptions)
+
+  const opts: OctokitOptions = {
+    log: undefined,
+    userAgent: getUserAgentString(),
+    previews: undefined,
+    retry: retryOpts,
+    request: requestOpts
+  }
+
+  const github = getOctokit(token, opts, retry as any, requestLog as any)
+
+  let currentPageNumber = 1
+
+  const { data: listArtifactResponse } =
+    await github.rest.actions.listWorkflowRunArtifacts({
+      owner: repositoryOwner,
+      repo: repositoryName,
+      run_id: workflowRunId,
+      per_page: paginationCount,
+      page: currentPageNumber
+    })
+
+  let numberOfPages = Math.ceil(
+    listArtifactResponse.total_count / paginationCount
+  )
+  const totalArtifactCount = listArtifactResponse.total_count
+  if (totalArtifactCount > getMaxArtifactListCount()) {
+    core.warning(
+      `Workflow run ${workflowRunId} has more than 1000 artifacts. Results will be incomplete as only the first ${getMaxArtifactListCount()} artifacts will be returned`
+    )
+    numberOfPages = Math.ceil(getMaxArtifactListCount() / paginationCount)
+  }
+
+  // Iterate over the first page
+  for (const artifact of listArtifactResponse.artifacts) {
+    artifacts.push({
+      name: artifact.name,
+      id: artifact.id,
+      size: artifact.size_in_bytes,
+      createdAt: artifact.created_at
+        ? new Date(artifact.created_at)
+        : undefined,
+      digest: (artifact as ArtifactResponse).digest
+    })
+  }
+
+  // Move to the next page
+  currentPageNumber++
+
+  // Iterate over any remaining pages
+  /* istanbul ignore next */
+  for (
+    currentPageNumber;
+    currentPageNumber <= numberOfPages;
+    currentPageNumber++
+  ) {
+    core.debug(`Fetching page ${currentPageNumber} of artifact list`)
+
+    const { data: listArtifactResponse } =
+      await github.rest.actions.listWorkflowRunArtifacts({
+        owner: repositoryOwner,
+        repo: repositoryName,
+        run_id: workflowRunId,
+        per_page: paginationCount,
+        page: currentPageNumber
+      })
+
+    for (const artifact of listArtifactResponse.artifacts) {
+      artifacts.push({
+        name: artifact.name,
+        id: artifact.id,
+        size: artifact.size_in_bytes,
+        createdAt: artifact.created_at
+          ? new Date(artifact.created_at)
+          : undefined,
+        digest: (artifact as ArtifactResponse).digest
+      })
+    }
+  }
+
+  if (latest) artifacts = filterLatest(artifacts)
+
+  core.info(`Found ${artifacts.length} artifact(s)`)
+
+  return {
+    artifacts
+  }
+}
+
+/**
+ * List artifacts for this workflow run.
+ *
+ * @remarks
+ *
+ * - Uses environment metadata for tracking artifacts.
+ *
+ * @param latest Latest
+ * @returns List Artifacts Response
+ */
+export async function listArtifactsInternal(
+  latest = false
+): Promise<ListArtifactsResponse> {
+  const artifacts = latest ? filterLatest(EnvMeta.artifacts) : EnvMeta.artifacts
+
+  core.info(`Found ${artifacts.length} artifact(s)`)
+
+  return {
+    artifacts
+  }
+}
+
+/**
+ * This exists so that we don't have to use 'any' when receiving the artifact
+ * list from the GitHub API. The digest field is not present in OpenAPI/types at
+ * time of writing, which necessitates this change.
+ */
+interface ArtifactResponse {
+  name: string
+  id: number
+  size_in_bytes: number
+  created_at?: string
+  digest?: string
+}
+
+/**
+ * Filters a list of artifacts to only include the latest artifact for each name
+ *
+ * @param artifacts The artifacts to filter
+ * @returns The filtered list of artifacts
+ */
+function filterLatest(artifacts: Artifact[]): Artifact[] {
+  artifacts.sort((a, b) => b.id - a.id)
+  const latestArtifacts: Artifact[] = []
+  const seenArtifactNames = new Set<string>()
+  for (const artifact of artifacts) {
+    if (!seenArtifactNames.has(artifact.name)) {
+      latestArtifacts.push(artifact)
+      seenArtifactNames.add(artifact.name)
+    }
+  }
+  return latestArtifacts
+}

package/src/stubs/artifact/internal/find/retry-options.ts

@@ -0,0 +1,57 @@
+/**
+ * Last Reviewed Commit: 06e751600e2c016997ae8b1393bff0c4c79fc52f
+ * Last Reviewed Date: 2026-01-16
+ */
+
+import type { OctokitOptions } from '@octokit/core'
+import type { RequestRequestOptions } from '@octokit/types'
+import * as core from '../../../core/core.js'
+
+export type RetryOptions = {
+  doNotRetry?: number[]
+  enabled?: boolean
+}
+
+// Defaults for fetching artifacts
+const defaultMaxRetryNumber = 5
+const defaultExemptStatusCodes = [400, 401, 403, 404, 422] // https://github.com/octokit/plugin-retry.js/blob/9a2443746c350b3beedec35cf26e197ea318a261/src/index.ts#L14
+
+/**
+ * Get the retry options for the GitHub client.
+ *
+ * @param defaultOptions Default Options
+ * @param retries Retries
+ * @param exemptStatusCodes Exempt Status Codes
+ * @returns Retry Options
+ */
+export function getRetryOptions(
+  defaultOptions: OctokitOptions,
+  retries: number = defaultMaxRetryNumber,
+  exemptStatusCodes: number[] = defaultExemptStatusCodes
+): [RetryOptions, RequestRequestOptions | undefined] {
+  if (retries <= 0) return [{ enabled: false }, defaultOptions.request]
+
+  const retryOptions: RetryOptions = {
+    enabled: true
+  }
+
+  if (exemptStatusCodes.length > 0) retryOptions.doNotRetry = exemptStatusCodes
+
+  // The GitHub type has some defaults for `options.request`
+  // see: https://github.com/actions/toolkit/blob/4fbc5c941a57249b19562015edbd72add14be93d/packages/github/src/utils.ts#L15
+  // We pass these in here so they are not overridden.
+  const requestOptions: RequestRequestOptions = {
+    ...defaultOptions.request,
+    retries
+  }
+
+  core.debug(
+    `GitHub client configured with: (retries: ${
+      requestOptions.retries
+    }, retry-exempt-status-code: ${
+      retryOptions.doNotRetry ?? 'octokit default: [400, 401, 403, 404, 422]'
+    })`
+  )
+
+  return [retryOptions, requestOptions]
+}