Plugin support for EvaluatableExpressionFilter

src/EFCore/Infrastructure/EntityFrameworkServicesBuilder.cs

@@ -134,6 +134,7 @@ public static readonly IDictionary<Type, ServiceCharacteristics> CoreServices
                 { typeof(ILazyLoader), new ServiceCharacteristics(ServiceLifetime.Transient) },
                 { typeof(IParameterBindingFactory), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
                 { typeof(ITypeMappingSourcePlugin), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
+                { typeof(IEvaluatableExpressionFilterPlugin), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
                 { typeof(ISingletonOptions), new ServiceCharacteristics(ServiceLifetime.Singleton, multipleRegistrations: true) },
                 { typeof(IConventionSetPlugin), new ServiceCharacteristics(ServiceLifetime.Scoped, multipleRegistrations: true) },
                 { typeof(IResettableService), new ServiceCharacteristics(ServiceLifetime.Scoped, multipleRegistrations: true) }

src/EFCore/Query/EvaluatableExpressionFilter.cs

@@ -21,7 +21,7 @@ namespace Microsoft.EntityFrameworkCore.Query
     ///         This service cannot depend on services registered as <see cref="ServiceLifetime.Scoped" />.
     ///     </para>
     /// </summary>
-    public class EvaluatableExpressionFilter : IEvaluatableExpressionFilter
+    public class EvaluatableExpressionFilter : EvaluatableExpressionFilterBase
     {
         // This methods are non-deterministic and result varies based on time of running the query.
         // Hence we don't evaluate them. See issue#2069
@@ -53,11 +53,6 @@ private static readonly MethodInfo _randomNextOneArg
         private static readonly MethodInfo _randomNextTwoArgs
             = typeof(Random).GetRuntimeMethod(nameof(Random.Next), new[] { typeof(int), typeof(int) });
 
-        /// <summary>
-        ///     Parameter object containing dependencies for this service.
-        /// </summary>
-        protected virtual EvaluatableExpressionFilterDependencies Dependencies { get; }
-
         /// <summary>
         ///     <para>
         ///         Creates a new <see cref="EvaluatableExpressionFilter" /> instance.
@@ -70,10 +65,8 @@ private static readonly MethodInfo _randomNextTwoArgs
         /// <param name="dependencies"> The dependencies to use. </param>
         public EvaluatableExpressionFilter(
             [NotNull] EvaluatableExpressionFilterDependencies dependencies)
+            : base(dependencies)
         {
-            Check.NotNull(dependencies, nameof(dependencies));
-
-            Dependencies = dependencies;
         }
 
         /// <summary>
@@ -82,7 +75,7 @@ public EvaluatableExpressionFilter(
         /// <param name="expression"> The expression. </param>
         /// <param name="model"> The model. </param>
         /// <returns> True if the expression can be evaluated; false otherwise. </returns>
-        public virtual bool IsEvaluatableExpression(Expression expression, IModel model)
+        public override bool IsEvaluatableExpression(Expression expression, IModel model)
         {
             Check.NotNull(expression, nameof(expression));
             Check.NotNull(model, nameof(model));
@@ -116,7 +109,7 @@ public virtual bool IsEvaluatableExpression(Expression expression, IModel model)
                     break;
             }
 
-            return true;
+            return base.IsEvaluatableExpression(expression, model);
         }
     }
 }

src/EFCore/Query/EvaluatableExpressionFilterBase.cs

@@ -0,0 +1,72 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Linq;
+using System.Linq.Expressions;
+using System.Reflection;
+using JetBrains.Annotations;
+using Microsoft.EntityFrameworkCore.Metadata;
+using Microsoft.EntityFrameworkCore.Utilities;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Microsoft.EntityFrameworkCore.Query
+{
+    /// <summary>
+    ///     <para>
+    ///         Represents a filter for evaluatable expressions.
+    ///     </para>
+    ///     <para>
+    ///         The service lifetime is <see cref="ServiceLifetime.Singleton" />. This means a single instance
+    ///         is used by many <see cref="DbContext" /> instances. The implementation must be thread-safe.
+    ///         This service cannot depend on services registered as <see cref="ServiceLifetime.Scoped" />.
+    ///     </para>
+    /// </summary>
+    public class EvaluatableExpressionFilterBase : IEvaluatableExpressionFilter
+    {
+        /// <summary>
+        ///     Parameter object containing dependencies for this service.
+        /// </summary>
+        protected virtual EvaluatableExpressionFilterDependencies Dependencies { get; }
+
+        /// <summary>
+        ///     <para>
+        ///         Creates a new <see cref="EvaluatableExpressionFilter" /> instance.
+        ///     </para>
+        ///     <para>
+        ///         This type is typically used by database providers (and other extensions). It is generally
+        ///         not used in application code.
+        ///     </para>
+        /// </summary>
+        /// <param name="dependencies"> The dependencies to use. </param>
+        public EvaluatableExpressionFilterBase(
+            [NotNull] EvaluatableExpressionFilterDependencies dependencies)
+        {
+            Check.NotNull(dependencies, nameof(dependencies));
+
+            Dependencies = dependencies;
+        }
+
+        /// <summary>
+        ///     Checks whether the given expression can be evaluated.
+        /// </summary>
+        /// <param name="expression"> The expression. </param>
+        /// <param name="model"> The model. </param>
+        /// <returns> True if the expression can be evaluated; false otherwise. </returns>
+        public virtual bool IsEvaluatableExpression(Expression expression, IModel model)
+        {
+            Check.NotNull(expression, nameof(expression));
+            Check.NotNull(model, nameof(model));
+
+            foreach (var plugin in Dependencies.Plugins)
+            {
+                if (!plugin.IsEvaluatableExpression(expression))
+                {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}

src/EFCore/Query/EvaluatableExpressionFilterDependencies.cs

@@ -1,7 +1,10 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System.Collections.Generic;
+using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.EntityFrameworkCore.Query
@@ -50,8 +53,24 @@ public sealed class EvaluatableExpressionFilterDependencies
         ///     </para>
         /// </summary>
         [EntityFrameworkInternal]
-        public EvaluatableExpressionFilterDependencies()
+        public EvaluatableExpressionFilterDependencies([NotNull] IEnumerable<IEvaluatableExpressionFilterPlugin> plugins)
         {
+            Check.NotNull(plugins, nameof(plugins));
+
+            Plugins = plugins;
         }
+
+        /// <summary>
+        ///     Gets the plugins.
+        /// </summary>
+        public IEnumerable<IEvaluatableExpressionFilterPlugin> Plugins { get; }
+
+        /// <summary>
+        ///     Clones this dependency parameter object with one service replaced.
+        /// </summary>
+        /// <param name="plugins"> A replacement for the current dependency of this type. </param>
+        /// <returns> A new parameter object with the given service replaced. </returns>
+        public EvaluatableExpressionFilterDependencies With([NotNull] IEnumerable<IEvaluatableExpressionFilterPlugin> plugins)
+            => new EvaluatableExpressionFilterDependencies(plugins);
     }
 }

src/EFCore/Query/IEvaluatableExpressionFilterPlugin.cs

@@ -0,0 +1,32 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using System.Linq.Expressions;
+using JetBrains.Annotations;
+using Microsoft.EntityFrameworkCore.Metadata;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Microsoft.EntityFrameworkCore.Query
+{
+    /// <summary>
+    ///     <para>
+    ///         Represents a plugin evaluatable expression filter.
+    ///     </para>
+    ///     <para>
+    ///         The service lifetime is <see cref="ServiceLifetime.Singleton" /> and multiple registrations
+    ///         are allowed. This means a single instance of each service is used by many <see cref="DbContext" />
+    ///         instances. The implementation must be thread-safe.
+    ///         This service cannot depend on services registered as <see cref="ServiceLifetime.Scoped" />.
+    ///     </para>
+    /// </summary>
+    public interface IEvaluatableExpressionFilterPlugin
+    {
+        /// <summary>
+        ///     Checks whether the given expression can be evaluated.
+        /// </summary>
+        /// <param name="expression"> The expression. </param>
+        /// <returns> True if the expression can be evaluated; false otherwise. </returns>
+        bool IsEvaluatableExpression([NotNull] Expression expression);
+    }
+}