Add [Obsolete] to deprecated members. (#472)

* Add [Obsolete] to deprecated members.

* Add test

* Fix test break

Author: jamescourtney

src/FlatSharp.Compiler/SchemaModel/BaseReferenceTypeSchemaModel.cs

@@ -134,7 +134,7 @@ private void EmitCopyConstructor(CodeWriter writer, CompileContext context)
                 return;
             }
 
-            foreach (var property in this.properties)
+            foreach (var property in this.properties.Where(x => !x.Value.Field.Deprecated))
             {
                 writer.AppendLine($"this.{property.Value.FieldName} = {context.FullyQualifiedCloneMethodName}(source.{property.Value.FieldName});");
             }
@@ -162,7 +162,7 @@ private void EmitDefaultConstrutor(CodeWriter writer, CompileContext context)
             writer.AppendLine($"public {this.Name}()");
             using (writer.WithBlock())
             {
-                foreach (var item in this.properties.OrderBy(x => x.Key))
+                foreach (var item in this.properties.OrderBy(x => x.Key).Where(x => !x.Value.Field.Deprecated))
                 {
                     this.EmitDefaultConstructorFieldInitialization(item.Value, writer, context);
                 }

src/FlatSharp.Compiler/SchemaModel/PropertyFieldModel.cs

@@ -142,6 +142,11 @@ public void WriteCode(CompileContext context, CodeWriter writer)
         writer.AppendSummaryComment(this.Field.Documentation);
         writer.AppendLine(this.GetAttribute());
 
+        if (this.Field.Deprecated)
+        {
+            writer.AppendLine("[Obsolete]");
+        }
+
         this.Attributes.EmitAsMetadata(writer);
 
         SetterKind setterKind = this.Attributes.SetterKind ?? SetterKind.Public;

src/FlatSharp/Serialization/RoslynSerializerGenerator.cs

@@ -337,6 +337,7 @@ Func<string> cSharpFactory
             var failures = result.Diagnostics
                 .Where(d => d.Id != "CS8019") // unnecessary using directive.
                 .Where(d => d.Id != "CS1701") // DLL version mismatch
+                .Where(d => d.Id != "CS9042") // obsolete warning
                 .ToArray();
 
             if (failures.Length > 0)

src/Tests/FlatSharpEndToEndTests/MetadataAttributes/MetadataAttributeTests.cs

@@ -111,6 +111,11 @@ public void Table_Attributes()
         Assert.AreEqual("0", attrs["required"]);
         Assert.AreEqual("0", attrs["fs_writeThrough"]);
         Assert.AreEqual("value_struct", attrs["test"]);
+
+        attrs = GetAttributes(typeof(Message).GetProperty("DeprecatedInt"));
+        Assert.AreEqual(1, attrs.Count);
+        Assert.AreEqual("0", attrs["deprecated"]);
+        Assert.IsNotNull(typeof(Message).GetProperty("DeprecatedInt").GetCustomAttribute<ObsoleteAttribute>());
     }
 
     private static Dictionary<string, string?> GetAttributes<T>() => GetAttributes(typeof(T));

src/Tests/FlatSharpEndToEndTests/MetadataAttributes/MetadataAttributes.fbs

@@ -37,6 +37,7 @@ table Message (fs_serializer:"Lazy", test:"Message") {
     single_int : int (test:"single_int");
     vector_int : [ int ] (fs_vectorKind:"IList", test:"vector_int");
     value_struct : ValueStruct (required, fs_writeThrough, test:"value_struct");
+    deprecated_int : int (deprecated);
 }
 
 rpc_service EchoService (fs_rpcInterface, test:"EchoService") {

src/Tests/FlatSharpEndToEndTests/RawData/RawDataStringTests.cs

@@ -47,6 +47,8 @@ public void EmptyString()
         Assert.IsTrue(expectedResult.AsSpan().SequenceEqual(data));
     }
 
+#pragma warning disable CS0612 // Type or member is obsolete
+
     [TestMethod]
     public void DeprecatedString()
     {
@@ -68,6 +70,8 @@ public void DeprecatedString()
         Assert.IsTrue(expectedResult.AsSpan().SequenceEqual(data));
     }
 
+#pragma warning restore CS0612 // Type or member is obsolete
+
     [TestMethod]
     public void SimpleString()
     {
@@ -97,11 +101,13 @@ public void SimpleString()
     [TestMethod]
     public void StringVector()
     {
+#pragma warning disable CS0612 // Type or member is obsolete
         var root = new StringTable
         {
             ItemDeprecated = "notnull",
             ItemVectorImplicit = new[] { "abc_", "def", "ghi" }
         };
+#pragma warning restore CS0612 // Type or member is obsolete
 
         byte[] data = root.AllocateAndSerialize();
 

src/Tests/FlatSharpEndToEndTests/RawData/RawDataTableTests.cs

@@ -249,7 +249,9 @@ public void DeprecatedValue_IgnoreOnRead(FlatBufferDeserializationOption option)
 
         var parsed = DeprecatedItemTable.Serializer.Parse(data, option);
 
+#pragma warning disable CS0612 // Type or member is obsolete
         Assert.AreEqual(0, parsed.Value);
+#pragma warning restore CS0612 // Type or member is obsolete
         Assert.AreEqual(255L, parsed.Other);
 
         var nonDeprecatedParsed = NonDeprecatedItemTable.Serializer.Parse(data, option);
@@ -262,11 +264,13 @@ public void DeprecatedValue_IgnoreOnRead(FlatBufferDeserializationOption option)
     [DynamicData(nameof(DynamicDataHelper.DeserializationModes), typeof(DynamicDataHelper))]
     public void DeprecatedValue_IgnoreOnWrite(FlatBufferDeserializationOption option)
     {
+#pragma warning disable CS0612 // Type or member is obsolete
         var deprecatedTable = new DeprecatedItemTable
         {
             Value = 123,
             Other = 255,
         };
+#pragma warning restore CS0612 // Type or member is obsolete
 
         byte[] data =
         {

src/Tests/FlatSharpEndToEndTests/TableMembers/TableMembersTests.cs

@@ -84,6 +84,8 @@ public void Byte(FlatBufferDeserializationOption option)
     [DynamicData(nameof(DynamicDataHelper.DeserializationModes), typeof(DynamicDataHelper))]
     public void Double(FlatBufferDeserializationOption option) => this.RunTest<double, DoubleTable>(3.14, option);
 
+#pragma warning disable CS0612 // Type or member is obsolete
+
     [TestMethod]
     [DynamicData(nameof(DynamicDataHelper.DeserializationModes), typeof(DynamicDataHelper))]
     public void String(FlatBufferDeserializationOption option)
@@ -125,6 +127,8 @@ public void String(FlatBufferDeserializationOption option)
         }
     }
 
+#pragma warning restore CS0612 // Type or member is obsolete
+
     private void RunTest<T, TTable>(T expectedDefault, FlatBufferDeserializationOption option)
         where T : struct
         where TTable : class, ITypedTable<T>, IFlatBufferSerializable<TTable>, new()