Added option to select serializer (#433)

* Bumped all versions * Renamed methods on JwtBuilder * Added DefaultJsonSerializerFactory * Added DelegateJsonSerializerFactory * Updated tests Co-authored-by: Markus Hartung <[email protected]> Co-authored-by: Alexander Batishchev <[email protected]>
jwt-dotnet · Sep 8, 2022 · 2e2c9c0 · 2e2c9c0
1 parent b387094
commit 2e2c9c0
Show file tree

Hide file tree

Showing 24 changed files with 250 additions and 98 deletions.
diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
@@ -4,14 +4,8 @@
   <Choose>
     <When Condition="'$(TargetFramework)' == 'net462' OR '$(TargetFramework)' == 'netstandard2.0' OR '$(TargetFramework)' == 'net6.0'">
       <PropertyGroup>
-        <DefineConstants>$(DefineConstants);SYSTEM_TEXT_JSON</DefineConstants>
+        <DefineConstants>$(DefineConstants);MODERN_DOTNET</DefineConstants>
       </PropertyGroup>
     </When>
-    <Otherwise>
-      <PropertyGroup>
-        <DefineConstants>$(DefineConstants);NEWTONSOFT_JSON</DefineConstants>
-      </PropertyGroup>
-    </Otherwise>
   </Choose>
-
 </Project>
diff --git a/src/JWT.Extensions.AspNetCore/JWT.Extensions.AspNetCore.csproj b/src/JWT.Extensions.AspNetCore/JWT.Extensions.AspNetCore.csproj
@@ -11,7 +11,7 @@
     <Authors>Alexander Batishchev</Authors>
     <PackageTags>jwt;json;asp.net;asp.net core;.net core;authorization</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <Version>10.0.0-beta3</Version>
+    <Version>10.0.0-beta4</Version>
     <FileVersion>10.0.0.0</FileVersion>
     <AssemblyVersion>10.0.0.0</AssemblyVersion>
     <RootNamespace>JWT.Extensions.AspNetCore</RootNamespace>
@@ -30,8 +30,8 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Authentication" Version="2.2.0" />
-    <PackageReference Condition="$(DefineConstants.Contains(SYSTEM_TEXT_JSON))" Include="System.Text.Json" Version="6.0.4" />
-    <PackageReference Condition="$(DefineConstants.Contains(NEWTONSOFT_JSON))" Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Condition="$(DefineConstants.Contains(MODERN_DOTNET))" Include="System.Text.Json" Version="6.0.4" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/JWT.Extensions.DependencyInjection/JWT.Extensions.DependencyInjection.csproj b/src/JWT.Extensions.DependencyInjection/JWT.Extensions.DependencyInjection.csproj
@@ -11,7 +11,7 @@
     <Authors>Alexander Batishchev</Authors>
     <PackageTags>jwt;json;asp.net;asp.net core;.net core;authorization;dependenсy injection</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <Version>2.2.0-beta3</Version>
+    <Version>2.2.0-beta4</Version>
     <FileVersion>2.0.0.0</FileVersion>
     <AssemblyVersion>2.0.0.0</AssemblyVersion>
     <RootNamespace>JWT</RootNamespace>
@@ -30,8 +30,8 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.1.25" />
-    <PackageReference Condition="$(DefineConstants.Contains(SYSTEM_TEXT_JSON))" Include="System.Text.Json" Version="6.0.4" />
-    <PackageReference Condition="$(DefineConstants.Contains(NEWTONSOFT_JSON))" Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Condition="$(DefineConstants.Contains(MODERN_DOTNET))" Include="System.Text.Json" Version="6.0.4" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/JWT.Extensions.DependencyInjection/ServiceCollectionExtensions.cs b/src/JWT.Extensions.DependencyInjection/ServiceCollectionExtensions.cs
@@ -1,23 +1,19 @@
 using System;
 using JWT.Algorithms;
 using JWT.Internal;
+using JWT.Serializers;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 
-#if SYSTEM_TEXT_JSON
-using JsonSerializer = JWT.Serializers.SystemTextSerializer;
-#elif NEWTONSOFT_JSON
-using JsonSerializer = JWT.Serializers.JsonNetSerializer;
-#endif
-
 namespace JWT
 {
     public static class ServiceCollectionExtensions
     {
         public static IServiceCollection AddJwtEncoder(this IServiceCollection services)
         {
             services.TryAddSingleton<IJwtEncoder, JwtEncoder>();
-            services.TryAddSingleton<IJsonSerializer, JsonSerializer>();
+            services.TryAddSingleton<IJsonSerializerFactory, DefaultJsonSerializerFactory>();
+            services.TryAddSingleton<IJsonSerializer>(p => p.GetRequiredService<IJsonSerializerFactory>().Create());
             services.TryAddSingleton<IBase64UrlEncoder, JwtBase64UrlEncoder>();
 
             return services;
@@ -44,7 +40,8 @@ private static IServiceCollection AddJwtEncoder<TFactory>(this IServiceCollectio
         public static IServiceCollection AddJwtDecoder(this IServiceCollection services)
         {
             services.TryAddSingleton<IJwtDecoder, JwtDecoder>();
-            services.TryAddSingleton<IJsonSerializer, JsonSerializer>();
+            services.TryAddSingleton<IJsonSerializerFactory, DefaultJsonSerializerFactory>();
+            services.TryAddSingleton<IJsonSerializer>(p => p.GetRequiredService<IJsonSerializerFactory>().Create());
             services.TryAddSingleton<IJwtValidator, JwtValidator>();
             services.TryAddSingleton<IBase64UrlEncoder, JwtBase64UrlEncoder>();
             services.TryAddSingleton<IDateTimeProvider, UtcDatetimeProvider>();
@@ -60,4 +57,4 @@ public static IServiceCollection AddJwtDecoder<TFactory>(this IServiceCollection
             return services.AddJwtDecoder();
         }
     }
-}
+}
diff --git a/src/JWT/Algorithms/DelegateAlgorithmFactory.cs b/src/JWT/Algorithms/DelegateAlgorithmFactory.cs
@@ -20,16 +20,15 @@ public DelegateAlgorithmFactory(Func<IJwtAlgorithm> algFactory) =>
         /// Creates an instance of <see cref="DelegateAlgorithmFactory" /> with supplied algorithm.
         /// </summary>
         /// <exception cref="ArgumentNullException" />
-        public DelegateAlgorithmFactory(IJwtAlgorithm algorithm)
+        public DelegateAlgorithmFactory(IJwtAlgorithm algorithm) :
+            this(() => algorithm)
         {
             if (algorithm is null)
                 throw new ArgumentNullException(nameof(algorithm));
-
-            _algFactory = () => algorithm;
         }
 
         /// <inheritdoc />
         public IJwtAlgorithm Create(JwtDecoderContext context) =>
             _algFactory();
     }
-}
+}
diff --git a/src/JWT/Builder/JwtBuilder.cs b/src/JWT/Builder/JwtBuilder.cs
@@ -2,9 +2,8 @@
 using System.Linq;
 using System.Reflection;
 using JWT.Algorithms;
