mvc integration

Author: dotarj

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/ControllerExtensions.cs

@@ -0,0 +1,55 @@
+// Copyright (c) Arjen Post. See License.txt and Notice.txt in the project root for license information.
+
+using System;
+using Newtonsoft.Json;
+
+namespace Microsoft.AspNetCore.Mvc
+{
+    public static class ControllerExtensions
+    {
+        /// <summary>
+        /// Creates a <see cref="PartialJsonResult"/> object that serializes the specified <paramref name="data"/> object
+        /// to JSON.
+        /// </summary>
+        /// <param name="controller">The controller instance.</param>
+        /// <param name="data">The object to serialize.</param>
+        /// <returns>The created <see cref="PartialJsonResult"/> that serializes the specified <paramref name="data"/>
+        /// to JSON format for the response.</returns>
+        public static PartialJsonResult PartialJson(this ControllerBase controller, object data)
+        {
+            if (controller == null)
+            {
+                throw new ArgumentNullException(nameof(controller));
+            }
+
+            return new PartialJsonResult(data);
+        }
+
+        /// <summary>
+        /// Creates a <see cref="PartialJsonResult"/> object that serializes the specified <paramref name="data"/> object
+        /// to JSON.
+        /// </summary>
+        /// <param name="controller">The controller instance.</param>
+        /// <param name="data">The object to serialize.</param>
+        /// <param name="serializerSettings">The <see cref="JsonSerializerSettings"/> to be used by
+        /// the formatter.</param>
+        /// <returns>The created <see cref="PartialJsonResult"/> that serializes the specified <paramref name="data"/>
+        /// as JSON format for the response.</returns>
+        /// <remarks>Callers should cache an instance of <see cref="JsonSerializerSettings"/> to avoid
+        /// recreating cached data with each call.</remarks>
+        public static PartialJsonResult PartialJson(this ControllerBase controller, object data, JsonSerializerSettings serializerSettings)
+        {
+            if (controller == null)
+            {
+                throw new ArgumentNullException(nameof(controller));
+            }
+
+            if (serializerSettings == null)
+            {
+                throw new ArgumentNullException(nameof(serializerSettings));
+            }
+
+            return new PartialJsonResult(data, serializerSettings);
+        }
+    }
+}

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/DependencyInjection/MvcPartialJsonMvcBuilderExtensions.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Arjen Post. See License.txt and Notice.txt in the project root for license information.
+
+using System;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
+using PartialResponse.AspNetCore.Mvc;
+using PartialResponse.AspNetCore.Mvc.Formatters.Json.Internal;
+
+namespace PartialResponse.Extensions.DependencyInjection
+{
+    public static class MvcPartialJsonMvcBuilderExtensions
+    {
+        public static IMvcBuilder AddPartialJsonFormatters(this IMvcBuilder builder)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            AddPartialJsonFormatterServices(builder.Services);
+            return builder;
+        }
+
+        public static IMvcBuilder AddPartialJsonFormatters(
+            this IMvcBuilder builder,
+            Action<JsonSerializerSettings> setupAction)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (setupAction == null)
+            {
+                throw new ArgumentNullException(nameof(setupAction));
+            }
+
+            AddPartialJsonFormatterServices(builder.Services);
+
+            builder.Services.Configure<MvcPartialJsonOptions>((options) => setupAction(options.SerializerSettings));
+
+            return builder;
+        }
+
+        /// <summary>
+        /// Adds configuration of <see cref="MvcPartialJsonOptions"/> for the application.
+        /// </summary>
+        /// <param name="builder">The <see cref="IMvcBuilder"/>.</param>
+        /// <param name="setupAction">The <see cref="MvcPartialJsonOptions"/> which need to be configured.</param>
+        /// <returns>The <see cref="IMvcBuilder"/>.</returns>
+        public static IMvcBuilder AddPartialJsonOptions(
+           this IMvcBuilder builder,
+           Action<MvcPartialJsonOptions> setupAction)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (setupAction == null)
+            {
+                throw new ArgumentNullException(nameof(setupAction));
+            }
+
+            builder.Services.Configure<MvcPartialJsonOptions>(setupAction);
+            return builder;
+        }
+
+        // Internal for testing.
+        internal static void AddPartialJsonFormatterServices(IServiceCollection services)
+        {
+            services.TryAddEnumerable(
+                ServiceDescriptor.Transient<IConfigureOptions<MvcOptions>, MvcPartialJsonMvcOptionsSetup>());
+            services.TryAddSingleton<PartialJsonResultExecutor>();
+        }
+    }
+}

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/DependencyInjection/MvcPartialJsonMvcCoreBuilderExtensions.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Arjen Post. See License.txt and Notice.txt in the project root for license information.
+
+using System;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
+using PartialResponse.AspNetCore.Mvc;
+using PartialResponse.AspNetCore.Mvc.Formatters.Json.Internal;
+
+namespace PartialResponse.Extensions.DependencyInjection
+{
+    public static class MvcPartialJsonMvcCoreBuilderExtensions
+    {
+        public static IMvcCoreBuilder AddPartialJsonFormatters(this IMvcCoreBuilder builder)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            AddPartialJsonFormatterServices(builder.Services);
+            return builder;
+        }
+
+        public static IMvcCoreBuilder AddPartialJsonFormatters(
+            this IMvcCoreBuilder builder,
+            Action<JsonSerializerSettings> setupAction)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (setupAction == null)
+            {
+                throw new ArgumentNullException(nameof(setupAction));
+            }
+
+            AddPartialJsonFormatterServices(builder.Services);
+
+            builder.Services.Configure<MvcPartialJsonOptions>((options) => setupAction(options.SerializerSettings));
+
+            return builder;
+        }
+
+        /// <summary>
+        /// Adds configuration of <see cref="MvcPartialJsonOptions"/> for the application.
+        /// </summary>
+        /// <param name="builder">The <see cref="IMvcCoreBuilder"/>.</param>
+        /// <param name="setupAction">The <see cref="MvcPartialJsonOptions"/> which need to be configured.</param>
+        /// <returns>The <see cref="IMvcCoreBuilder"/>.</returns>
+        public static IMvcCoreBuilder AddPartialJsonOptions(
+           this IMvcCoreBuilder builder,
+           Action<MvcPartialJsonOptions> setupAction)
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (setupAction == null)
+            {
+                throw new ArgumentNullException(nameof(setupAction));
+            }
+
+            builder.Services.Configure<MvcPartialJsonOptions>(setupAction);
+            return builder;
+        }
+
+        // Internal for testing.
+        internal static void AddPartialJsonFormatterServices(IServiceCollection services)
+        {
+            services.TryAddEnumerable(
+                ServiceDescriptor.Transient<IConfigureOptions<MvcOptions>, MvcPartialJsonMvcOptionsSetup>());
+            services.TryAddSingleton<PartialJsonResultExecutor>();
+        }
+    }
+}

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/Internal/MvcPartialJsonLoggerExtensions.cs

