[Internal] Query: Adds flag for enabling string encoding in JsonBinaryWriter and default to true (#2527)

* Add a flag for enabling string encoding and default to true

* As per code review feedback, set enableEncodedStrings to false for CapturePreblittedBinaryJsonScope

Co-authored-by: Samer Boshra <[email protected]>

Author: neildsh

Microsoft.Azure.Cosmos/src/Json/JsonWriter.JsonBinaryWriter.cs

@@ -22,6 +22,8 @@ namespace Microsoft.Azure.Cosmos.Json
 #endif
     abstract partial class JsonWriter : IJsonWriter
     {
+        internal bool EnableEncodedStrings { get; private set; }
+
         /// <summary>
         /// Executes the provided lambda and captures a copy of the written bytes for reuse.
         /// The lambda is executed at a field name, and should leave the reader in a state where
@@ -31,7 +33,7 @@ abstract partial class JsonWriter : IJsonWriter
         /// <returns>Blitted bytes.</returns>
         public static PreblittedBinaryJsonScope CapturePreblittedBinaryJsonScope(Action<ITypedBinaryJsonWriter> scopeWriter)
         {
-            JsonBinaryWriter jsonBinaryWriter = new JsonBinaryWriter();
+            JsonBinaryWriter jsonBinaryWriter = new JsonBinaryWriter(initialCapacity: 256, serializeCount: false, enableEncodedStrings: false);
             Contract.Requires(!jsonBinaryWriter.JsonObjectState.InArrayContext);
             Contract.Requires(!jsonBinaryWriter.JsonObjectState.InObjectContext);
             Contract.Requires(!jsonBinaryWriter.JsonObjectState.IsPropertyExpected);
@@ -270,10 +272,13 @@ private enum RawValueType : byte
             /// </summary>
             /// <param name="initialCapacity">The initial capacity to avoid intermediary allocations.</param>
             /// <param name="serializeCount">Whether to serialize the count for object and array typemarkers.</param>
+            /// <param name="enableEncodedStrings">enable reference string encoding</param>
             public JsonBinaryWriter(
-                int initialCapacity = 256,
-                bool serializeCount = false)
+                int initialCapacity,
+                bool serializeCount,
+                bool enableEncodedStrings)
             {
+                this.EnableEncodedStrings = enableEncodedStrings;
                 this.binaryWriter = new JsonBinaryMemoryWriter(initialCapacity);
                 this.bufferedContexts = new Stack<ArrayAndObjectInfo>();
                 this.serializeCount = serializeCount;
@@ -827,20 +832,23 @@ private void WriteFieldNameOrString(bool isFieldName, Utf8Span utf8Span)
                             throw new InvalidOperationException($"Unable to serialize a {nameof(JsonBinaryEncoding.MultiByteTypeMarker)} of length: {multiByteTypeMarker.Length}");
                     }
                 }
-                else if (isFieldName
+                else if (this.EnableEncodedStrings
+                    && isFieldName
                     && (utf8Span.Length >= MinReferenceStringLength)
                     && this.TryRegisterStringValue(utf8Span))
                 {
                     // Work is done in the check
                 }
-                else if (!isFieldName
+                else if (this.EnableEncodedStrings
+                    && !isFieldName
                     && (utf8Span.Length == JsonBinaryEncoding.GuidLength)
                     && JsonBinaryEncoding.TryEncodeGuidString(utf8Span.Span, this.binaryWriter.Cursor))
                 {
                     // Encoded value as guid string
                     this.binaryWriter.Position += JsonBinaryEncoding.EncodedGuidLength;
                 }
-                else if (!isFieldName
+                else if (this.EnableEncodedStrings
+                    && !isFieldName
                     && (utf8Span.Length == JsonBinaryEncoding.GuidWithQuotesLength)
                     && (utf8Span.Span[0] == '"')
                     && (utf8Span.Span[JsonBinaryEncoding.GuidWithQuotesLength - 1] == '"')
@@ -851,13 +859,15 @@ private void WriteFieldNameOrString(bool isFieldName, Utf8Span utf8Span)
                     this.binaryWriter.Cursor[0] = JsonBinaryEncoding.TypeMarker.DoubleQuotedLowercaseGuidString;
                     this.binaryWriter.Position += JsonBinaryEncoding.EncodedGuidLength;
                 }
-                else if (!isFieldName
+                else if (this.EnableEncodedStrings
+                    && !isFieldName
                     && JsonBinaryEncoding.TryEncodeCompressedString(utf8Span.Span, this.binaryWriter.Cursor, out int bytesWritten))
                 {
                     // Encoded value as a compressed string
                     this.binaryWriter.Position += bytesWritten;
                 }
-                else if (!isFieldName
+                else if (this.EnableEncodedStrings
+                    && !isFieldName
                     && (utf8Span.Length >= MinReferenceStringLength)
                     && (utf8Span.Length <= MaxReferenceStringLength)
                     && this.TryRegisterStringValue(utf8Span))

Microsoft.Azure.Cosmos/src/Json/JsonWriter.cs

@@ -46,15 +46,20 @@ protected JsonWriter()
         /// </summary>
         /// <param name="jsonSerializationFormat">The JsonSerializationFormat of the writer.</param>
         /// <param name="initalCapacity">Initial capacity to help avoid intermeidary allocations.</param>
+        /// <param name="enableEncodedStrings">Only applicable to the binary writer</param>
         /// <returns>A JsonWriter that can write in a particular JsonSerializationFormat</returns>
         public static IJsonWriter Create(
             JsonSerializationFormat jsonSerializationFormat,
-            int initalCapacity = 256)
+            int initalCapacity = 256,
+            bool enableEncodedStrings = true)
         {
             return jsonSerializationFormat switch
             {
                 JsonSerializationFormat.Text => new JsonTextWriter(initalCapacity),
-                JsonSerializationFormat.Binary => new JsonBinaryWriter(initalCapacity, serializeCount: false),
+                JsonSerializationFormat.Binary => new JsonBinaryWriter(
+                    initialCapacity: initalCapacity,
+                    serializeCount: false,
+                    enableEncodedStrings: enableEncodedStrings),
                 _ => throw new ArgumentException(
                         string.Format(
                             CultureInfo.CurrentCulture,