CSHARP-2724: Implement specification for handling native UUID types.

Author: rstam

build.cake

@@ -115,6 +115,17 @@ Task("Test")
         .Where(name => !name.ToString().Contains("Atlas")),
         testProject => 
     {
+        var testWithDefaultGuidRepresentationMode = Environment.GetEnvironmentVariable("TEST_WITH_DEFAULT_GUID_REPRESENTATION_MODE");
+        if (testWithDefaultGuidRepresentationMode != null)
+        {
+            Console.WriteLine($"TEST_WITH_DEFAULT_GUID_REPRESENTATION_MODE={testWithDefaultGuidRepresentationMode}");
+        }
+        var testWithDefaultGuidRepresentation = Environment.GetEnvironmentVariable("TEST_WITH_DEFAULT_GUID_REPRESENTATION");
+        if (testWithDefaultGuidRepresentation != null)
+        {
+            Console.WriteLine($"TEST_WITH_DEFAULT_GUID_REPRESENTATION={testWithDefaultGuidRepresentation}");
+        }
+
         DotNetCoreTest(
             testProject.FullPath,
             new DotNetCoreTestSettings {
@@ -125,6 +136,49 @@ Task("Test")
             }
         );
     });
+
+// currently we are not running this Task on Evergreen (only locally occassionally)
+Task("TestAllGuidRepresentations")
+    .IsDependentOn("Build")
+    .DoesForEach(
+        GetFiles("./**/*.Tests.csproj")
+        // .Where(name => name.ToString().Contains("Bson.Tests")) // uncomment to only test Bson
+        .Where(name => !name.ToString().Contains("Atlas")),
+        testProject => 
+    {
+        var modes = new string[][]
+        {
+            new[] { "V2", "Unspecified" },
+            new[] { "V2", "JavaLegacy" },
+            new[] { "V2", "Standard" },
+            new[] { "V2", "PythonLegacy" },
+            new[] { "V2", "CSharpLegacy" },
+            new[] { "V3", "Unspecified" }
+        };
+
+        foreach (var mode in modes)
+        {
+            var testWithGuidRepresentationMode = mode[0];
+            var testWithGuidRepresentation = mode[1];
+            Console.WriteLine($"TEST_WITH_DEFAULT_GUID_REPRESENTATION_MODE={testWithGuidRepresentationMode}");
+            Console.WriteLine($"TEST_WITH_DEFAULT_GUID_REPRESENTATION={testWithGuidRepresentation}");
+
+            DotNetCoreTest(
+                testProject.FullPath,
+                new DotNetCoreTestSettings {
+                    NoBuild = true,
+                    NoRestore = true,
+                    Configuration = configuration,
+                    ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
+                    EnvironmentVariables = new Dictionary<string, string>
+                    {
+                        { "TEST_WITH_DEFAULT_GUID_REPRESENTATION_MODE", testWithGuidRepresentationMode },
+                        { "TEST_WITH_DEFAULT_GUID_REPRESENTATION", testWithGuidRepresentation }
+                    }
+                }
+            );
+        }
+    });
 
 Task("TestAtlasConnectivity")
     .IsDependentOn("Build")

src/MongoDB.Bson/BsonDefaults.cs

@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using System.Collections.Generic;
 using System.Dynamic;
 using MongoDB.Bson.Serialization;
@@ -27,11 +28,28 @@ public static class BsonDefaults
         private static bool __dynamicArraySerializerWasSet;
         private static IBsonSerializer __dynamicArraySerializer;
         private static bool __dynamicDocumentSerializerWasSet;
-        private static IBsonSerializer __dynamicDocumentSerializer; 
+        private static IBsonSerializer __dynamicDocumentSerializer;
         private static GuidRepresentation __guidRepresentation = GuidRepresentation.CSharpLegacy;
+        private static GuidRepresentationMode __guidRepresentationMode = GuidRepresentationMode.V2;
         private static int __maxDocumentSize = int.MaxValue;
         private static int __maxSerializationDepth = 100;
 
+        // static constructor
+        static BsonDefaults()
+        {
+            var testWithDefaultGuidRepresentation = Environment.GetEnvironmentVariable("TEST_WITH_DEFAULT_GUID_REPRESENTATION");
+            if (testWithDefaultGuidRepresentation != null)
+            {
+                var _ = Enum.TryParse(testWithDefaultGuidRepresentation, out __guidRepresentation); // ignore errors
+            }
+
+            var testWithDefaultGuidRepresentationMode = Environment.GetEnvironmentVariable("TEST_WITH_DEFAULT_GUID_REPRESENTATION_MODE");
+            if (testWithDefaultGuidRepresentationMode != null)
+            {
+                var _ = Enum.TryParse(testWithDefaultGuidRepresentationMode, out __guidRepresentationMode); // ignore errors
+            }
+        }
+
         // public static properties
         /// <summary>
         /// Gets or sets the dynamic array serializer.
@@ -46,10 +64,10 @@ public static IBsonSerializer DynamicArraySerializer
                 }
                 return __dynamicArraySerializer;
             }
