feat: Allow user to specify processing wait and retry parameters

Author: trodrigues

lib/entities/asset.js

@@ -37,28 +37,42 @@ const ASSET_PROCESSING_CHECK_RETRIES = 5
  */
 
 function createAssetApi (http) {
-  function checkIfAssetHasUrl (resolve, reject, id, locale, checkCount = 0) {
+  function checkIfAssetHasUrl ({
+    resolve,
+    reject,
+    id,
+    locale,
+    processingCheckWait = ASSET_PROCESSING_CHECK_WAIT,
+    processingCheckRetries = ASSET_PROCESSING_CHECK_RETRIES,
+    checkCount = 0
+  }) {
     http.get('assets/' + id)
     .then((response) => wrapAsset(http, response.data), errorHandler)
     .then((asset) => {
       if (asset.fields.file[locale].url) {
         resolve(asset)
-      } else if (checkCount === ASSET_PROCESSING_CHECK_RETRIES) {
+      } else if (checkCount === processingCheckRetries) {
         const error = new Error()
         error.name = 'AssetProcessingTimeout'
         error.message = 'Asset is taking longer then expected to process.'
         reject(error)
       } else {
         checkCount++
         setTimeout(
-          () => checkIfAssetHasUrl(resolve, reject, id, locale, checkCount),
-          ASSET_PROCESSING_CHECK_WAIT
+          () => checkIfAssetHasUrl({
+            resolve: resolve,
+            reject: reject,
+            id: id,
+            locale: locale,
+            checkCount: checkCount
+          }),
+          processingCheckWait
         )
       }
     })
   }
 
-  function processForLocale (locale) {
+  function processForLocale (locale, {processingCheckWait, processingCheckRetries} = {}) {
     const assetId = this.sys.id
     return http.put('assets/' + this.sys.id + '/files/' + locale + '/process', null, {
       headers: {
@@ -67,15 +81,22 @@ function createAssetApi (http) {
     })
     .then(() => {
       return new Promise(
-        (resolve, reject) => checkIfAssetHasUrl(resolve, reject, assetId, locale)
+        (resolve, reject) => checkIfAssetHasUrl({
+          resolve: resolve,
+          reject: reject,
+          id: assetId,
+          locale: locale,
+          processingCheckWait: processingCheckWait,
+          processingCheckRetries: processingCheckRetries
+        })
       )
     }, errorHandler)
   }
 
-  function processForAllLocales () {
+  function processForAllLocales (options = {}) {
     const self = this
     const locales = Object.keys(this.fields.file)
-    return Promise.all(locales.map((locale) => processForLocale.call(self, locale)))
+    return Promise.all(locales.map((locale) => processForLocale.call(self, locale, options)))
     .then((assets) => assets[0])
   }
 
@@ -175,6 +196,9 @@ function createAssetApi (http) {
      * @memberof Asset
      * @func processForLocale
      * @param {string} locale - Locale which processing should be triggered for
+     * @param {object} options - Additional options for processing
+     * @prop {number} options.processingCheckWait - Time in milliseconds to wait before checking again if the asset has been processed (default: 500ms)
+     * @prop {number} options.processingCheckRetries - Maximum amount of times to check if the asset has been processed (default: 5)
      * @return {Promise<Asset>} Object returned from the server with updated metadata.
      * @throws {AssetProcessingTimeout} If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
      * @example
@@ -187,6 +211,9 @@ function createAssetApi (http) {
      * Triggers asset processing after an upload, for the files uploaded to all locales of an asset.
      * @memberof Asset
      * @func processForAllLocales
+     * @param {object} options - Additional options for processing
+     * @prop {number} options.processingCheckWait - Time in milliseconds to wait before checking again if the asset has been processed (default: 500ms)
+     * @prop {number} options.processingCheckRetries - Maximum amount of times to check if the asset has been processed (default: 5)
      * @return {Promise<Asset>} Object returned from the server with updated metadata.
      * @throws {AssetProcessingTimeout} If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
      * @example