Add support for remote/local function invocation (fn:remote and fn:wasm) (#261)

Author: RTLcoil

lib-es5/utils/index.js

@@ -209,6 +209,23 @@ function normalize_expression(expression) {
   return expression.replace(/[ _]+/g, '_');
 }
 
+/**
+ * Parse custom_function options
+ * @private
+ * @param {object|*} customFunction a custom function object containing function_type and source values
+ * @return {string|*} custom_function transformation string
+ */
+function process_custom_function(customFunction) {
+  if (!isObject(customFunction)) {
+    return customFunction;
+  }
+  if (customFunction.function_type === "remote") {
+    return [customFunction.function_type, base64EncodeURL(customFunction.source)].join(":");
+  } else {
+    return [customFunction.function_type, customFunction.source].join(":");
+  }
+}
+
 /**
  * Parse "if" parameter
  * Translates the condition if provided.
@@ -530,6 +547,7 @@ function generate_transformation_string(options) {
   var underlay = process_layer(utils.option_consume(options, "underlay"));
   var ifValue = process_if(utils.option_consume(options, "if"));
   var fps = utils.option_consume(options, 'fps');
+  var custom_function = process_custom_function(utils.option_consume(options, "custom_function"));
   if (isArray(fps)) {
     fps = fps.join('-');
   }
@@ -543,6 +561,7 @@ function generate_transformation_string(options) {
     dpr: normalize_expression(dpr),
     e: normalize_expression(effect),
     fl: flags,
+    fn: custom_function,
     fps: fps,
     h: normalize_expression(height),
     ki: normalize_expression(utils.option_consume(options, "keyframe_interval")),

lib/utils/index.js

@@ -201,6 +201,23 @@ function normalize_expression(expression) {
   return expression.replace(/[ _]+/g, '_');
 }
 
+/**
+ * Parse custom_function options
+ * @private
+ * @param {object|*} customFunction a custom function object containing function_type and source values
+ * @return {string|*} custom_function transformation string
+ */
+function process_custom_function(customFunction) {
+  if (!isObject(customFunction)) {
+    return customFunction;
+  }
+  if (customFunction.function_type === "remote") {
+    return [customFunction.function_type, base64EncodeURL(customFunction.source)].join(":");
+  } else {
+    return [customFunction.function_type, customFunction.source].join(":");
+  }
+}
+
 /**
  * Parse "if" parameter
  * Translates the condition if provided.
@@ -525,6 +542,7 @@ function generate_transformation_string(options) {
   let overlay = process_layer(utils.option_consume(options, "overlay"));
   let underlay = process_layer(utils.option_consume(options, "underlay"));
   let ifValue = process_if(utils.option_consume(options, "if"));
+  let custom_function = process_custom_function(utils.option_consume(options, "custom_function"));
   let fps = utils.option_consume(options, 'fps');
   if (isArray(fps)) {
     fps = fps.join('-');
@@ -539,6 +557,7 @@ function generate_transformation_string(options) {
     dpr: normalize_expression(dpr),
     e: normalize_expression(effect),
     fl: flags,
+    fn: custom_function,
     fps: fps,
     h: normalize_expression(height),
     ki: normalize_expression(utils.option_consume(options, "keyframe_interval")),

test/cloudinary_spec.js

@@ -421,6 +421,78 @@ describe("cloudinary", function () {
       signature: "123515adfa151",
     })).to.eql("image/upload/v1251251251/abcd.jpg#123515adfa151");
   });
+  it('should support custom function of type wasm with a source', function () {
+    var options, result;
+    options = {
+      custom_function: {function_type: 'wasm', source: 'blur.wasm'}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_wasm:blur.wasm/test");
+  });
+  it('should support arbitrary custom function types', function () {
+    var options, result;
+    options = {
+      custom_function: {function_type: 'amazing', source: 'awesome'}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_amazing:awesome/test");
+  });
+  it('should support custom function with no source', function () {
+    var options, result;
+    options = {
+      custom_function: {function_type: 'wasm'}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_wasm:/test");
+  });
+  it('should support custom function with no function_type', function () {
+    var options, result;
+    options = {
+      custom_function:  {source: 'blur.wasm'}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_:blur.wasm/test");
+  });
+  it('should support custom function that is not an object', function () {
+    var options, result;
+    options = {
+      custom_function: []
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_:/test");
+  });
+  it('should support custom function with no function_type or source', function () {
+    var options, result;
+    options = {
+      custom_function: {}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_:/test");
+  });
+  it('should support custom function of type remote', function() {
+    var options, result;
+    options = {
+      custom_function: {function_type: 'remote', source: 'https://df34ra4a.execute-api.us-west-2.amazonaws.com/default/cloudinaryFunction'}
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/fn_remote:aHR0cHM6Ly9kZjM0cmE0YS5leGVjdXRlLWFwaS51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS9kZWZhdWx0L2Nsb3VkaW5hcnlGdW5jdGlvbg==/test");
+  });
+  it('should should not include custom function with undefined value', function() {
+    var options, result;
+    options = {
+      custom_function: undefined
+    };
+    result = cloudinary.utils.url("test", options);
+    expect(options).to.eql({});
+    expect(result).to.eql("http://res.cloudinary.com/test123/image/upload/test");
+  });
   it("should support density", function () {
     var options, result;
     options = {