CSHARP-4098: Include more detail when throwing PlatformNotSupportedException errors

BorisDog · BorisDog · commit 4fd5fec0328a · 2022-05-03T09:57:53.000-07:00
diff --git a/Docs/reference/content/reference/driver/crud/compression.md b/Docs/reference/content/reference/driver/crud/compression.md
@@ -12,9 +12,9 @@ title = "Compression"
 
 The C# driver supports compression of messages to and from MongoDB servers. The driver implements the three algorithms that are supported by MongoDB servers:
 
-* [Snappy](https://google.github.io/snappy/): Snappy compression can be used when connecting to MongoDB servers starting with the 3.4 release.
-* [Zlib](https://zlib.net/): Zlib compression can be used when connecting to MongoDB servers starting with the 3.6 release.
-* [Zstandard](https://facebook.github.io/zstd/): Zstandard compression can be used when connecting to MongoDB servers starting with the 4.2 release.
+* [Snappy](https://google.github.io/snappy/): Snappy compression can be used when connecting to MongoDB servers starting with the 3.4 release. Supported platforms: Windows: x86 and x64, Linux/macOS: x64.
+* [Zlib](https://zlib.net/): Zlib compression can be used when connecting to MongoDB servers starting with the 3.6 release. Supported on all platforms and architectures.
+* [Zstandard](https://facebook.github.io/zstd/): Zstandard compression can be used when connecting to MongoDB servers starting with the 4.2 release. Supported platforms: Windows/Linux/macOS: x64 only.
 
 The driver will negotiate which, if any, compression algorithm is used based on capabilities advertised by the server in the [hello]({{<docsref "reference/command/hello/">}}) or legacy hello command response. 
 
diff --git a/src/MongoDB.Driver.Core/Core/Compression/Snappy/Snappy32NativeMethods.cs b/src/MongoDB.Driver.Core/Core/Compression/Snappy/Snappy32NativeMethods.cs
@@ -107,12 +107,13 @@ private class Delegates32
         private class SnappyLocator : RelativeLibraryLocatorBase
         {
             public override bool IsX32ModeSupported => OperatingSystemHelper.CurrentOperatingSystem == OperatingSystemPlatform.Windows;
+            public override string LibraryName => "Snappy";
 
-            public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>
+            public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>
                 currentPlatform switch
                 {
                     OperatingSystemPlatform.Windows => "snappy32.dll", // supported only on windows
-                    _ => throw new InvalidOperationException($"Snappy is not supported on the current platform: {currentPlatform} in 32-bit mode."),
+                    _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform} in 32-bit mode."),
                 };
         }
     }
diff --git a/src/MongoDB.Driver.Core/Core/Compression/Snappy/Snappy64NativeMethods.cs b/src/MongoDB.Driver.Core/Core/Compression/Snappy/Snappy64NativeMethods.cs
@@ -101,14 +101,15 @@ private class Delegates64
         private class SnappyLocator : RelativeLibraryLocatorBase
         {
             public override bool IsX32ModeSupported => false;
+            public override string LibraryName => "Snappy";
 
-            public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>
+            public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>
                 currentPlatform switch
                 {
                     OperatingSystemPlatform.Windows => "snappy64.dll",
                     OperatingSystemPlatform.Linux => "libsnappy64.so",
                     OperatingSystemPlatform.MacOS => "libsnappy64.dylib",
-                    _ => throw new InvalidOperationException($"Snappy is not supported on the current platform: {currentPlatform}."),
+                    _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform}."),
                 };
         }
     }
diff --git a/src/MongoDB.Driver.Core/Core/Compression/Zstandard/Zstandard64NativeMethods.cs b/src/MongoDB.Driver.Core/Core/Compression/Zstandard/Zstandard64NativeMethods.cs
@@ -254,13 +254,15 @@ private class Delegates64
 
         private class ZstandardLocator : RelativeLibraryLocatorBase
         {
-            public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>
+            public override string LibraryName => "Zstandard";
+
+            public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>
                 currentPlatform switch
                 {
                     OperatingSystemPlatform.Windows => "libzstd.dll",
                     OperatingSystemPlatform.Linux => "libzstd.so",
                     OperatingSystemPlatform.MacOS => "libzstd.dylib",
-                    _ => throw new InvalidOperationException($"Zstandard is not supported on the current platform: {currentPlatform}."),
+                    _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform}."),
                 };
         }
     }
diff --git a/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/ILibraryLocator.cs b/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/ILibraryLocator.cs
@@ -20,6 +20,7 @@ namespace MongoDB.Driver.Core.NativeLibraryLoader
     internal interface ILibraryLocator
     {
         bool IsX32ModeSupported { get; }
+        string LibraryName { get; }
         string GetLibraryAbsolutePath(OperatingSystemPlatform currentPlatform);
     }
 }
