jslt-152: parse-url error handling control

core/src/main/java/com/schibsted/spt/data/jslt/impl/BuiltinFunctions.java

@@ -1265,16 +1265,18 @@ else if (ComparisonOperator.compare(arguments[0], arguments[1], null) > 0)
   // ===== PARSE-URL
 
   public static class ParseUrl extends AbstractFunction {
-    public ParseUrl() { super("parse-url", 1,1);}
+    public ParseUrl() { super("parse-url", 1, 2); }
 
     public JsonNode call(JsonNode input, JsonNode[] arguments) {
-      if (arguments[0].isNull())
+      if (arguments.length < 1 || arguments[0].isNull())
         return NullNode.instance;
 
       String urlString = arguments[0].asText();
+      boolean throwOnFailure = arguments.length < 2 || arguments[1].asBoolean();
 
       try {
-        URL aURL = new URL(arguments[0].asText());
+
+        URL aURL = new URL(urlString);
         final ObjectNode objectNode = NodeUtils.mapper.createObjectNode();
         if (aURL.getHost() != null && !aURL.getHost().isEmpty())
           objectNode.put("host", aURL.getHost());
@@ -1303,8 +1305,17 @@ public JsonNode call(JsonNode input, JsonNode[] arguments) {
         if(aURL.getUserInfo() != null && !aURL.getUserInfo().isEmpty())
           objectNode.put("userinfo", aURL.getUserInfo());
         return objectNode;
-      } catch (MalformedURLException | UnsupportedEncodingException e) {
-        throw new JsltException("Can't parse " + urlString, e);
+      } catch (Exception e) {
+        if (throwOnFailure) {
+          throw new JsltException("Can't parse " + urlString, e);
+        } else {
+          final ObjectNode errorNode = NodeUtils.mapper.createObjectNode();
+          final Class errorClass = e.getClass();
+          errorNode.put("error", errorClass.getName());
+          errorNode.put("message", e.getMessage());
+          errorNode.put("input", urlString);
+          return errorNode;
+        }
       }
     }
   }

core/src/test/resources/query-tests.yaml

@@ -460,3 +460,36 @@ tests:
         "port": 8443,
         "scheme": "https"
       }
+
+# parse-url tests with throwOnFailure set to true should behave as above
+
+  - input:
+    query: parse-url("https://example.com:8443", true)
+    output: |
+      {
+        "host": "example.com",
+        "port": 8443,
+        "scheme": "https"
+      }
+
+# parse-url tests with throwOnFailure set to false should behave as above for good cases
+
+  - input:
+    query: parse-url("https://example.com:8443", false)
+    output: |
+      {
+        "host": "example.com",
+        "port": 8443,
+        "scheme": "https"
+      }
+
+# parse-url tests with throwOnFailure set to false should return an error object for bad cases
+
+  - input:
+    query: parse-url("this-is-an-invalid-url", false)
+    output: |
+      {
+        "error": "java.net.MalformedURLException",
+        "message": "no protocol: this-is-an-invalid-url",
+        "input": "this-is-an-invalid-url"
+      }

functions.md

@@ -826,10 +826,42 @@ format-time(null, "yyyy-MM-dd")                  => null
 
 ## Miscellaneous functions
 
-### _parse-url(url) -> object_
+### _parse-url(url, throwOnFailure?) -> object_
 
 Parses `url` and returns an object with keys [`scheme`, `userinfo`, `host`, `port` `path`, `query`, `parameters`, `fragment` ]
 
+If the optional `throwOnFailure` argument is not specified invalid URLs will generate an exception. If `throwOnFailure` is set to `false` the `parse-url` returns
+an object indicating an error occurred.
+
+#### Example of valid URL response
+
+```json
+{
+  "host": "example.com",
+  "port": 8080,
+  "path": "/examples/",
+  "scheme": "https",
+  "query": "x=1&y=",
+  "parameters": {
+    "x": ["1"],
+    "y": [null]
+  },
+  "fragment": "footer",
+  "userinfo": "myname:mypwd"
+}
+```
+
+#### Example of invalid URL response with throwOnFailure=false
+
+```json
+{
+  "error": "java.net.MalformedURLException",
+  "message": "no protocol: this-is-an-invalid-url",
+  "input": "this-is-an-invalid-url"
+}
+```
+
+#### Examples
 ```
 parse-url("http://example.com").scheme => "http"
 parse-url("http://example.com").host => "example.com"
@@ -841,4 +873,8 @@ parse-url("https://www.example.com/?aa=1&aa=2&bb=&cc").parameters.bb =>  [null]
 parse-url("https://www.example.com/?aa=1&aa=2&bb=&cc").parameters.cc =>  [null]
 parse-url("ftp://username:password@host.com/").userinfo => "username:password"
 parse-url("https://example.com:8443").port => 8443
+
+parse-url("this-is-an-invalid-url", false).error => "java.net.MalformedURLException"
+parse-url("this-is-an-invalid-url", false).message => "no protocol: this-is-an-invalid-url"
+parse-url("this-is-an-invalid-url", false).input => "this-is-an-invalid-url"
 ```