@adobe/aem-upload

AEM Assets direct binary access uploading tool

Usage no npm install needed!

<script type="module">
  import adobeAemUpload from 'https://cdn.skypack.dev/@adobe/aem-upload';
</script>

README

Background

In AEM Assets 6.5 and prior, a single post request to a servlet that manges asset binaries is enough for uploading files. Newer versions of AEM can be configured to use direct binary upload, which means that asset binaries are no longer uploaded straight to AEM. Because of this there is a more complex algorithm to follow when uploading asset binaries. Due to the fact that direct binary upload is a configuration, whether or not this library can be used on a given AEM instance will vary. However, all AEM as a Cloud Service instances will have direct binary upload enabled, so this library will work with those.

This tool is provided for making uploading easier, and can be used as a command line executable or required as a Node.js module.

Command Line

A command line tool for for uploading assets to an AEM instance is available as a plugin for the Adobe I/O CLI. Please see the plugin repository for more information.

Usage

This library supports uploading files to a target instance, while providing support for monitoring transfer progress, cancelling transfers, and other features.

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

It can be installed like any other Node.js module.

$ npm install @adobe/aem-upload

Requiring the Module

To add the module to your Node.js project:

  1. Install the module in your project.
  2. Require the module in the javascript file where it will be consumed:
const DirectBinary = require('@adobe/aem-upload');

Uploading Files

Following is the minimum amount of code required to upload files to a target AEM instance.

const DirectBinary = require('@adobe/aem-upload');

// URL to the folder in AEM where assets will be uploaded. Folder
// must already exist.
const targetUrl = 'http://localhost:4502/content/dam/target';

// list of all local files that will be uploaded.
const uploadFiles = [
    {
        fileName: 'file1.jpg', // name of the file as it will appear in AEM
        fileSize: 1024, // total size, in bytes, of the file
        filePath: '/Users/me/Documents/my_file.jpg' // Full path to the local file
    },
    {
        fileName: 'file2.jpg',
        fileSize: 512,
        filePath: '/Users/me/Documents/file2.jpg'
    }
];

const upload = new DirectBinary.DirectBinaryUpload();
const options = new DirectBinary.DirectBinaryUploadOptions()
    .withUrl(targetUrl)
    .withUploadFiles(uploadFiles);

// this call will upload the files. The method returns a Promise, which will be resolved
// when all files have uploaded.
upload.uploadFiles(options)
    .then(result => {
        // "result" contains various information about the upload process, including
        // performance metrics and errors that may have occurred for individual files

        // at this point, assuming no errors, there will be two new assets in AEM:
        //  http://localhost:4502/content/dam/target/file1.jpg
        //  http://localhost:4502/content/dam/target/file2.jpg
    })
    .catch(err => {
        // the Promise will reject if something causes the upload process to fail at
        // a high level. Note that individual file failures will NOT trigger this

        // "err" will be an instance of UploadError. See "Error Handling"
        // for more information
    });

Supported Options

The DirectBinaryUploadOptions class supports the following options. Items with * are required.

Option Type Description
* URL string Full, absolute URL to the Folder in the target instance where the specified files will be uploaded. This value is expected to be URI encoded.

Example
options.withUrl('http://localhost:4502/content/dam/target');
* Upload Files Array List of files that will be uploaded to the target URL. Each item in the array should be an object consisting of the following properties:
Property Type Description
fileName string The name of the file as it will appear in AEM. This value does not need to be URI encoded.
fileSize number Total size, in bytes, of the file to upload.
filePath string Full path to a local file to upload. Note that either this value or blob must be specified. This option is typically most useful when running the upload tool from a Node.js process.
blob Array-like Value containing the data for a file. This can potentially be multiple types of values, as long as the value supports the slice() method (like an array). Note that either this value or filePath must be specified. This option is typically most useful when running the upload tool from a browser; the value of a <input type='file' /> can be used as the blob value.
createVersion boolean If true and an asset with the given name already exists, the process will create a new version of the asset instead of updating the current version with the new binary.

