Before Copy Worker Code Sample

The following section provides a sample code for a Before Copy worker.

export default async (context: PlatformContext, data: BeforeCopyRequest): Promise<BeforeCopyResponse> => {

  let status: ActionStatus = ActionStatus.UNSPECIFIED;

  try {
      // The HTTP client facilitates calls to the JFrog Platform 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) {
          status = ActionStatus.PROCEED;
          console.log("Artifactory ping success");
      } else {
          status = ActionStatus.WARN;
          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
      status = ActionStatus.STOP;
      console.error(`Request failed with status code ${ error.status || '<none>' } caused by : ${ error.message }`)
  }

  return {
      status: ActionStatus.PROCEED,
      message: 'proceed'
  }
}

Input Parameters

context

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

data

The request with copy details sent by Artifactory.

{
  "metadata": {  // Object containing metadata information about the artifact
    "repoPath": {  // Current repository path information for the artifact
      "key": "local-repo",  // Unique key identifier for the repository
      "path": "folder/subfolder/my-file",  // Current path to the specific file within the repository
      "id": "local-repo:folder/subfolder/my-file",  // Unique identifier combining the repository key and path
      "isRoot": false,  // Indicates if the path is a root directory (false means it is nested)
      "isFolder": false  // Indicates if the path is a folder (false means it is a file)
    },
    "contentLength": 100,  // Length of the content in bytes
    "lastModified": 0,  // Timestamp of the last modification (0 indicates it has not been modified)
    "trustServerChecksums": false,  // Indicates whether to trust server checksums for validation
    "servletContextUrl": "servlet.com",  // URL for accessing the servlet context
    "skipJarIndexing": false,  // Indicates whether to skip indexing for JAR files
    "disableRedirect": false,  // Indicates whether HTTP redirects should be disabled
    "repoType": 1  // Numeric identifier representing the type of repository (e.g., local, remote, virtual)
  },
  "itemInfo": {  // Object containing information about the specific item (artifact)
    "repoPath": {  // Current repository path information for the item
      "key": "local-repo",  // Unique key identifier for the repository
      "path": "folder/subfolder/my-file",  // Current path to the specific item within the repository
      "id": "local-repo:folder/subfolder/my-file",  // Unique identifier combining the repository key and path
      "isRoot": false,  // Indicates if the path is a root directory (false means it is nested)
      "isFolder": false  // Indicates if the path is a folder (false means it is a file)
    },
    "name": "my-artifact",  // Name of the item (artifact)
    "created": 1,  // Timestamp of when the item was created (assumed to be Unix timestamp)
    "lastModified": 0  // Timestamp of the last modification (0 indicates no modification)
  },
  "targetRepoPath": {  // Object containing information about the target repository path for the item
    "key": "target-repo",  // Unique key identifier for the target repository
    "path": "new_folder/my-file",  // Path to where the item will be moved in the target repository
    "id": "target-repo:new_folder/my-file",  // Unique identifier for the target path
    "isRoot": false,  // Indicates if the target path is a root directory (false means it is nested)
    "isFolder": false  // Indicates if the target path is a folder (false means it is a file)
  },
  "properties": {  // Object containing various properties associated with the item
    "prop1": {  // Custom property name
      "value": [  // Array of values associated with the property
        "value1",  // First value of the property
        "value2"   // Second value of the property
      ]
    },
    "size": {  // Property related to the size of the item
      "value": "50Gb"  // Size of the item specified as a string
    },
    "shaResolution": {  // Property related to the hashing algorithm used
      "value": "sha256"  // Value indicating the SHA resolution (hashing algorithm)
    }
  },
  "userContext": {  // Object containing information about the user making the request
    "id": "id",  // Unique identifier for the user
    "isToken": false,  // Indicates if the user is authenticated via a token (false means not)
    "realm": "realm"  // Realm for user authentication context
  }
}

Response

{
  "data": {
    "status": 1, // The instruction of how to proceed
    "message": "proceed" // Message to print to the log. In case of an error, it will be printed as a warning.
  },
  "executionStatus": "STATUS_SUCCESS"
}

Possible Statuses