@@ -0,0 +1,25 @@
+// Copyright (c) Arjen Post. See License.txt and Notice.txt in the project root for license information.
+
+using System;
+using Microsoft.Extensions.Logging;
+
+namespace PartialResponse.AspNetCore.Mvc.Formatters.Json.Internal
+{
+    internal static class MvcPartialJsonLoggerExtensions
+    {
+        private static readonly Action<ILogger, string, Exception> _partialJsonResultExecuting;
+
+        static MvcPartialJsonLoggerExtensions()
+        {
+            _partialJsonResultExecuting = LoggerMessage.Define<string>(
+                LogLevel.Information,
+                1,
+                "Executing PartialJsonResult, writing value {Value}.");
+        }
+
+        public static void PartialJsonResultExecuting(this ILogger logger, object value)
+        {
+            _partialJsonResultExecuting(logger, Convert.ToString(value), null);
+        }
+    }
+}

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/Internal/MvcPartialJsonMvcOptionsSetup.cs

@@ -0,0 +1,69 @@
+// Copyright (c) Arjen Post. See License.txt and Notice.txt in the project root for license information.
+
+using System;
+using System.Buffers;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.ObjectPool;
+using Microsoft.Extensions.Options;
+using Microsoft.Net.Http.Headers;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace PartialResponse.AspNetCore.Mvc.Formatters.Json.Internal
+{
+    /// <summary>
+    /// Sets up JSON formatter options for <see cref="MvcOptions"/>.
+    /// </summary>
+    public class MvcPartialJsonMvcOptionsSetup : IConfigureOptions<MvcOptions>
+    {
+        private readonly ILoggerFactory _loggerFactory;
+        private readonly JsonSerializerSettings _jsonSerializerSettings;
+        private readonly ArrayPool<char> _charPool;
+        private readonly ObjectPoolProvider _objectPoolProvider;
+
+        public MvcPartialJsonMvcOptionsSetup(
+            ILoggerFactory loggerFactory,
+            IOptions<MvcPartialJsonOptions> partialJsonOptions,
+            ArrayPool<char> charPool,
+            ObjectPoolProvider objectPoolProvider)
+        {
+            if (loggerFactory == null)
+            {
+                throw new ArgumentNullException(nameof(loggerFactory));
+            }
+
+            if (partialJsonOptions == null)
+            {
+                throw new ArgumentNullException(nameof(partialJsonOptions));
+            }
+
+            if (charPool == null)
+            {
+                throw new ArgumentNullException(nameof(charPool));
+            }
+
+            if (objectPoolProvider == null)
+            {
+                throw new ArgumentNullException(nameof(objectPoolProvider));
+            }
+
+            _loggerFactory = loggerFactory;
+            _jsonSerializerSettings = partialJsonOptions.Value.SerializerSettings;
+            _charPool = charPool;
+            _objectPoolProvider = objectPoolProvider;
+        }
+
+        public void Configure(MvcOptions options)
+        {
+            options.OutputFormatters.Add(new PartialJsonOutputFormatter(_jsonSerializerSettings, _charPool));
+
+            // TODO: Remove?
+            options.FormatterMappings.SetMediaTypeMappingForFormat("json", MediaTypeHeaderValue.Parse("application/json"));
+
+            // TODO: Remove?
+            options.ModelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(JToken)));
+        }
+    }
+}