Default: false
versionLabel string If the process creates a new version of the asset, the label to associated with the newly created version.

Default: null
versionComment string If the process creates a new version of the asset, the comment to associated with the newly created version.

Default: null
replace boolean If true and an asset with the given name already exists, the process will delete the existing asset and create a new one with the same name and the new binary.

Note that if both this option and "create version" are specified, "create version" will take priority.

Default: false


Example
options.withUploadFiles([
    {
        fileName: 'file1.jpg',
        fileSize: 1024,
        filePath: '/Users/me/Documents/file1.jpg'
    },
    {
        fileName: 'file2.jpg',
        fileSize: 2048,
        blob: [
            'h', 'e', 'l', 'l', 'o'
        ]
    }
]);
headers object HTTP headers that will be included in each request sent to AEM. Each property should be a header name, with the value being the header's value.

Example
options.withHeaders({
    'content-type': 'image/jpeg',
    'authorization': '12345'
});
concurrent boolean If true, multiple files in the supplied list of upload files will transfer simultaneously. If false, only one file will transfer at a time, and the next file will not begin transferring until the current file finishes.

Default: false.

Example
options.withConcurrent(true);
max concurrent requests number The maximum number of concurrent HTTP requests that are allowed at any one time. As explained in the concurrent option, the library will concurrently upload multiple files at once. This value essentially indicates the maximum number of files that the process will upload at once.

A value less than 2 will instruct the library not to upload more than one file concurrently.

Default: 5.

Example
options.withMaxConcurrent(2);
*DEPRECATED* add content length header boolean *DEPRECATED* The module will now perform the operation that this option controlled automatically. The option no longer does anything.

If true, the upload process will automatically add a Content-Length header when uploading file parts to AEM. If false, no such header will be added.
This option is relevant depending on the context in which the process is running. For example, if running through Node.js then the underlying libraries will not automatically add a Content-Length header when submitting an HTTP PUT request, so it must be explicitly added. However, when running through a browser the underlying libraries will automatically add a Content-Length header, and will issue a warning if it's explicitly added.

Default: false

Example
options.withAddContentLengthHeader(true);
http retry count number The number of times that the process will retry a failed HTTP request before giving up. For example, if the retry count is 3 then the process will submit the same HTTP request up to 3 times if the response indicates a failure.

Default: 3

Example
options.withHttpRetryCount(5);
http retry delay number The amount of time that the process will wait before retrying a failed HTTP request. The value is specified in milliseconds. With each increasing retry, the delay will increase by its value. For example, if the delay is 5000 then the first retry will wait 5 seconds, the second 10 seconds, the third 15 seconds, etc.

Default: 5000

Example
options.withHttpRetryDelay(3000);

Error Handling

If a file fails to upload, the process will move to the next file in the list. The overall process itself will only fail if something catastrophic happens that prevents it from continuing to upload files. It's left up to the consumer to determine if there were individual file upload failures and react to them accordingly.

All errors reported by the upload process will be instances of UploadError, which are standard javascript Error instances with an additional code value that indicates the type of error. Specific codes are available in DirectBinary.DirectBinaryUploadErrorCodes.

The following is an example of handling errors, at either the process or file level.

const codes = DirectBinary.DirectBinaryUploadErrorCodes;
const upload = new DirectBinary.DirectBinaryUpload();
upload.uploadFiles(options) // assume that options is defined previously
    .then(result => {
        // use this method to retrieve ALL errors during the process
        result.getErrors().forEach(error => {
            if (error.getCode() === codes.ALREADY_EXISTS) {
                // handle case where a file already exists
            }
        });

        // or retrieve individual file errors
        result.getFileUploadResults().forEach(fileResult => {
            fileResult.getErrors().forEach(fileErr => {
                if (fileErr.getCode() === codes.ALREADY_EXISTS) {
                    // "fileResult" contains information about the file
                    const fileName = fileResult.getFileName();

                    // handle case where file already exists
                }
            });
        });
    })
    .catch(err => {
        if (err.getCode() === codes.NOT_SUPPORTED) {
            // handle case where direct binary access is not enabled
            // on the target instance
        }
    });