-
+using JWT.Serializers;
 using static JWT.Internal.EncodingHelper;
-using static JWT.Serializers.JsonSerializerFactory;
 
 namespace JWT.Builder
 {
@@ -19,7 +18,8 @@ public sealed class JwtBuilder
         private IJwtDecoder _decoder;
         private IJwtValidator _validator;
 
-        private IJsonSerializer _serializer = CreateSerializer();
+        private IJsonSerializerFactory _jsonSerializerFactory = new DefaultJsonSerializerFactory();
+
         private IBase64UrlEncoder _urlEncoder = new JwtBase64UrlEncoder();
         private IDateTimeProvider _dateTimeProvider = new UtcDateTimeProvider();
         private ValidationParameters _valParams = ValidationParameters.Default;
@@ -75,9 +75,23 @@ public JwtBuilder AddClaim(string name, object value)
         /// Sets JWT serializer.
         /// </summary>
         /// <returns>Current builder instance</returns>
-        public JwtBuilder WithSerializer(IJsonSerializer serializer)
+        public JwtBuilder WithJsonSerializer(IJsonSerializer serializer) =>
+            WithJsonSerializerFactory(new DelegateJsonSerializerFactory(serializer));
+
+        /// <summary>
+        /// Sets JWT serializer.
+        /// </summary>
+        /// <returns>Current builder instance</returns>
+        public JwtBuilder WithJsonSerializer(Func<IJsonSerializer> factory) =>
+            WithJsonSerializerFactory(new DelegateJsonSerializerFactory(factory));
+
+        /// <summary>
+        /// Sets JWT serializer factory.
+        /// </summary>
+        /// <returns>Current builder instance</returns>
+        public JwtBuilder WithJsonSerializerFactory(IJsonSerializerFactory jsonSerializerFactory)
         {
-            _serializer = serializer;
+            _jsonSerializerFactory = jsonSerializerFactory;
             return this;
         }
 
@@ -321,55 +335,60 @@ private void TryCreateEncoder()
         {
             if (_algorithm is null && _algFactory is null)
                 throw new InvalidOperationException($"Can't instantiate {nameof(JwtEncoder)}. Call {nameof(WithAlgorithm)}.");
-            if (_serializer is null)
-                throw new InvalidOperationException($"Can't instantiate {nameof(JwtEncoder)}. Call {nameof(WithSerializer)}");
+
+            var jsonSerializer = _jsonSerializerFactory.Create();
+            if (jsonSerializer is null)
+                throw new InvalidOperationException($"Can't instantiate {nameof(JwtEncoder)}. Call {nameof(WithJsonSerializer)}");
             if (_urlEncoder is null)
                 throw new InvalidOperationException($"Can't instantiate {nameof(JwtEncoder)}. Call {nameof(WithUrlEncoder)}.");
 
             if (_algorithm is object)
-                _encoder = new JwtEncoder(_algorithm, _serializer, _urlEncoder);
+                _encoder = new JwtEncoder(_algorithm, jsonSerializer, _urlEncoder);
             else if (_algFactory is object)
-                _encoder = new JwtEncoder(_algFactory, _serializer, _urlEncoder);
+                _encoder = new JwtEncoder(_algFactory, jsonSerializer, _urlEncoder);
         }
 
         private void TryCreateDecoder()
         {
             TryCreateValidator();
 
-            if (_serializer is null)
-                throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithSerializer)}.");
+            var jsonSerializer = _jsonSerializerFactory.Create();
+            if (jsonSerializer is null)
+                throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithJsonSerializer)}.");
             if (_urlEncoder is null)
                 throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithUrlEncoder)}.");
 
             if (_algorithm is object)
