Updated JSON nested operations to properly escape any dynamically created JSONPointer instances.

cwensel · cwensel · commit c1c855782b80 · 2025-02-21T15:25:56.000-08:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -2,6 +2,8 @@ Cascading Change Log
 
 4.6.0 [unreleased]
 
+  Updated JSON nested operations to properly escape any dynamically created JSONPointer instances.
+
   Updated c.t.h.i.TapOutputCollector to initialize the filenamePattern after Tap#sinkConfInit has been called.
 
   Fixed issue where c.t.l.h.LocalHfsAdaptor would not copy back applied properties during source/sink init phase.
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildAsAggregator.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildAsAggregator.java
@@ -31,7 +31,7 @@
 /**
  * Class JSONBuildAsAggregator provides for the ability to create new JSON objects from aggregated tuple values.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedBaseBuildAggregator for more details.
  */
 public class JSONBuildAsAggregator extends NestedBaseBuildAggregator<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildAsFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildAsFunction.java
@@ -31,7 +31,7 @@
 /**
  * Class JSONBuildAsFunction provides for the ability to create new JSON objects from streamed tuple values.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedBaseBuildFunction for more details.
  */
 public class JSONBuildAsFunction extends NestedBaseBuildFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildIntoFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONBuildIntoFunction.java
@@ -31,7 +31,7 @@
 /**
  * Class JSONBuildIntoFunction provides for the ability to update existing JSON objects from streamed tuple values.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedBaseBuildFunction for more details.
  */
 public class JSONBuildIntoFunction extends NestedBaseBuildFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONCopyAsFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONCopyAsFunction.java
@@ -32,7 +32,7 @@
  * Class JSONCopyAsFunction provides for the ability to create new JSON objects from an existing
  * JSON object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedBaseCopyFunction for more details.
  */
 public class JSONCopyAsFunction extends NestedBaseCopyFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONCopyIntoFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONCopyIntoFunction.java
@@ -32,7 +32,7 @@
  * Class JSONCopyIntoFunction provides for the ability to update an existing JSON objects from an existing
  * JSON object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedBaseCopyFunction for more details.
  */
 public class JSONCopyIntoFunction extends NestedBaseCopyFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONCreateFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONCreateFunction.java
@@ -37,7 +37,7 @@
  * will be set on the final JSON object. This is useful for prevent null values from being set, artificially
  * increasing the size of the final object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedCreateFunction for more details.
  */
 public class JSONCreateFunction extends NestedCreateFunction<JsonNode, ArrayNode>
@@ -277,4 +277,11 @@ public JSONCreateFunction( JSONCoercibleType coercibleType, Fields fieldDeclarat
     {
     super( coercibleType, fieldDeclaration, defaultValueFilter, pointerMap );
     }
+
+  @Override
+  protected String escapePointerElement( String element )
+    {
+    // https://datatracker.ietf.org/doc/html/draft-ietf-appsawg-json-pointer-03#section-3
+    return element.replace( "~", "~0" ).replace( "/", "~1" );
+    }
   }
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetAllAggregateFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetAllAggregateFunction.java
@@ -42,7 +42,7 @@
  * <p>
  * See {@link cascading.nested.core.aggregate.SimpleNestedAggregate} for a convenient base implementation.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedGetAllAggregateFunction for more details.
  */
 public class JSONGetAllAggregateFunction extends NestedGetAllAggregateFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetAllFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetAllFunction.java