Another way of handling individual file errors is to listen for the upload process's Events.

The process implements automatic HTTP retry handling, meaning that if an HTTP request fails then the process will wait for a specified interval and retry the same HTTP request a given number of times. If the request still fails after the given number of retries, it will report the error as normal using the last error. Any errors that caused a retry, in either a success scenario or failure scenario, will be reported in the result in a dedicated structure.

Upload Events

As the upload process moves through individual files, it will send events as it goes through the stages of uploading a file. These events are listed below.

Event Description Data
filestart Indicates that a file has started to upload. The data sent with the event will be a simple javascript object with the following properties:
Property Type Description
fileName string The name of the file, as it was specified in the upload options. This will not be a URI encoded value.
fileSize number The size of the file, in bytes, as it was specified in the upload options.
targetFolder string Full path to the AEM folder where the file is being uploaded. This will not be a URI encoded value.
targetFile string Full path to the asset in AEM. This will not be a URI encoded value.
mimeType string HTTP Content-Type value of the file.
fileprogress Sent periodically and includes information about how much of the file has uploaded. A simple javascript object containing the same properties as "filestart," in addition to the following properties:
Property Type Description
transferred number The number of the file's bytes that have been uploaded so far. This will be a cumulative value, increasing each time the event is sent.
fileend Indicates that a file has uploaded successfully. This event will not be sent if the file failed to upload, or if the file upload was cancelled. A simple javascript object containing the same properties as "filestart."
fileerror Sent if a file fails to upload. This event will not be sent if the file uploads successfully, or if the file upload was cancelled. A simple javascript object containing the same properties as "filestart," in addition to the following properties:
Property Type Description
errors Array A list of all the errors that occurred while trying to upload the file. Each item in the array will be an instance of type UploadError. See "Error Handling" for more details.
filecancelled Indicates that a file upload was cancelled. A simple javascript object containing the same properties as "filestart."

The following is an example of how to handle various events.

const upload = new DirectBinary.DirectBinaryUpload();
upload.on('filestart', data => {
    const { fileName } = data;

    // specific handling that should occur when a file begins uploading
});
upload.on('fileprogress', data => {
    const { fileName, transferred } = data;

    // specific handling that should occur as a file uploads
});
upload.on('fileend', data => {
    const { fileName } = data;

    // specific handling that should occur when a file finishes uploading successfully
});
upload.on('fileerror', data => {
    const { fileName, errors } = data;

    // specific handling that should occur when a file files to upload
});

// assume options has been declared previously
upload.uploadFiles(options);

Controlling In-Progress Uploads

After the process of uploading one or more files begins, it's possible to interact with the process using a controller. The controller allows operations like cancelling individual file uploads or all uploads.

The following is an example for how to control the process.

const options = new DirectBinaryUploadOptions()
    .withUrl(url)
    .withUploadFiles(files);

// retrieve a controller instance from the options
const controller = options.getController();
const upload = new DirectBinaryUpload();
upload.uploadFiles(options);

// at this point its possible to send command to the upload process using
// the controller

// cancel the upload of an individual file. Note that the "filePath" parameter
// should be the full target AEM path to the file. an example value might be:
// "/content/dam/uploadfolder/file-to-cancel.jpg"
controller.cancelFile(filePath);

// cancel ALL files in the upload
controller.cancel();

Uploading Local Files

The library supports uploading local files and folders. For folders, the tool will include all immediate children files in the folder. It will not process sub-folders unless the "deep upload" option is specified.