-                _decoder = new JwtDecoder(_serializer, _validator, _urlEncoder, _algorithm);
+                _decoder = new JwtDecoder(jsonSerializer, _validator, _urlEncoder, _algorithm);
             else if (_algFactory is object)
-                _decoder = new JwtDecoder(_serializer, _validator, _urlEncoder, _algFactory);
+                _decoder = new JwtDecoder(jsonSerializer, _validator, _urlEncoder, _algFactory);
             else if (!_valParams.ValidateSignature)
-                _decoder = new JwtDecoder(_serializer, _urlEncoder);
+                _decoder = new JwtDecoder(jsonSerializer, _urlEncoder);
         }
 
         private void TryCreateDecoderForHeader()
         {
-            if (_serializer is null)
-                throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithSerializer)}.");
+            var jsonSerializer = _jsonSerializerFactory.Create();
+            if (jsonSerializer is null)
+                throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithJsonSerializer)}.");
             if (_urlEncoder is null)
                 throw new InvalidOperationException($"Can't instantiate {nameof(JwtDecoder)}. Call {nameof(WithUrlEncoder)}.");
 
-            _decoder = new JwtDecoder(_serializer, _urlEncoder);
+            _decoder = new JwtDecoder(jsonSerializer, _urlEncoder);
         }
 
         private void TryCreateValidator()
         {
             if (_validator is object)
                 return;
 
-            if (_serializer is null)
-                throw new InvalidOperationException($"Can't instantiate {nameof(JwtValidator)}. Call {nameof(WithSerializer)}.");
+            var jsonSerializer = _jsonSerializerFactory.Create();
+            if (jsonSerializer is null)
+                throw new InvalidOperationException($"Can't instantiate {nameof(JwtValidator)}. Call {nameof(WithJsonSerializer)}.");
             if (_dateTimeProvider is null)
                 throw new InvalidOperationException($"Can't instantiate {nameof(JwtValidator)}. Call {nameof(WithDateTimeProvider)}.");
 
-            _validator = new JwtValidator(_serializer, _dateTimeProvider, _valParams);
+            _validator = new JwtValidator(jsonSerializer, _dateTimeProvider, _valParams);
         }
 
         private void EnsureCanEncode()
