avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Brandon Forehand (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AVRO-1546) Make GenericData.Record.toString consistent
Date Thu, 17 Jul 2014 21:48:05 GMT

     [ https://issues.apache.org/jira/browse/AVRO-1546?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Brandon Forehand updated AVRO-1546:
-----------------------------------

    Description: 
Currently, if you have a GenericData.Record and call toString on it, it provides a JSON representation
of this record type. However, if the record contains a string that contains a literal forward
slash, the forward slash gets escaped by the writeEscapedString function which means that
the string representation is not equivalent after round-tripping the value.

According to the [ECMA standard for JSON|http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf],
forward slash can be escaped; however, the values {{"\u002F"}}, {{"\u002f"}}, {{"\/"}}, and
{{"/"}} are all the same. Thus, it seems preferable to produce the shortest version. This
is the way that Jackson works as well:

{code}
JsonMapper mapper = new JsonMapper();
JsonFactory factory = new JsonFactory();
JsonNode node = mapper.readTree(factory.createJsonParser("\"/path/\""));
mapper.readValue(node, String.class); // => "/path/"

node = mapper.readTree(factory.createJsonParser("\"\/path\/\"");
mapper.readValue(node, String.class); // => "/path/"
{code}

This shows that whether or not the input is escaped that the JSON output produced in both
cases is the unescaped forward slash.

  was:
Currently, if you have a GenericData.Record and call toString on it, it provides a JSON representation
of this record type. However, if the record contains a string that contains a literal forward
slash, the forward slash gets escaped by the writeEscapedString function which means that
the string representation is not equivalent after round-tripping the value.

According to the [ECMA standard for JSON|http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf],
forward slash can be escaped; however, the values {{"\u002F"}}, {{"\u002f"}}, {{"\/"}}, and
{{"/"}} are all the same. Thus, it seems to preferable to produce the shortest version. This
is the way that Jackson works as well:

{code}
JsonMapper mapper = new JsonMapper();
JsonFactory factory = new JsonFactory();
JsonNode node = mapper.readTree(factory.createJsonParser("\"/path/\""));
mapper.readValue(node, String.class); // => "/path/"

node = mapper.readTree(factory.createJsonParser("\"\/path\/\"");
mapper.readValue(node, String.class); // => "/path/"
{code}

This shows that whether or not the input is escaped that the JSON output produced in both
cases is the unescaped forward slash.


> Make GenericData.Record.toString consistent
> -------------------------------------------
>
>                 Key: AVRO-1546
>                 URL: https://issues.apache.org/jira/browse/AVRO-1546
>             Project: Avro
>          Issue Type: Bug
>          Components: java
>    Affects Versions: 1.7.6
>            Reporter: Brandon Forehand
>            Priority: Minor
>         Attachments: unescape_slash.patch
>
>
> Currently, if you have a GenericData.Record and call toString on it, it provides a JSON
representation of this record type. However, if the record contains a string that contains
a literal forward slash, the forward slash gets escaped by the writeEscapedString function
which means that the string representation is not equivalent after round-tripping the value.
> According to the [ECMA standard for JSON|http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf],
forward slash can be escaped; however, the values {{"\u002F"}}, {{"\u002f"}}, {{"\/"}}, and
{{"/"}} are all the same. Thus, it seems preferable to produce the shortest version. This
is the way that Jackson works as well:
> {code}
> JsonMapper mapper = new JsonMapper();
> JsonFactory factory = new JsonFactory();
> JsonNode node = mapper.readTree(factory.createJsonParser("\"/path/\""));
> mapper.readValue(node, String.class); // => "/path/"
> node = mapper.readTree(factory.createJsonParser("\"\/path\/\"");
> mapper.readValue(node, String.class); // => "/path/"
> {code}
> This shows that whether or not the input is escaped that the JSON output produced in
both cases is the unescaped forward slash.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message