Mark JsonNode.WriteTo as obsolete with SYSLIB0060

docs/project/list-of-diagnostics.md

@@ -114,6 +114,7 @@ The PR that reveals the implementation of the `<IncludeInternalObsoleteAttribute
 |  __`SYSLIB0057`__ | Loading certificate data through the constructor or Import is obsolete. Use X509CertificateLoader instead to load certificates. |
 |  __`SYSLIB0058`__ | KeyExchangeAlgorithm, KeyExchangeStrength, CipherAlgorithm, CipherAlgorithmStrength, HashAlgorithm and HashStrength properties of SslStream are obsolete. Use NegotiatedCipherSuite instead. |
 |  __`SYSLIB0059`__ | SystemEvents.EventsThreadShutdown callbacks are not run before the process exits. Use AppDomain.ProcessExit instead. |
+|  __`SYSLIB0060`__ | JsonNode.WriteTo are obsolete. Use JsonSerializer.Serialize{Async} instead. |
 
 ## Analyzer Warnings
 

src/libraries/Common/src/System/Obsoletions.cs

@@ -190,6 +190,9 @@ internal static class Obsoletions
         internal const string SystemEventsEventsThreadShutdownMessage = "SystemEvents.EventsThreadShutdown callbacks are not run before the process exits. Use AppDomain.ProcessExit instead.";
         internal const string SystemEventsEventsThreadShutdownDiagId = "SYSLIB0059";
 
+        internal const string JsonNodeWriteToMessage = "JsonNode.WriteTo are obsolete. Use JsonSerializer.Serialize{Async} instead.";
+        internal const string JsonNodeWriteToDiagId = "SYSLIB0060";
+
         // When adding a new diagnostic ID, add it to the table in docs\project\list-of-diagnostics.md as well.
         // Keep new const identifiers above this comment.
     }

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonArray.cs

@@ -261,6 +261,7 @@ internal override void GetPath(ref ValueStringBuilder path, JsonNode? child)
         }
 
         /// <inheritdoc/>
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)
         {
             if (writer is null)

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonNode.To.cs

@@ -25,7 +25,9 @@ public string ToJsonString(JsonSerializerOptions? options = null)
             Utf8JsonWriter writer = Utf8JsonWriterCache.RentWriterAndBuffer(writerOptions, defaultBufferSize, out PooledByteBufferWriter output);
             try
             {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                 WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                 writer.Flush();
                 return JsonHelpers.Utf8GetString(output.WrittenMemory.Span);
             }
@@ -58,7 +60,9 @@ public override string ToString()
             Utf8JsonWriter writer = Utf8JsonWriterCache.RentWriterAndBuffer(new JsonWriterOptions { Indented = true }, JsonSerializerOptions.BufferSizeDefault, out PooledByteBufferWriter output);
             try
             {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                 WriteTo(writer);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                 writer.Flush();
                 return JsonHelpers.Utf8GetString(output.WrittenMemory.Span);
             }
@@ -76,6 +80,7 @@ public override string ToString()
         ///   The <paramref name="writer"/> parameter is <see langword="null"/>.
         /// </exception>
         /// <param name="options">Options to control the serialization behavior.</param>
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public abstract void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null);
     }
 }

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

@@ -129,6 +129,7 @@ public bool TryGetPropertyValue(string propertyName, out JsonNode? jsonNode)
         }
 
         /// <inheritdoc/>
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)
         {
             if (writer is null)

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonValue.cs

@@ -141,7 +141,9 @@ static JsonElement ToJsonElement(JsonNode node, out JsonDocument? backingDocumen
 
                 try
                 {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                     node.WriteTo(writer);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                     writer.Flush();
                     Utf8JsonReader reader = new(output.WrittenMemory.Span);
                     backingDocument = JsonDocument.ParseValue(ref reader);

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonValueOfElement.cs

@@ -194,6 +194,7 @@ public override bool TryGetValue<TypeToConvert>([NotNullWhen(true)] out TypeToCo
             return false;
         }
 
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)
         {
             if (writer is null)

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonValueOfTCustomized.cs

@@ -26,6 +26,8 @@ public JsonValueCustomized(TValue value, JsonTypeInfo<TValue> jsonTypeInfo, Json
         private protected override JsonValueKind GetValueKindCore() => _valueKind ??= ComputeValueKind();
         internal override JsonNode DeepCloneCore() => JsonSerializer.SerializeToNode(Value, _jsonTypeInfo)!;
 
+
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)
         {
             if (writer is null)
@@ -52,7 +54,9 @@ private JsonValueKind ComputeValueKind()
             Utf8JsonWriter writer = Utf8JsonWriterCache.RentWriterAndBuffer(options: default, JsonSerializerOptions.BufferSizeDefault, out PooledByteBufferWriter output);
             try
             {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                 WriteTo(writer);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                 writer.Flush();
                 Utf8JsonReader reader = new(output.WrittenMemory.Span);
                 bool success = reader.Read();

src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonValueOfTPrimitive.cs

@@ -39,6 +39,7 @@ internal override bool DeepEqualsCore(JsonNode otherNode)
             return base.DeepEqualsCore(otherNode);
         }
 
+        [Obsolete(Obsoletions.JsonNodeWriteToMessage, DiagnosticId = Obsoletions.JsonNodeWriteToDiagId)]
         public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)
         {
             if (writer is null)

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Converters/Node/JsonArrayConverter.cs

@@ -17,7 +17,9 @@ public override void Write(Utf8JsonWriter writer, JsonArray? value, JsonSerializ
                 return;
             }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
             value.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
         }
 
         public override JsonArray? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Converters/Node/JsonNodeConverter.cs

@@ -32,7 +32,9 @@ public override void Write(Utf8JsonWriter writer, JsonNode? value, JsonSerialize
             }
             else
             {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                 value.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
             }
         }
 

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Converters/Node/JsonObjectConverter.cs

@@ -42,7 +42,9 @@ public override void Write(Utf8JsonWriter writer, JsonObject? value, JsonSeriali
                 return;
             }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
             value.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
         }
 
         public override JsonObject? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Converters/Node/JsonValueConverter.cs

@@ -17,7 +17,9 @@ public override void Write(Utf8JsonWriter writer, JsonValue? value, JsonSerializ
                 return;
             }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
             value.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
         }
 
         public override JsonValue? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Read.Node.cs

@@ -165,7 +165,9 @@ public static partial class JsonSerializer
                 }
                 else
                 {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                     node.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                 }
             }
 
@@ -186,7 +188,9 @@ public static partial class JsonSerializer
                 }
                 else
                 {
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
                     node.WriteTo(writer, options);
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
                 }
             }
 

src/libraries/System.Text.Json/tests/System.Text.Json.Tests/JsonNode/JsonArrayTests.cs

@@ -56,6 +56,7 @@ public static void FromElement_WrongNodeTypeThrows(string json)
                 Assert.Throws<InvalidOperationException>(() => JsonArray.Create(document.RootElement));
         }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
         [Fact]
         public static void WriteTo_Validation()
         {
@@ -104,6 +105,7 @@ public static void WriteTo_Options()
             json = Encoding.UTF8.GetString(stream.ToArray());
             Assert.Equal("[\"42\"]", json);
         }
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
 
         [Fact]
         public static void Clear()

src/libraries/System.Text.Json/tests/System.Text.Json.Tests/JsonNode/JsonObjectTests.cs

@@ -326,6 +326,7 @@ public static void FromElement_WrongNodeTypeThrows(string json)
             }
         }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
         [Fact]
         public static void WriteTo_Validation()
         {
@@ -346,6 +347,7 @@ public static void WriteTo()
             string json = Encoding.UTF8.GetString(stream.ToArray());
             Assert.Equal(Json, json);
         }
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
 
         [Fact]
         public static void CopyTo()

src/libraries/System.Text.Json/tests/System.Text.Json.Tests/JsonNode/JsonValueTests.cs

@@ -288,6 +288,7 @@ public static void FromElement_WrongNodeTypeThrows(string json)
                 Assert.Throws<InvalidOperationException>(() => JsonValue.Create(document.RootElement));
         }
 
+#pragma warning disable SYSLIB0060 // Type or member is obsolete
         [Fact]
         public static void WriteTo_Validation()
         {
@@ -308,6 +309,7 @@ public static void WriteTo()
             string json = Encoding.UTF8.GetString(stream.ToArray());
             Assert.Equal(Json, json);
         }
+#pragma warning restore SYSLIB0060 // Type or member is obsolete
 
         [Fact]
         public static void DeepCloneNotTrimmable()