After Create Worker Code Sample

JFrog Platform Administration Documentation

Content Type
Administration / Platform
ft:sourceType
Paligo

The following section provides a sample code for a After Create worker.

export default async (context: PlatformContext, data: AfterCreateRequest): Promise<AfterCreateResponse> => {

   try {
       const res = await context.clients.platformHttp.get('/artifactory/api/system/ping');
       if (res.status === 200) {
           console.log("Artifactory ping success");
       } else {
           console.warn(`Request was successful and returned status code : ${ res.status }`);
       }
   } catch(error) {
       console.error(`Request failed with status code ${ error.status || '<none>' } caused by : ${ error.message }`)
   }


   return {
       message: 'proceed',
       modifiedRepoPath: data.metadata.repoPath,
   }
}

Input Parameters

context

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

data

The request with upload details sent by Artifactory.

{
 "metadata": { // Various immutable upload 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?
   },
   "contentLength": 0, // The deploy request content length
   "lastModified": 1, // Last modification time that occurred
   "trustServerChecksums": false, // Is the request trusting the server checksums?
   "servletContextUrl": "base", // The URL that points to Artifactory
   "skipJarIndexing": false, // Is it a request that skips jar indexing?
   "disableRedirect": false, // Is redirect disabled on this request?
   "repoType": 1 // Repository type
 },
 "headers": { // The immutable request headers
   "key": {
     "value": []
   }
 },
 "userContext": { // The user context which sends the request
   "id": "id", // The username or subject
   "isToken": false, // Is the context an access token?
   "realm": "realm" // The realm of the user
 },
 "artifactProperties": {  // The properties of the request
   "key": {
     "value": []
   }
 }
}

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 information about the modified repository path
      "key": "local-repo",  // Unique key identifier for the repository
      "path": "folder/subfolder/my-file",  // Path to the file/folder that has been modified
      "id": "local-repo:folder/subfolder/my-file",  // Unique identifier combining repo key and path
      "isRoot": false,  // Indicates if the path is a root directory
      "isFolder": false  // Indicates if the path is a folder
    }
  },
  "executionStatus": "STATUS_SUCCESS"  // Status of the command execution, indicating success
}

message : This is a mandatory field.