diff --git a/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/LibraryLoader.cs b/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/LibraryLoader.cs
@@ -13,10 +13,9 @@
 * limitations under the License.
 */
 
-using MongoDB.Driver.Core.Misc;
-using MongoDB.Shared;
 using System;
 using System.Runtime.InteropServices;
+using MongoDB.Driver.Core.Misc;
 
 namespace MongoDB.Driver.Core.NativeLibraryLoader
 {
@@ -29,7 +28,7 @@ public LibraryLoader(ILibraryLocator libraryLocator)
             Ensure.IsNotNull(libraryLocator, nameof(libraryLocator));
             if (!libraryLocator.IsX32ModeSupported)
             {
-                ThrowIfNot64BitProcess();
+                ThrowIfNot64BitProcess(libraryLocator);
             }
             _nativeLoader = CreateNativeLoader(libraryLocator);
         }
@@ -51,10 +50,10 @@ private INativeLibraryLoader CreateNativeLoader(ILibraryLocator libraryLocator)
         {
             var currentPlatform = OperatingSystemHelper.CurrentOperatingSystem;
             var absolutePath = libraryLocator.GetLibraryAbsolutePath(currentPlatform);
-            return CreateNativeLoader(currentPlatform, absolutePath);
+            return CreateNativeLoader(currentPlatform, absolutePath, libraryLocator.LibraryName);
         }
 
-        private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentPlatform, string libraryPath)
+        private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentPlatform, string libraryPath, string libraryName)
         {
             switch (currentPlatform)
             {
@@ -65,15 +64,15 @@ private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentP
                 case OperatingSystemPlatform.Windows:
                     return new WindowsLibraryLoader(libraryPath);
                 default:
-                    throw new PlatformNotSupportedException($"Unexpected platform {currentPlatform}.");
+                    throw new PlatformNotSupportedException($"Error loading library {libraryName}: Unexpected platform {currentPlatform}.");
             }
         }
 
-        private void ThrowIfNot64BitProcess()
+        private void ThrowIfNot64BitProcess(ILibraryLocator libraryLocator)
         {
             if (!Environment.Is64BitProcess)
             {
-                throw new PlatformNotSupportedException("Native libraries can be loaded only in a 64-bit process.");
+                throw new PlatformNotSupportedException($"{libraryLocator.LibraryName} can be loaded only in a 64-bit process.");
             }
         }
     }
diff --git a/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/RelativeLibraryLocatorBase.cs b/src/MongoDB.Driver.Core/Core/NativeLibraryLoader/RelativeLibraryLocatorBase.cs
@@ -25,6 +25,8 @@ internal abstract class RelativeLibraryLocatorBase : ILibraryLocator
         // public properties
         public virtual bool IsX32ModeSupported => false;
 
+        public abstract string LibraryName { get; }
+
         // public methods
         public string GetBaseAssemblyDirectory()
         {
@@ -39,7 +41,7 @@ public string GetBaseAssemblyDirectory()
         public string GetLibraryAbsolutePath(OperatingSystemPlatform currentPlatform)
         {
             var relativePath = GetLibraryDirectoryRelativePath(currentPlatform);
-            var libraryName = GetLibraryName(currentPlatform);
+            var libraryName = GetLibraryFileName(currentPlatform);
             return GetAbsolutePath(relativePath, libraryName);
         }
 
@@ -49,7 +51,7 @@ public virtual string GetLibraryDirectoryRelativePath(OperatingSystemPlatform cu
             return Path.Combine("runtimes", rid, "native");
         }
 
-        public abstract string GetLibraryName(OperatingSystemPlatform currentPlatform);
+        public abstract string GetLibraryFileName(OperatingSystemPlatform currentPlatform);
 
         public virtual string GetCurrentPlatformRuntimeIdentifier(OperatingSystemPlatform currentPlatform)
             => currentPlatform switch
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/NativeLibraryLoader/NativeLibraryLoaderTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/NativeLibraryLoader/NativeLibraryLoaderTests.cs
@@ -94,10 +94,11 @@ public TestRelativeLibraryLocator(string mockedAssemblyUri)
                 _mockedAssemblyUri = mockedAssemblyUri; // can be null
             }
 
+            public override string LibraryName => "TestLibraryLocator";
             public override string GetBaseAssemblyUri() => _mockedAssemblyUri ?? base.GetBaseAssemblyUri();
 
             // not required for these tests yet