The following example illustrates how to upload local files.

const {
    FileSystemUploadOptions,
    FileSystemUpload
} = require('@adobe/aem-upload');

// configure options to use basic authentication
const options = new FileSystemUploadOptions()
    .withUrl('http://localhost:4502/content/dam/target-folder')
    .withBasicAuth('admin:admin');

// upload a single asset and all assets in a given folder
const fileUpload = new FileSystemUpload();
await fileUpload.upload(options, [
    '/Users/me/myasset.jpg',
    '/Users/me/myfolder'
]);

Supported File Options

There is a set of options, FileSystemUploadOptions, that are specific to uploading local files. In addition to default options, the following options are available.

Option Type Description
Maximum number of files number The maximum number of files that the library will attempt to upload. If the target upload exceeds this number then the process will fail with an exception. Default: 1000.

Example
options.withMaxUploadFiles(100);
Perform deep upload boolean If true, the process will include all descendent folders and files when given a folder to upload. If false, the process will only upload those files immediately inside the folder to upload. Default: false.

Example
options.withDeepUpload(true);
Function for processing folder node names function When performing a deep upload, the tool will create folders in AEM that match local folders being uploaded. The tool will "clean" the folder names of certain characters when creating node names for each folder. The unmodified folder name will become the node's title.

This option allows customization of the functionality that cleans the folder's name. The option should be a function. It will receive a single argument value: the name of the folder to be cleaned. The return value of the function should be a Promise, which should resolve with the clean folder name.

The default functionality will convert the folder name to lower case and replace whitespace and any of the characters %;#,+?^{} with the replacement value specified in the options.

Regardless of this function, the library will always replace any of the characters ./:[]|*\ with the replacement value specified in the options.

Example
// This example will skip any special processing
options.withFolderNodeNameProcessor((folderName) => {
  return new Promise((resolve) => resolve(folderName));
});
Function for processing asset node names function When performing a deep upload, the tool will create assets in AEM that match local files being uploaded. The tool will "clean" the file names of certain characters when creating node names for each asset.

This option allows customization of the functionality that cleans the file's name. The option should be a function. It will receive a single argument value: the name of the file to be cleaned. The return value of the function should be a Promise, which should resolve with the clean asset name.

The default functionality will replace any of the characters #%{}?& with the replacement value specified in the options.

Regardless of this function, the library will always replace any of the characters ./:[]|*\ with the replacement value specified in the options.

Example
// This example will skip any special processing
options.withAssetNodeNameProcessor((fileName) => {
  return new Promise((resolve) => resolve(fileName));
});
Replacement value for invalid node characters string Specifies the value to use when replacing invalid characters in folder and asset node names. This value is used in the default functions that clean folder/asset names, and is always used when replacing any of the characters ./:[]|*\; the value of this option cannot contain any of those characters. Default: -

For example, assume the folder name My Test Folder #2. With the default settings, the folder's node would be my-test-folder--2.

Example
options.withInvalidCharacterReplaceValue('_');
Upload file options object Specifies the options to use when uploading each file as part of the file system upload. Most of the options provided when using `DirectBinaryUploadOptions.withUploadFiles()` are valid. The exceptions are `fileName`, `fileSize`, `filePath`, and `blob`, which will be ignored.

Example
options.withUploadFileOptions({
  createVersion: true,
  versionLabel: 'version-label'
});

Features

  • Well tuning to take advantage of nodejs for best uploading performance
  • Track transfer progress of files
  • Cancel in-progress transfers
  • Transfer multiple files "in batch"
  • Upload local folder/file structures

Releasing

To publish a new version of the library, follow these steps:

  • Set the version number in package.json to the new version.
  • Push a new commit with the changes and a message that matches the pattern Release (\\S+), where (\\S) is replaced with the updated version number from package.json.
  • Check the repository's actions to see the status of the release.

Todo

  • Pause/resume uploads

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Maintainers