docfx v3 - Newtonsoft.Json

[VaclavElias]

Any reason you are using Newtonsoft.Json? It seems to be used only in one method. Any reason not to use System.Text.Json?

docfx/src/Microsoft.Docs.MarkdigExtensions/CodeSnippet/HtmlCodeSnippetRenderer.cs

Lines 307 to 346 in 0bfc8b7

	private string GetNoteBookContent(string content, string tagName, CodeSnippet obj)
	{
	JObject contentObject = null;
	try
	{
	contentObject = JObject.Parse(content);
	}
	catch (JsonReaderException ex)
	{
	_context.LogError("not-notebook-content", "Not a valid Notebook. " + ex.ToString(), obj);
	return "";
	}
	var sourceJsonPath = $"$..cells[?(@.metadata.name=='{tagName}')].source";
	JToken sourceObject = null;
	try
	{
	sourceObject = contentObject.SelectToken(sourceJsonPath);
	}
	catch (JsonException)
	{
	_context.LogError("multiple-tags-with-same-name", $"Multiple entries with the name '{tagName}' where found in the notebook.", obj);
	return "";
	}
	if (sourceObject == null)
	{
	_context.LogError("tag-not-found", $"The name '{tagName}' is not present in the notebook file.", obj);
	return "";
	}
	var showCode = new StringBuilder();
	var lines = ((JArray)sourceObject).ToObject<string[]>();
	for (var i = 0; i < lines.Length; i++)
	{
	showCode.Append(lines[i]);
	}
	return showCode.ToString();
	}

[KalleOlaviNiemitalo]

AFAIK, System.Text.Json does not implement JSON Path used in the contentObject.SelectToken(sourceJsonPath) call. I don't see such a method in JsonElement Struct.

[KalleOlaviNiemitalo]

dotnet/runtime#31068 is a request to implement JsonPath queries in System.Text.Json, quite popular, but not going to be in .NET 7.

[paulushub]

If I understand his concern well as expressed in It seems to be used only in one method, this is a specific query and does not really require that much of JSON support to implement.
Moreover, most .NET documentation projects do not need or use Notebook support.

[KalleOlaviNiemitalo]

git grep -l -F 'Newtonsoft.Json' 3.0.0-beta1.1235+f5a62adcac -- "src/*.cs" | wc -l finds 116 files; the same for System.Text.Json finds 5 files. Before #7773, the numbers were 119 and 4. So, there has been some progress towards System.Text.Json but Newtonsoft.Json still has the majority. If the notebook feature is rarely used, I suppose porting it is not important for performance.

[VaclavElias]

git grep -l -F 'Newtonsoft.Json' 3.0.0-beta1.1235+f5a62adcac -- "src/*.cs" | wc -l finds 116 files; the same for System.Text.Json finds 5 files. Before #7773, the numbers were 119 and 4. So, there has been some progress towards System.Text.Json but Newtonsoft.Json still has the majority. If the notebook feature is rarely used, I suppose porting it is not important for performance.

Thanks. It seems I should improve my search capabilities 🤦‍♂️🤣. I was just surprised that v3 being so long in development is still using Newtonsoft.Json but as you pointed out, there are some blockers.

Thanks for your comments everyone.

[yufeih]

When we were building the JSON pipeline for v3, System.Text.Json was very immature.

Today the biggest blocker to move to System.Text.Json is the propagation of line info. We rely on this propagation mechanism to report detailed diagnostic locations for YAML files. With Newtonsoft.Json, we can attach custom source info to JToken and deserialize it into Source<T> with a custom JsonConverter. There doesn't seem to be a straightforward way of achieving the same in System.Text.Json.

[paulushub]

Today the biggest blocker to move to System.Text.Json is the propagation of line info.

Too bad, many efforts were made but @layomia did not see the need for this still - it seems MS needs developers with real-world experience to manage its products.

dotnet/runtime#50629
dotnet/runtime#47689