JsonNode.GetPath() doesn't consider character escaping

[gregsdennis]

Description

The JsonNode.GetPath() generally does well for C#-valid property names, but any string is valid as a key in JSON, and when a key has characters that need escaping, nothing happens and you get an invalid (unparsable) JSON Path as a result.

Reproduction Steps

JsonNode.Parse("""{"$defs":{"foo['bar":"baz"}}""")["$defs"]["foo['bar"].GetPath();

Expected behavior

Returns $.$defs['foo[\'bar'].

Returns $['$defs']['foo[\'bar'].

• The single quote needs to be escaped.
• $defs is not valid as a shorthand property name, so it needs to be in bracketed syntax.

Actual behavior

Returns $.$defs['foo['bar'].

Regression?

Unknown

Known Workarounds

None.

Configuration

Seems to happen everywhere. dotnetfiddle, Linux.

Will update with more details in a comment.

Other information

Originally reported json-everything/json-everything#406.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-text-json, @gregsdennis
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

The JsonNode.GetPath() generally does well for C#-valid property names, but any string is valid as a key in JSON, and when a key has characters that need escaping, nothing happens and you get an invalid (unparsable) JSON Path as a result.

Reproduction Steps

JsonNode.Parse("""{"$defs":{"foo['bar":"baz"}}""")["$defs"]["foo['bar"].GetPath();

Expected behavior

Returns $.$defs['foo[\'bar'].

Actual behavior

Returns $.$defs['foo['bar'].

Regression?

Unknown

Known Workarounds

None.

Configuration

Seems to happen everywhere. dotnetfiddle, Linux.

Will update with more details in a comment.

Other information

Originally reported json-everything/json-everything#406.

Author:	gregsdennis
Assignees:	-
Labels:	area-System.Text.Json, untriaged
Milestone:	-

[amis92]

The specific source code in question is the following:

runtime/src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonObject.cs

Lines 131 to 138 in a396d6e

	if (propertyName.AsSpan().ContainsSpecialCharacters())
	{
	path.Add($"['{propertyName}']");
	}
	else
	{
	path.Add($".{propertyName}");
	}

While it actively looks for special characters to use indexer syntax (['xyz']) instead of shorthand (.foo), it does not attempt to escape the apostrophe '.

[gregsdennis]

I should also mention that perhaps JSON Path is the wrong syntax to use for identifying a single location within a JSON tree. JSON Pointer is more well-suited for that.

[gregsdennis]

☝️ I'm adding .GetPathFromRoot() and .GetPointerFromRoot() to my Json.More.Net library to support this until it's in the runtime.