@@ -382,7 +401,7 @@ private void EnsureCanEncode()
                 throw new InvalidOperationException(
                     "Can't encode a token. Check if you have called all of the following methods:" + Environment.NewLine +
                     $"-{nameof(WithAlgorithm)}" + Environment.NewLine +
-                    $"-{nameof(WithSerializer)}" + Environment.NewLine +
+                    $"-{nameof(WithJsonSerializer)}" + Environment.NewLine +
                     $"-{nameof(WithUrlEncoder)}.");
             }
         }
@@ -396,7 +415,7 @@ private void EnsureCanDecode()
             {
                 throw new InvalidOperationException(
                     "Can't decode a token. Check if you have called all of the following methods:" + Environment.NewLine +
-                    $"-{nameof(WithSerializer)}" + Environment.NewLine +
+                    $"-{nameof(WithJsonSerializer)}" + Environment.NewLine +
                     $"-{nameof(WithValidator)}" + Environment.NewLine +
                     $"-{nameof(WithUrlEncoder)}.");
             }
@@ -411,7 +430,7 @@ private void EnsureCanDecodeHeader()
             {
                 throw new InvalidOperationException(
                     "Can't decode a token header. Check if you have called all of the following methods:" + Environment.NewLine +
-                    $"-{nameof(WithSerializer)}" + Environment.NewLine +
+                    $"-{nameof(WithJsonSerializer)}" + Environment.NewLine +
                     $"-{nameof(WithUrlEncoder)}.");
             }
         }
@@ -421,7 +440,7 @@ private void EnsureCanDecodeHeader()
         /// </summary>
         private bool CanEncode() =>
             (_algorithm is object || _algFactory is object) &&
-            _serializer is object &&
+            _jsonSerializerFactory is object &&
             _urlEncoder is object &&
             _jwt.Payload is object;
 
@@ -444,7 +463,7 @@ private bool CanDecodeHeader()
             if (_urlEncoder is null)
                 return false;
 
-            if (_serializer is null)
+            if (_jsonSerializerFactory is null)
                 return false;
 
             return true;

diff --git a/src/JWT/Builder/JwtHeader.cs b/src/JWT/Builder/JwtHeader.cs
@@ -1,6 +1,6 @@
-#if SYSTEM_TEXT_JSON
+#if MODERN_DOTNET
 using JsonProperty = System.Text.Json.Serialization.JsonPropertyNameAttribute;
-#elif NEWTONSOFT_JSON
+#else
 using Newtonsoft.Json;
 #endif
 

diff --git a/src/JWT/JWT.csproj b/src/JWT/JWT.csproj
@@ -20,7 +20,7 @@
     <Authors>Alexander Batishchev, John Sheehan, Michael Lehenbauer</Authors>
     <PackageTags>jwt;json;authorization</PackageTags>
     <PackageLicenseExpression>CC0-1.0</PackageLicenseExpression>