-            set 
+            set
             {
                 __dynamicArraySerializerWasSet = true;
-                __dynamicArraySerializer = value; 
+                __dynamicArraySerializer = value;
             }
         }
 
@@ -58,30 +76,64 @@ public static IBsonSerializer DynamicArraySerializer
         /// </summary>
         public static IBsonSerializer DynamicDocumentSerializer
         {
-            get 
+            get
             {
                 if (!__dynamicDocumentSerializerWasSet)
                 {
                     __dynamicDocumentSerializer = BsonSerializer.LookupSerializer<ExpandoObject>();
                 }
-                return __dynamicDocumentSerializer; 
+                return __dynamicDocumentSerializer;
             }
-            set 
+            set
             {
                 __dynamicDocumentSerializerWasSet = true;
-                __dynamicDocumentSerializer = value; 
+                __dynamicDocumentSerializer = value;
             }
         }
 
         /// <summary>
-        /// Gets or sets the default representation to be used in serialization of 
-        /// Guids to the database. 
-        /// <seealso cref="MongoDB.Bson.GuidRepresentation"/> 
+        /// Gets or sets the default representation to be used in serialization of
+        /// Guids to the database.
+        /// <seealso cref="MongoDB.Bson.GuidRepresentation"/>
         /// </summary>
+        [Obsolete("Configure serializers instead.")]
         public static GuidRepresentation GuidRepresentation
         {
-            get { return __guidRepresentation; }
-            set { __guidRepresentation = value; }
+            get
+            {
+                if (BsonDefaults.GuidRepresentationMode != GuidRepresentationMode.V2)
+                {
+                    throw new InvalidOperationException("BsonDefaults.GuidRepresentation can only be used when BsonDefaults.GuidRepresentationMode is V2.");
+                }
+                return __guidRepresentation;
+            }
+            set
+            {
+                if (BsonDefaults.GuidRepresentationMode != GuidRepresentationMode.V2)
+                {
+                    throw new InvalidOperationException("BsonDefaults.GuidRepresentation can only be used when BsonDefaults.GuidRepresentationMode is V2.");
+                }
+                __guidRepresentation = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the default representation to be used in serialization of
+        /// Guids to the database.
+        /// <seealso cref="MongoDB.Bson.GuidRepresentation"/>
+        /// </summary>
+        [Obsolete("This property will be removed in a later release.")]
+        public static GuidRepresentationMode GuidRepresentationMode
+        {
+            get { return __guidRepresentationMode; }
+            set
+            {
+                __guidRepresentationMode = value;
+                if (value == GuidRepresentationMode.V3)
+                {
+                    __guidRepresentation = GuidRepresentation.Unspecified;
+                }
+            }
         }
 
         /// <summary>

src/MongoDB.Bson/IO/BsonBinaryReader.cs

@@ -27,7 +27,6 @@ public class BsonBinaryReader : BsonReader
         // private fields
         private readonly Stream _baseStream;
         private readonly BsonStream _bsonStream;
-        private readonly BsonBinaryReaderSettings _settings; // same value as in base class just declared as derived class
         private BsonBinaryReaderContext _context;
 
         // constructors
@@ -59,7 +58,6 @@ public BsonBinaryReader(Stream stream, BsonBinaryReaderSettings settings)
 
             _baseStream = stream;
             _bsonStream = (stream as BsonStream) ?? new BsonStreamAdapter(stream);
-            _settings = settings; // already frozen by base class
 
             _context = new BsonBinaryReaderContext(null, ContextType.TopLevel, 0, 0);
         }
@@ -87,6 +85,14 @@ public BsonStream BsonStream
             get { return _bsonStream; }
         }
 
+        /// <summary>
+        /// Gets the settings of the writer.
+        /// </summary>
+        public new BsonBinaryReaderSettings Settings
+        {
+            get { return (BsonBinaryReaderSettings)base.Settings; }
+        }
+
         // public methods
         /// <summary>
         /// Closes the reader.
@@ -140,24 +146,33 @@ public override BsonBinaryData ReadBinaryData()
                 }
                 size = size2;
 
-                if (_settings.FixOldBinarySubTypeOnInput)
+                if (Settings.FixOldBinarySubTypeOnInput)
                 {
                     subType = BsonBinarySubType.Binary; // replace obsolete OldBinary with new Binary sub type
                 }
             }
 
             var bytes = _bsonStream.ReadBytes(size);
 
-            GuidRepresentation guidRepresentation;
-            switch (subType)
+            BsonBinaryData binaryData;
+            if (BsonDefaults.GuidRepresentationMode == GuidRepresentationMode.V2)
+            {
+                GuidRepresentation guidRepresentation;
+                switch (subType)
+                {
+                    case BsonBinarySubType.UuidLegacy: guidRepresentation = Settings.GuidRepresentation; break;
+                    case BsonBinarySubType.UuidStandard: guidRepresentation = GuidRepresentation.Standard; break;
+                    default: guidRepresentation = GuidRepresentation.Unspecified; break;
+                }
+                binaryData = new BsonBinaryData(bytes, subType, guidRepresentation);
+            }
+            else
             {
-                case BsonBinarySubType.UuidLegacy: guidRepresentation = _settings.GuidRepresentation; break;
-                case BsonBinarySubType.UuidStandard: guidRepresentation = GuidRepresentation.Standard; break;
-                default: guidRepresentation = GuidRepresentation.Unspecified; break;
+                binaryData = new BsonBinaryData(bytes, subType);
             }
 
             State = GetNextState();