-            public override string GetLibraryName(OperatingSystemPlatform currentPlatform) => throw new NotImplementedException();
+            public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) => throw new NotImplementedException();
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -107,12 +107,13 @@ private class Delegates32`
`107`	`107`	`private class SnappyLocator : RelativeLibraryLocatorBase`
`108`	`108`	`{`
`109`	`109`	`public override bool IsX32ModeSupported => OperatingSystemHelper.CurrentOperatingSystem == OperatingSystemPlatform.Windows;`
	`110`	`+ public override string LibraryName => "Snappy";`
`110`	`111`
`111`		`- public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>`
	`112`	`+ public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>`
`112`	`113`	`currentPlatform switch`
`113`	`114`	`{`
`114`	`115`	`OperatingSystemPlatform.Windows => "snappy32.dll", // supported only on windows`
`115`		`- _ => throw new InvalidOperationException($"Snappy is not supported on the current platform: {currentPlatform} in 32-bit mode."),`
	`116`	`+ _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform} in 32-bit mode."),`
`116`	`117`	`};`
`117`	`118`	`}`
`118`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -101,14 +101,15 @@ private class Delegates64`
`101`	`101`	`private class SnappyLocator : RelativeLibraryLocatorBase`
`102`	`102`	`{`
`103`	`103`	`public override bool IsX32ModeSupported => false;`
	`104`	`+ public override string LibraryName => "Snappy";`
`104`	`105`
`105`		`- public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>`
	`106`	`+ public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>`
`106`	`107`	`currentPlatform switch`
`107`	`108`	`{`
`108`	`109`	`OperatingSystemPlatform.Windows => "snappy64.dll",`
`109`	`110`	`OperatingSystemPlatform.Linux => "libsnappy64.so",`
`110`	`111`	`OperatingSystemPlatform.MacOS => "libsnappy64.dylib",`
`111`		`- _ => throw new InvalidOperationException($"Snappy is not supported on the current platform: {currentPlatform}."),`
	`112`	`+ _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform}."),`
`112`	`113`	`};`
`113`	`114`	`}`
`114`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -254,13 +254,15 @@ private class Delegates64`
`254`	`254`
`255`	`255`	`private class ZstandardLocator : RelativeLibraryLocatorBase`
`256`	`256`	`{`
`257`		`- public override string GetLibraryName(OperatingSystemPlatform currentPlatform) =>`
	`257`	`+ public override string LibraryName => "Zstandard";`
	`258`	`+`
	`259`	`+ public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) =>`
`258`	`260`	`currentPlatform switch`
`259`	`261`	`{`
`260`	`262`	`OperatingSystemPlatform.Windows => "libzstd.dll",`
`261`	`263`	`OperatingSystemPlatform.Linux => "libzstd.so",`
`262`	`264`	`OperatingSystemPlatform.MacOS => "libzstd.dylib",`
`263`		`- _ => throw new InvalidOperationException($"Zstandard is not supported on the current platform: {currentPlatform}."),`
	`265`	`+ _ => throw new InvalidOperationException($"{LibraryName} is not supported on the current platform: {currentPlatform}."),`
`264`	`266`	`};`
`265`	`267`	`}`
`266`	`268`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ namespace MongoDB.Driver.Core.NativeLibraryLoader`
`20`	`20`	`internal interface ILibraryLocator`
`21`	`21`	`{`
`22`	`22`	`bool IsX32ModeSupported { get; }`
	`23`	`+ string LibraryName { get; }`
`23`	`24`	`string GetLibraryAbsolutePath(OperatingSystemPlatform currentPlatform);`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,9 @@`
`13`	`13`	`* limitations under the License.`
`14`	`14`	`*/`
`15`	`15`
`16`		`-using MongoDB.Driver.Core.Misc;`
`17`		`-using MongoDB.Shared;`
`18`	`16`	`using System;`
`19`	`17`	`using System.Runtime.InteropServices;`
	`18`	`+using MongoDB.Driver.Core.Misc;`
`20`	`19`
`21`	`20`	`namespace MongoDB.Driver.Core.NativeLibraryLoader`
`22`	`21`	`{`
`@@ -29,7 +28,7 @@ public LibraryLoader(ILibraryLocator libraryLocator)`
`29`	`28`	`Ensure.IsNotNull(libraryLocator, nameof(libraryLocator));`
`30`	`29`	`if (!libraryLocator.IsX32ModeSupported)`
`31`	`30`	`{`
`32`		`- ThrowIfNot64BitProcess();`
	`31`	`+ ThrowIfNot64BitProcess(libraryLocator);`
`33`	`32`	`}`
`34`	`33`	`_nativeLoader = CreateNativeLoader(libraryLocator);`
`35`	`34`	`}`
`@@ -51,10 +50,10 @@ private INativeLibraryLoader CreateNativeLoader(ILibraryLocator libraryLocator)`
`51`	`50`	`{`
`52`	`51`	`var currentPlatform = OperatingSystemHelper.CurrentOperatingSystem;`
`53`	`52`	`var absolutePath = libraryLocator.GetLibraryAbsolutePath(currentPlatform);`
`54`		`- return CreateNativeLoader(currentPlatform, absolutePath);`
	`53`	`+ return CreateNativeLoader(currentPlatform, absolutePath, libraryLocator.LibraryName);`
`55`	`54`	`}`
`56`	`55`
`57`		`- private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentPlatform, string libraryPath)`
	`56`	`+ private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentPlatform, string libraryPath, string libraryName)`
`58`	`57`	`{`
`59`	`58`	`switch (currentPlatform)`
`60`	`59`	`{`
`@@ -65,15 +64,15 @@ private INativeLibraryLoader CreateNativeLoader(OperatingSystemPlatform currentP`
`65`	`64`	`case OperatingSystemPlatform.Windows:`
`66`	`65`	`return new WindowsLibraryLoader(libraryPath);`
`67`	`66`	`default:`
`68`		`- throw new PlatformNotSupportedException($"Unexpected platform {currentPlatform}.");`
	`67`	`+ throw new PlatformNotSupportedException($"Error loading library {libraryName}: Unexpected platform {currentPlatform}.");`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`
`72`		`- private void ThrowIfNot64BitProcess()`
	`71`	`+ private void ThrowIfNot64BitProcess(ILibraryLocator libraryLocator)`
`73`	`72`	`{`
`74`	`73`	`if (!Environment.Is64BitProcess)`
`75`	`74`	`{`
`76`		`- throw new PlatformNotSupportedException("Native libraries can be loaded only in a 64-bit process.");`
	`75`	`+ throw new PlatformNotSupportedException($"{libraryLocator.LibraryName} can be loaded only in a 64-bit process.");`
`77`	`76`	`}`
`78`	`77`	`}`
`79`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@ internal abstract class RelativeLibraryLocatorBase : ILibraryLocator`
`25`	`25`	`// public properties`
`26`	`26`	`public virtual bool IsX32ModeSupported => false;`
`27`	`27`
	`28`	`+ public abstract string LibraryName { get; }`
	`29`	`+`
`28`	`30`	`// public methods`
`29`	`31`	`public string GetBaseAssemblyDirectory()`
`30`	`32`	`{`
`@@ -39,7 +41,7 @@ public string GetBaseAssemblyDirectory()`
`39`	`41`	`public string GetLibraryAbsolutePath(OperatingSystemPlatform currentPlatform)`
`40`	`42`	`{`
`41`	`43`	`var relativePath = GetLibraryDirectoryRelativePath(currentPlatform);`
`42`		`- var libraryName = GetLibraryName(currentPlatform);`
	`44`	`+ var libraryName = GetLibraryFileName(currentPlatform);`
`43`	`45`	`return GetAbsolutePath(relativePath, libraryName);`
`44`	`46`	`}`
`45`	`47`
`@@ -49,7 +51,7 @@ public virtual string GetLibraryDirectoryRelativePath(OperatingSystemPlatform cu`
`49`	`51`	`return Path.Combine("runtimes", rid, "native");`
`50`	`52`	`}`
`51`	`53`
`52`		`- public abstract string GetLibraryName(OperatingSystemPlatform currentPlatform);`
	`54`	`+ public abstract string GetLibraryFileName(OperatingSystemPlatform currentPlatform);`
`53`	`55`
`54`	`56`	`public virtual string GetCurrentPlatformRuntimeIdentifier(OperatingSystemPlatform currentPlatform)`
`55`	`57`	`=> currentPlatform switch`
Original file line number	Diff line number	Diff line change
`@@ -94,10 +94,11 @@ public TestRelativeLibraryLocator(string mockedAssemblyUri)`
`94`	`94`	`_mockedAssemblyUri = mockedAssemblyUri; // can be null`
`95`	`95`	`}`
`96`	`96`
	`97`	`+ public override string LibraryName => "TestLibraryLocator";`
`97`	`98`	`public override string GetBaseAssemblyUri() => _mockedAssemblyUri ?? base.GetBaseAssemblyUri();`
`98`	`99`
`99`	`100`	`// not required for these tests yet`
`100`		`- public override string GetLibraryName(OperatingSystemPlatform currentPlatform) => throw new NotImplementedException();`
	`101`	`+ public override string GetLibraryFileName(OperatingSystemPlatform currentPlatform) => throw new NotImplementedException();`
`101`	`102`	`}`
`102`	`103`	`}`
`103`	`104`	`}`