move ParserServer from Documents to dotnet-interactive

dotnet · Jun 13, 2023 · c8a6492 · c8a6492
1 parent dd7b287
commit c8a6492
Show file tree

Hide file tree

Showing 37 changed files with 241 additions and 292 deletions.
diff --git a/...ive.ApiCompatibility.Tests/ApiCompatibilityTests.Document_api_is_not_changed.approved.txt b/...ive.ApiCompatibility.Tests/ApiCompatibilityTests.Document_api_is_not_changed.approved.txt
@@ -98,49 +98,3 @@ Microsoft.DotNet.Interactive.Documents.Jupyter
     public static System.Void Write(Microsoft.DotNet.Interactive.Documents.InteractiveDocument document, System.IO.Stream stream, Microsoft.DotNet.Interactive.Documents.KernelInfoCollection kernelInfos)
     public static System.Void Write(Microsoft.DotNet.Interactive.Documents.InteractiveDocument document, System.IO.TextWriter writer)
     public static System.Void Write(Microsoft.DotNet.Interactive.Documents.InteractiveDocument document, System.IO.TextWriter writer, Microsoft.DotNet.Interactive.Documents.KernelInfoCollection kernelInfos)
-Microsoft.DotNet.Interactive.Documents.ParserServer
-  public enum DocumentSerializationType : System.Enum, System.IComparable, System.IConvertible, System.IFormattable
-    Dib=0
-    Ipynb=1
-  public class NotebookErrorResponse : NotebookParserServerResponse
-    .ctor(System.String id, System.String errorMessage)
-    public System.String ErrorMessage { get;}
-  public abstract class NotebookParseOrSerializeRequest
-    public static NotebookParseOrSerializeRequest FromJson(System.String json)
-    public System.String DefaultLanguage { get;}
-    public System.String Id { get;}
-    public DocumentSerializationType SerializationType { get;}
-    public RequestType Type { get;}
-  public class NotebookParseRequest : NotebookParseOrSerializeRequest
-    .ctor(System.String id, DocumentSerializationType serializationType, System.String defaultLanguage, System.Byte[] rawData)
-    public System.Byte[] RawData { get;}
-    public RequestType Type { get;}
-  public class NotebookParseResponse : NotebookParserServerResponse
-    .ctor(System.String id, Microsoft.DotNet.Interactive.Documents.InteractiveDocument document)
-    public Microsoft.DotNet.Interactive.Documents.InteractiveDocument Document { get;}
-  public class NotebookParserServer, System.IDisposable
-    public static NotebookParserServerResponse HandleRequest(NotebookParseOrSerializeRequest request)
-    .ctor(System.IO.TextReader input, System.IO.TextWriter output)
-    public System.IO.TextReader Input { get;}
-    public System.IO.TextWriter Output { get;}
-    public System.Void Dispose()
-    public System.Threading.Tasks.Task RunAsync()
-  public static class NotebookParserServerExtensions
-    public static System.String ToJson()
-    public static System.String ToJson()
-  public abstract class NotebookParserServerResponse
-    public static NotebookParserServerResponse FromJson(System.String json)
-    public System.String Id { get;}
-  public class NotebookSerializeRequest : NotebookParseOrSerializeRequest
-    .ctor(System.String id, DocumentSerializationType serializationType, System.String defaultLanguage, System.String newLine, Microsoft.DotNet.Interactive.Documents.InteractiveDocument document)
-    public Microsoft.DotNet.Interactive.Documents.InteractiveDocument Document { get;}
-    public System.String NewLine { get;}
-    public RequestType Type { get;}
-  public class NotebookSerializeResponse : NotebookParserServerResponse
-    .ctor(System.String id, System.Byte[] rawData)
-    public System.Byte[] RawData { get;}
-  public static class ParserServerSerializer
-    public static System.Text.Json.JsonSerializerOptions JsonSerializerOptions { get;}
-  public enum RequestType : System.Enum, System.IComparable, System.IConvertible, System.IFormattable
-    Parse=0
-    Serialize=1
diff --git a/src/Microsoft.DotNet.Interactive.Documents.Tests/CodeSubmissionFormatTests.cs b/src/Microsoft.DotNet.Interactive.Documents.Tests/CodeSubmissionFormatTests.cs
@@ -536,12 +536,12 @@ public async Task dib_file_can_be_round_tripped_through_read_and_write_without_t
 
     private static string GetDibContent(Dictionary<string, object> metadata)
     {
-        if (metadata == null)
+        if (metadata is null)
         {
             throw new ArgumentNullException(nameof(metadata));
         }
 
-        var serializedMetadata = JsonSerializer.Serialize(metadata, ParserServer.ParserServerSerializer.JsonSerializerOptions);
+        var serializedMetadata = JsonSerializer.Serialize(metadata, App.ParserServer.ParserServerSerializer.JsonSerializerOptions);
 
         return $@"#!meta
 

diff --git a/...Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_ObjectInterface.cs b/...Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_ObjectInterface.cs
@@ -6,7 +6,7 @@
 using System.Linq;
 using System.Text;
 using FluentAssertions;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
+using Microsoft.DotNet.Interactive.App.ParserServer;
 using Newtonsoft.Json;
 
 using Xunit;

diff --git a/...arserServerTests_Serialization.NotebookErrorResponse_serialization_contract.approved.json b/...arserServerTests_Serialization.NotebookErrorResponse_serialization_contract.approved.json
diff --git a/src/Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_Serialization.cs b/src/Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_Serialization.cs
@@ -8,7 +8,7 @@
 using Assent;
 using FluentAssertions;
 using FluentAssertions.Execution;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
+using Microsoft.DotNet.Interactive.App.ParserServer;
 using Xunit;
 
 namespace Microsoft.DotNet.Interactive.Documents.Tests;
@@ -77,16 +77,6 @@ public void NotebookSerializeResponse_serialization_contract()
         this.Assent(json, _configuration);
     }
 