-            return new BsonBinaryData(bytes, subType, guidRepresentation);
+            return binaryData;
         }
 #pragma warning restore 618
 
@@ -287,7 +302,7 @@ public override long ReadDateTime()
             var value = _bsonStream.ReadInt64();
             if (value == BsonConstants.DateTimeMaxValueMillisecondsSinceEpoch + 1)
             {
-                if (_settings.FixOldDateTimeMaxValueOnInput)
+                if (Settings.FixOldDateTimeMaxValueOnInput)
                 {
                     value = BsonConstants.DateTimeMaxValueMillisecondsSinceEpoch;
                 }
@@ -411,7 +426,7 @@ public override string ReadJavaScript()
             if (Disposed) { ThrowObjectDisposedException(); }
             VerifyBsonType("ReadJavaScript", BsonType.JavaScript);
             State = GetNextState();
-            return _bsonStream.ReadString(_settings.Encoding);
+            return _bsonStream.ReadString(Settings.Encoding);
         }
 
         /// <summary>
@@ -426,7 +441,7 @@ public override string ReadJavaScriptWithScope()
             var startPosition = _bsonStream.Position; // position of size field
             var size = ReadSize();
             _context = new BsonBinaryReaderContext(_context, ContextType.JavaScriptWithScope, startPosition, size);
-            var code = _bsonStream.ReadString(_settings.Encoding);
+            var code = _bsonStream.ReadString(Settings.Encoding);
 
             State = BsonReaderState.ScopeDocument;
             return code;
@@ -474,7 +489,7 @@ public override string ReadName(INameDecoder nameDecoder)
                 ThrowInvalidState("ReadName", BsonReaderState.Name);
             }
 
-            CurrentName = nameDecoder.Decode(_bsonStream, _settings.Encoding);
+            CurrentName = nameDecoder.Decode(_bsonStream, Settings.Encoding);
             State = BsonReaderState.Value;
 
             if (_context.ContextType == ContextType.Document)
@@ -568,8 +583,8 @@ public override BsonRegularExpression ReadRegularExpression()
             if (Disposed) { ThrowObjectDisposedException(); }
             VerifyBsonType("ReadRegularExpression", BsonType.RegularExpression);
             State = GetNextState();
-            var pattern = _bsonStream.ReadCString(_settings.Encoding);
-            var options = _bsonStream.ReadCString(_settings.Encoding);
+            var pattern = _bsonStream.ReadCString(Settings.Encoding);
+            var options = _bsonStream.ReadCString(Settings.Encoding);
             return new BsonRegularExpression(pattern, options);
         }
 
@@ -611,7 +626,7 @@ public override string ReadString()
             if (Disposed) { ThrowObjectDisposedException(); }
             VerifyBsonType("ReadString", BsonType.String);
             State = GetNextState();
-            return _bsonStream.ReadString(_settings.Encoding);
+            return _bsonStream.ReadString(Settings.Encoding);
         }
 
         /// <summary>
@@ -623,7 +638,7 @@ public override string ReadSymbol()
             if (Disposed) { ThrowObjectDisposedException(); }
             VerifyBsonType("ReadSymbol", BsonType.Symbol);
             State = GetNextState();
-            return _bsonStream.ReadString(_settings.Encoding);
+            return _bsonStream.ReadString(Settings.Encoding);
         }
 
         /// <summary>
@@ -814,9 +829,9 @@ private int ReadSize()
                 var message = string.Format("Size {0} is not valid because it is negative.", size);
                 throw new FormatException(message);
             }
-            if (size > _settings.MaxDocumentSize)
+            if (size > Settings.MaxDocumentSize)
             {
-                var message = string.Format("Size {0} is not valid because it is larger than MaxDocumentSize {1}.", size, _settings.MaxDocumentSize);
+                var message = string.Format("Size {0} is not valid because it is larger than MaxDocumentSize {1}.", size, Settings.MaxDocumentSize);
                 throw new FormatException(message);
             }
             return size;

src/MongoDB.Bson/IO/BsonBinaryReaderSettings.cs

@@ -139,9 +139,15 @@ protected override BsonReaderSettings CloneImplementation()
                 Encoding = _encoding,
                 FixOldBinarySubTypeOnInput = _fixOldBinarySubTypeOnInput,
                 FixOldDateTimeMaxValueOnInput = _fixOldDateTimeMaxValueOnInput,
-                GuidRepresentation = GuidRepresentation,
                 MaxDocumentSize = _maxDocumentSize
             };
+#pragma warning disable 618
+            if (BsonDefaults.GuidRepresentationMode == GuidRepresentationMode.V2)
+            {
+                clone.GuidRepresentation = GuidRepresentation;
+            }
+#pragma warning restore 618
+
             return clone;
         }
     }