After Download Worker Code Sample

JFrog Platform Administration Documentation

Content Type
Administration / Platform
ft:sourceType
Paligo

The following section provides a sample code for an After Download worker.

export default async (context: PlatformContext, data: AfterDownloadRequest): Promise<AfterDownloadResponse> => {

    try {
        // The in-browser HTTP client facilitates making calls to the JFrog REST APIs
        //To call an external endpoint, use 'await context.clients.axios.get("https://foo.com")'
        const res = await context.clients.platformHttp.get('/artifactory/api/v1/system/readiness');

        // You should reach this part if the HTTP request status is successful (HTTP Status 399 or lower)
        if (res.status === 200) {
            console.log("Artifactory ping success");
        } else {
            console.warn(`Request was successful and returned status code : ${res.status}`);
        }
    } catch(error) {
        // The platformHttp client throws PlatformHttpClientError if the HTTP request status is 400 or higher
        console.error(`Request failed with status code ${error.status || '<none>'} caused by : ${error.message}`)
    }

    return {
        message: 'proceed',
        modifiedRepoPath: data.metadata.repoPath,
        size: 1,
        statusCode: 1,
        responseMessage: "mymessage",
    }
}

Input Parameters

context

Provides baseUrl, token, and clients to communicate with the JFrog Platform (for more information, see PlatformContext).

data

The request with download details sent by Artifactory.

{
 "metadata": { // Various immutable download metadata
   "repoPath": { // The repository path object of the request
     "key": "key", // The repository key
     "path": "path", // The path itself
     "id": "key:path", // The key:path combination
     "isRoot": false, // Is the path the root?
     "isFolder": false  // Is the path a folder?
   },
   "originalRepoPath": { // The original repository path if a virtual repository is involved
     "key": "key",
     "path": "path",
     "id": "key:path",
     "isRoot": false,
     "isFolder": false
   },
   "name": "name", // The file name from path
   "headOnly": false, // Is it a head request?
   "checksum": false, // Is it a checksum request?
   "recursive": false, // Is it a recursive request?
   "modificationTime": 0, // When a modification has occurred
   "directoryRequest": false, // Is it a directory request
   "metadata": false, // Is it a metadata request?
   "lastModified": 1, // Last modification time that occurred
   "ifModifiedSince": 0, // If a modification happened since the last modification time
   "servletContextUrl": "base", // The URL that points to artifactory
   "uri": "jfrog.com", // The request URI
   "clientAddress": "localhost", // The client address
   "zipResourcePath": "", // The resource path of the requested zip
   "zipResourceRequest": false, // Is the request a zip resource request?
   "replaceHeadRequestWithGet": false, // Should the head request be replaced with GET?
   "repoType": 1 // Repository type
 },
 "headers": { // The immutable request headers
   "key": {
     "value": []
   }
 },
 "userContext": { // The user context that sends the request
   "id": "id", // The username or subject
   "isToken": false, // Is the context an accessToken?
   "realm": "realm" // The realm of the user
 }
}

Response

{
  "data": {  // Main data object containing the response details
    "message": "proceed",  // Message to print to the log. If there is an error it will be printed as a warning.
    "modifiedRepoPath": {  // Object containing details about the modified repository path
      "key": "local-repo",  // Unique key identifier for the repository
      "path": "folder/subfolder/my-file",  // Path to the modified file within the repository
      "id": "local-repo:folder/subfolder/my-file",  // Unique identifier combining the repository key and path
      "isRoot": false,  // Indicates whether the path is a root directory (false means it is not)
      "isFolder": false  // Indicates whether the path is a folder (false means it is a file)
    },
    "size": 1,  // Size of the data returned (e.g., number of items in the response)
    "statusCode": 1,  // Numeric code representing the status of the operation (1 could denote success)
    "responseMessage": "mymessage"  // Additional message providing context or details about the response
  },
  "executionStatus": "STATUS_SUCCESS"  // Status indicating that the execution was successful
}

message : This is a mandatory field.