@@ -36,7 +36,7 @@
  * descent reference, {@code /person/**}{@code /name}. In the later case, use an empty pointer, {@code ""}, to reference
  * the value of the array. Rely on the {@code fieldDeclaration} to coerce this value appropriately.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedGetAllFunction for more details.
  */
 public class JSONGetAllFunction extends NestedGetAllFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONGetFunction.java
@@ -32,7 +32,7 @@
  * Class JSONGetFunction provides the ability to convert a JSON object into a single tuple where each
  * field value is referenced by a Json pointer in the object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedGetFunction for more details.
  */
 public class JSONGetFunction extends NestedGetFunction<JsonNode, ArrayNode>
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONRegexFilter.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONRegexFilter.java
@@ -30,7 +30,7 @@
 /**
  * Class JSONRegexFilter provides for the ability to to filter a tuple stream based on the values in a JSON object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedRegexFilter for more details.
  */
 public class JSONRegexFilter extends NestedRegexFilter
diff --git a/cascading-nested-json/src/main/java/cascading/nested/json/JSONSetFunction.java b/cascading-nested-json/src/main/java/cascading/nested/json/JSONSetFunction.java
@@ -32,7 +32,7 @@
 /**
  * Class JSONSetFunction provides for the ability to simply set multiple tuple values onto an existing JSON object.
  *
- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
  * @see NestedSetFunction for more details.
  */
 public class JSONSetFunction extends NestedSetFunction<JsonNode, ArrayNode>
@@ -145,4 +145,11 @@ public JSONSetFunction( JSONCoercibleType coercibleType, Fields fieldDeclaration
     {
     super( coercibleType, fieldDeclaration, pointerMap );
     }
+
+  @Override
+  protected String escapePointerElement( String element )
+    {
+    // https://datatracker.ietf.org/doc/html/draft-ietf-appsawg-json-pointer-03#section-3
+    return element.replace( "~", "~0" ).replace( "/", "~1" );
+    }
   }
diff --git a/cascading-nested/src/main/java/cascading/nested/core/NestedBaseFunction.java b/cascading-nested/src/main/java/cascading/nested/core/NestedBaseFunction.java
@@ -123,14 +123,19 @@ public void prepare( FlowProcess flowProcess, OperationCall<NestedBaseFunction.C
         {
         Fields argument = iterator.next();
 
-        Pointer<Node> pointer = compiler.compile( rootPointer + "/" + argument.get( 0 ).toString() );
+        Pointer<Node> pointer = compiler.compile( rootPointer + "/" + escapePointerElement( argument.get( 0 ).toString() ) );
         resolvedPointers.put( argument, new Pair<>( defaultValueFilter, pointer ) );
         }
       }
 
     operationCall.setContext( new Context( resolvedPointers, Tuple.size( 1 ) ) );
     }
 
+  protected String escapePointerElement( String element )
+    {
+    return element;
+    }
+
   @Override
   public void operate( FlowProcess flowProcess, FunctionCall<NestedBaseFunction.Context> functionCall )
     {

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`/**`
`32`	`32`	`* Class JSONBuildAsAggregator provides for the ability to create new JSON objects from aggregated tuple values.`
`33`	`33`	`*`
`34`		`- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
	`34`	`+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
`35`	`35`	`* @see NestedBaseBuildAggregator for more details.`
`36`	`36`	`*/`
`37`	`37`	`public class JSONBuildAsAggregator extends NestedBaseBuildAggregator<JsonNode, ArrayNode>`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`* Class JSONCopyAsFunction provides for the ability to create new JSON objects from an existing`
`33`	`33`	`* JSON object.`
`34`	`34`	`*`
`35`		`- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
	`35`	`+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
`36`	`36`	`* @see NestedBaseCopyFunction for more details.`
`37`	`37`	`*/`
`38`	`38`	`public class JSONCopyAsFunction extends NestedBaseCopyFunction<JsonNode, ArrayNode>`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`* will be set on the final JSON object. This is useful for prevent null values from being set, artificially`
`38`	`38`	`* increasing the size of the final object.`
`39`	`39`	`*`
`40`		`- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
	`40`	`+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
`41`	`41`	`* @see NestedCreateFunction for more details.`
`42`	`42`	`*/`
`43`	`43`	`public class JSONCreateFunction extends NestedCreateFunction<JsonNode, ArrayNode>`
`@@ -277,4 +277,11 @@ public JSONCreateFunction( JSONCoercibleType coercibleType, Fields fieldDeclarat`
`277`	`277`	`{`
`278`	`278`	`super( coercibleType, fieldDeclaration, defaultValueFilter, pointerMap );`
`279`	`279`	`}`
	`280`	`+`
	`281`	`+ @Override`
	`282`	`+ protected String escapePointerElement( String element )`
	`283`	`+ {`
	`284`	`+ // https://datatracker.ietf.org/doc/html/draft-ietf-appsawg-json-pointer-03#section-3`
	`285`	`+ return element.replace( "~", "~0" ).replace( "/", "~1" );`
	`286`	`+ }`
`280`	`287`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`* <p>`
`43`	`43`	`* See {@link cascading.nested.core.aggregate.SimpleNestedAggregate} for a convenient base implementation.`
`44`	`44`	`*`
`45`		`- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
	`45`	`+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
`46`	`46`	`* @see NestedGetAllAggregateFunction for more details.`
`47`	`47`	`*/`
`48`	`48`	`public class JSONGetAllAggregateFunction extends NestedGetAllAggregateFunction<JsonNode, ArrayNode>`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`* descent reference, {@code /person/**}{@code /name}. In the later case, use an empty pointer, {@code ""}, to reference`
`37`	`37`	`* the value of the array. Rely on the {@code fieldDeclaration} to coerce this value appropriately.`
`38`	`38`	`*`
`39`		`- * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
	`39`	`+ * @see <a href="https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>`
`40`	`40`	`* @see NestedGetAllFunction for more details.`
`41`	`41`	`*/`
`42`	`42`	`public class JSONGetAllFunction extends NestedGetAllFunction<JsonNode, ArrayNode>`