-    <Version>10.0.0-beta6</Version>
+    <Version>10.0.0-beta7</Version>
     <FileVersion>10.0.0.0</FileVersion>
     <AssemblyVersion>10.0.0.0</AssemblyVersion>
     <RootNamespace>JWT</RootNamespace>
@@ -38,8 +38,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Condition="$(DefineConstants.Contains(SYSTEM_TEXT_JSON))" Include="System.Text.Json" Version="6.0.4" />
-    <PackageReference Condition="$(DefineConstants.Contains(NEWTONSOFT_JSON))" Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Condition="$(DefineConstants.Contains(MODERN_DOTNET))" Include="System.Text.Json" Version="6.0.4" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard1.3' OR '$(TargetFramework)' == 'netstandard2.0'">

diff --git a/src/JWT/Serializers/Converters/DictionaryStringObjectJsonConverter.cs b/src/JWT/Serializers/Converters/DictionaryStringObjectJsonConverter.cs
@@ -1,4 +1,4 @@
-#if SYSTEM_TEXT_JSON
+#if MODERN_DOTNET
 using System;
 using System.Collections.Generic;
 using System.Linq;

diff --git a/src/JWT/Serializers/DefaultJsonSerializerFactory.cs b/src/JWT/Serializers/DefaultJsonSerializerFactory.cs
@@ -0,0 +1,19 @@
+namespace JWT.Serializers
+{
+    public sealed class DefaultJsonSerializerFactory : IJsonSerializerFactory
+    {
+        private readonly IJsonSerializer _jsonSerializer;
+
+        public DefaultJsonSerializerFactory()
+        {
+#if MODERN_DOTNET
+            _jsonSerializer = new SystemTextSerializer();
+#else
+            _jsonSerializer = new JsonNetSerializer();
+#endif
+        }
+
+        public IJsonSerializer Create() =>
+            _jsonSerializer;
+    }
+}
diff --git a/src/JWT/Serializers/DelegateJsonSerializerFactory.cs b/src/JWT/Serializers/DelegateJsonSerializerFactory.cs
@@ -0,0 +1,29 @@
+using System;
+
+namespace JWT.Serializers
+{
+    internal sealed class DelegateJsonSerializerFactory : IJsonSerializerFactory
+    {
+        private readonly Func<IJsonSerializer> _factory;
+
+        public DelegateJsonSerializerFactory(IJsonSerializer jsonSerializer) :
+            this(() => jsonSerializer)
+        {
+            if (jsonSerializer is null)
+                throw new ArgumentNullException(nameof(jsonSerializer));
+        }
+
+        public DelegateJsonSerializerFactory(IJsonSerializerFactory factory) :
+            this(() => factory.Create())
+        {
+            if (factory is null)
+                throw new ArgumentNullException(nameof(factory));
+        }
+
+        public DelegateJsonSerializerFactory(Func<IJsonSerializer> factory) =>
+            _factory = factory ?? throw new ArgumentNullException(nameof(factory));
+
+        public IJsonSerializer Create() =>
+            _factory();
+    }
+}
diff --git a/src/JWT/Serializers/IJsonSerializerFactory.cs b/src/JWT/Serializers/IJsonSerializerFactory.cs
@@ -0,0 +1,7 @@
+namespace JWT.Serializers
+{
+    public interface IJsonSerializerFactory
+    {
+        IJsonSerializer Create();
+    }
+}
diff --git a/src/JWT/Serializers/JsonNetSerializer.cs b/src/JWT/Serializers/JsonNetSerializer.cs
@@ -1,5 +1,4 @@
-#if NEWTONSOFT_JSON
-using System;
+using System;
 using System.IO;
 using System.Text;
 using Newtonsoft.Json;
@@ -61,4 +60,3 @@ public object Deserialize(Type type, string json)
         }
     }
 }
-#endif