1
0
Fork 0
mirror of https://github.com/actions/toolkit synced 2025-05-09 08:33:00 +00:00

consistent promise behavior for download artifact

This commit is contained in:
Rob Herley 2023-12-05 18:35:26 +00:00 committed by GitHub
parent d3c5f358d1
commit ce9eae0785
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 16 deletions

View file

@ -16,6 +16,7 @@ import {
ListArtifactsRequest
} from '../../generated'
import {getBackendIdsFromToken} from '../shared/util'
import {ArtifactNotFoundError} from '../shared/errors'
const scrubQueryParameters = (url: string): string => {
const parsed = new URL(url)
@ -95,7 +96,7 @@ export async function downloadArtifactPublic(
throw new Error(`Unable to download and extract artifact: ${error.message}`)
}
return {success: true, downloadPath}
return {downloadPath}
}
export async function downloadArtifactInternal(
@ -118,10 +119,9 @@ export async function downloadArtifactInternal(
const {artifacts} = await artifactClient.ListArtifacts(listReq)
if (artifacts.length === 0) {
core.warning(
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.`
)
return {success: false}
}
if (artifacts.length > 1) {
@ -148,7 +148,7 @@ export async function downloadArtifactInternal(
throw new Error(`Unable to download and extract artifact: ${error.message}`)
}
return {success: true, downloadPath}
return {downloadPath}
}
async function resolveOrCreateDirectory(

View file

@ -48,7 +48,9 @@ export async function getArtifactPublic(
}
if (getArtifactResp.data.artifacts.length === 0) {
throw new ArtifactNotFoundError(artifactName)
throw new ArtifactNotFoundError(
`Artifact not found for name: ${artifactName}`
)
}
let artifact = getArtifactResp.data.artifacts[0]
@ -86,7 +88,9 @@ export async function getArtifactInternal(
const res = await artifactClient.ListArtifacts(req)
if (res.artifacts.length === 0) {
throw new ArtifactNotFoundError(artifactName)
throw new ArtifactNotFoundError(
`Artifact not found for name: ${artifactName}`
)
}
let artifact = res.artifacts[0]

View file

@ -21,8 +21,7 @@ export class InvalidResponseError extends Error {
}
export class ArtifactNotFoundError extends Error {
constructor(name: string) {
const message = `No artifact found for name: ${name}`
constructor(message = 'Artifact not found') {
super(message)
this.name = 'ArtifactNotFoundError'
}

View file

@ -86,10 +86,6 @@ export interface ListArtifactsResponse {
* *
*****************************************************************************/
export interface DownloadArtifactResponse {
/**
* If the artifact download was successful
*/
success: boolean
/**
* The path where the artifact was downloaded to
*/