-    [Fact]
-    public void NotebookErrorResponse_serialization_contract()
-    {
-        var response = new NotebookErrorResponse("the-id", "some error message");
-
-        var json = response.ToJson();
-
-        this.Assent(json, _configuration);
-    }
-
     private string GetTestFileContents(string extension = "json", [CallerFilePath] string thisFilePath = null, [CallerMemberName] string testName = null)
     {
         var fileName = $"{GetType().Name}.{testName}.approved.{extension}";

diff --git a/src/Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_TextInterface.cs b/src/Microsoft.DotNet.Interactive.Documents.Tests/NotebookParserServerTests_TextInterface.cs
@@ -7,7 +7,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using FluentAssertions;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
+using Microsoft.DotNet.Interactive.App.ParserServer;
 using Nerdbank.Streams;
 using Pocket;
 using Xunit;

diff --git a/src/Microsoft.DotNet.Interactive.Documents/CodeSubmission.cs b/src/Microsoft.DotNet.Interactive.Documents/CodeSubmission.cs
@@ -8,7 +8,6 @@
 using System.Text;
 using System.Text.Json;
 using System.Threading.Tasks;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
 using Microsoft.DotNet.Interactive.Documents.Utility;
 using Microsoft.DotNet.Interactive.Utility;
 
@@ -53,7 +52,7 @@ public static InteractiveDocument Parse(
 
                 var metadataString = sb.ToString();
 
-                metadata = JsonSerializer.Deserialize<Dictionary<string, object>>(metadataString, ParserServerSerializer.JsonSerializerOptions);
+                metadata = JsonSerializer.Deserialize<Dictionary<string, object>>(metadataString, InteractiveDocument.JsonSerializerOptions);
 
                 if (InteractiveDocument.TryGetKernelInfoFromMetadata(metadata, out var kernelInfoFromMetadata))
                 {
@@ -170,7 +169,7 @@ public static string ToCodeSubmissionContent(
         {
             lines.Add($"{MagicCommandPrefix}meta");
             lines.Add("");
-            lines.Add(JsonSerializer.Serialize(document.Metadata, ParserServerSerializer.JsonSerializerOptions));
+            lines.Add(JsonSerializer.Serialize(document.Metadata, InteractiveDocument.JsonSerializerOptions));
             lines.Add("");
         }
 
@@ -226,4 +225,4 @@ public static void Write(InteractiveDocument document, TextWriter writer, Kernel
         InteractiveDocument.MergeKernelInfos(document, kernelInfos);
         Write(document, writer, newline);
     }
-}
+}
diff --git a/src/Microsoft.DotNet.Interactive.Documents/InteractiveDocument.cs b/src/Microsoft.DotNet.Interactive.Documents/InteractiveDocument.cs
@@ -10,17 +10,37 @@
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
+using System.Text.Encodings.Web;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
+using Microsoft.DotNet.Interactive.Documents.Json;
 using Microsoft.DotNet.Interactive.Documents.Jupyter;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
 using Microsoft.DotNet.Interactive.Documents.Utility;
 using Microsoft.DotNet.Interactive.Utility;
 
 namespace Microsoft.DotNet.Interactive.Documents;
 
 public class InteractiveDocument : IEnumerable
 {
+    static InteractiveDocument()
+    {
+        JsonSerializerOptions = new JsonSerializerOptions
+        {
+            WriteIndented = false,
+            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+            NumberHandling = JsonNumberHandling.AllowReadingFromString | JsonNumberHandling.AllowNamedFloatingPointLiterals,
+            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
+            Converters =
+            {
+                new ByteArrayConverter(),
+                new DataDictionaryConverter(),
+                new JsonStringEnumConverter(JsonNamingPolicy.CamelCase),
+                new InteractiveDocumentConverter(),
+            }
+        };
+    }
+
     private static Parser? _importFieldsParser;
     private static Argument<FileInfo>? _importedFileArgument;
 
@@ -254,15 +274,15 @@ internal static bool TryGetKernelInfoFromMetadata(
             if (metadata.TryGetValue("kernelInfo", out var kernelInfoObj) )
             {
                 if (kernelInfoObj is JsonElement kernelInfoJson &&
-                    kernelInfoJson.Deserialize<KernelInfoCollection>(ParserServerSerializer.JsonSerializerOptions) is
+                    JsonSerializer.Deserialize<KernelInfoCollection>(kernelInfoJson, JsonSerializerOptions) is
                         { } kernelInfoDeserialized)
                 {
                     kernelInfo = kernelInfoDeserialized;
                     return true;
                 }
 
                 // todo: the kernelInfo should not deserialize as a dictionary
-                if (kernelInfoObj is Dictionary<string,object> kernelInfoAsDictionary)
+                if (kernelInfoObj is Dictionary<string, object> kernelInfoAsDictionary)
                 {
                     var deserializedKernelInfo  = new KernelInfoCollection();
                     if (kernelInfoAsDictionary.TryGetValue("defaultKernelName", out var defaultKernelNameObj) &&
@@ -272,11 +292,11 @@ internal static bool TryGetKernelInfoFromMetadata(
                     }
 
                     if (kernelInfoAsDictionary.TryGetValue("items",
-                            out var items))
+                                                           out var items))
                     {
                         if (items is IEnumerable<object> itemList)
                         {
-                            foreach (var item in itemList.Cast<IDictionary<string,object>>())
+                            foreach (var item in itemList.Cast<IDictionary<string, object>>())
                             {
                                 if (item.TryGetValue("name", out var nameObj) &&
                                     nameObj is string name)
@@ -437,4 +457,5 @@ private static void EnsureInputFieldParserIsInitialized()
                              .Build();
     }
 
+    internal static JsonSerializerOptions JsonSerializerOptions { get; }
 }
diff --git a/src/Microsoft.DotNet.Interactive.Documents/JsonReaderExtensions.cs b/src/Microsoft.DotNet.Interactive.Documents/JsonReaderExtensions.cs
@@ -1,6 +1,8 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+#nullable enable
+using System;
 using System.Collections.Generic;
 using System.Text.Json;
 
@@ -54,7 +56,8 @@ internal static class JsonReaderExtensions
             {
                 case JsonTokenType.StartArray:
                     var lines = JsonSerializer.Deserialize<string[]>(ref reader);
-                    return string.Join("", lines);
+
+                    return string.Join("", lines ?? Array.Empty<string>());
 
                 case JsonTokenType.String:
                     return reader.GetString();

diff --git a/src/Microsoft.DotNet.Interactive.Documents/KernelInfo.cs b/src/Microsoft.DotNet.Interactive.Documents/KernelInfo.cs
@@ -4,7 +4,6 @@
 using System;
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
-using Microsoft.DotNet.Interactive.Documents.ParserServer;
 
 namespace Microsoft.DotNet.Interactive.Documents;