// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT License. // See the LICENSE file in the project root for more information. using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Linq; using System.Linq.Expressions; using System.Reactive.Joins; using System.Reactive.Linq; using System.Reflection; namespace System.Reactive { #if HAS_TRIMMABILITY_ATTRIBUTES [RequiresUnreferencedCode(Constants_Core.AsQueryableTrimIncompatibilityMessage)] #endif internal class ObservableQueryProvider : IQbservableProvider, IQueryProvider { public IQbservable CreateQuery(Expression expression) { if (expression == null) { throw new ArgumentNullException(nameof(expression)); } if (!typeof(IObservable).IsAssignableFrom(expression.Type)) { throw new ArgumentException(Strings_Providers.INVALID_TREE_TYPE, nameof(expression)); } return new ObservableQuery(expression); } IQueryable IQueryProvider.CreateQuery(Expression expression) { // // Here we're on the edge between IQbservable and IQueryable for the local // execution case. E.g.: // // observable.AsQbservable()..ToQueryable() // // This should be turned into a local execution, with the push-to-pull // adapter in the middle, so we rewrite to: // // observable.AsQbservable()..ToEnumerable().AsQueryable() // if (expression is not MethodCallExpression call || call.Method.DeclaringType != typeof(Qbservable) || call.Method.Name != nameof(Qbservable.ToQueryable)) { throw new ArgumentException(Strings_Providers.EXPECTED_TOQUERYABLE_METHODCALL, nameof(expression)); } // // This is the IQbservable object corresponding to the lhs. Now wrap // it in two calls to get the local queryable. // var arg0 = call.Arguments[0]; var res = Expression.Call( AsQueryable.MakeGenericMethod(typeof(TElement)), Expression.Call( typeof(Observable).GetMethod(nameof(Observable.ToEnumerable))!.MakeGenericMethod(typeof(TElement)), arg0 ) ); // // Queryable operator calls should be taken care of by the provider for // LINQ to Objects. So we compile and get the resulting IQueryable // back to hand it out. // return Expression.Lambda>>(res).Compile()(); } private static MethodInfo? _staticAsQueryable; private static MethodInfo AsQueryable => _staticAsQueryable ??= Qbservable.InfoOf(() => Queryable.AsQueryable(null!)).GetGenericMethodDefinition(); IQueryable IQueryProvider.CreateQuery(Expression expression) { throw new NotImplementedException(); } TResult IQueryProvider.Execute(Expression expression) { throw new NotImplementedException(); } object IQueryProvider.Execute(Expression expression) { throw new NotImplementedException(); } } #if HAS_TRIMMABILITY_ATTRIBUTES [RequiresUnreferencedCode(Constants_Core.AsQueryableTrimIncompatibilityMessage)] #endif internal class ObservableQuery { protected object? _source; protected Expression _expression; public ObservableQuery(object source) { _source = source; _expression = Expression.Constant(this); } public ObservableQuery(Expression expression) { _expression = expression; } public object? Source => _source; public Expression Expression => _expression; } #if HAS_TRIMMABILITY_ATTRIBUTES [RequiresUnreferencedCode(Constants_Core.AsQueryableTrimIncompatibilityMessage)] #endif internal class ObservableQuery : ObservableQuery, IQbservable { internal ObservableQuery(IObservable source) : base(source) { } internal ObservableQuery(Expression expression) : base(expression) { } public Type ElementType => typeof(TSource); public IQbservableProvider Provider => Qbservable.Provider; public IDisposable Subscribe(IObserver observer) { if (_source == null) { var rewriter = new ObservableRewriter(); var body = rewriter.Visit(_expression); var f = Expression.Lambda>>(body); _source = f.Compile()(); } // // [OK] Use of unsafe Subscribe: non-pretentious mapping to IObservable behavior equivalent to the expression tree. // return ((IObservable)_source).Subscribe/*Unsafe*/(observer); } public override string? ToString() { if (_expression is ConstantExpression c && c.Value == this) { if (_source != null) { return _source.ToString(); } return "null"; } return _expression.ToString(); } #if HAS_TRIMMABILITY_ATTRIBUTES [RequiresUnreferencedCode(Constants_Core.AsQueryableTrimIncompatibilityMessage)] #endif private class ObservableRewriter : ExpressionVisitor { protected override Expression VisitConstant(ConstantExpression/*!*/ node) { if (node.Value is ObservableQuery query) { var source = query.Source; if (source != null) { return Expression.Constant(source); } return Visit(query.Expression); } return node; } protected override Expression VisitMethodCall(MethodCallExpression/*!*/ node) { var method = node.Method; var declaringType = method.DeclaringType; var baseType = declaringType?.BaseType; if (baseType == typeof(QueryablePattern)) { if (method.Name == "Then") { // // Retarget Then to the corresponding pattern. Recursive visit of the lhs will rewrite // the chain of And operators. // var pattern = Visit(node.Object); var arguments = node.Arguments.Select(arg => Unquote(Visit(arg))).ToArray(); var then = Expression.Call(pattern!, method.Name, method.GetGenericArguments(), arguments); return then; } if (method.Name == "And") { // // Retarget And to the corresponding pattern. // var lhs = Visit(node.Object); var arguments = node.Arguments.Select(arg => Visit(arg)).ToArray(); var and = Expression.Call(lhs!, method.Name, method.GetGenericArguments(), arguments); return and; } } else { var arguments = node.Arguments.AsEnumerable(); // // Checking for an IQbservable operator, being either: // - an extension method on IQbservableProvider // - an extension method on IQbservable // var isOperator = false; var firstParameter = method.GetParameters().FirstOrDefault(); if (firstParameter != null) { var firstParameterType = firstParameter.ParameterType; // // Operators like Qbservable.Amb have an n-ary form that take in an IQbservableProvider // as the first argument. In such a case we need to make sure that the given provider is // the one targeting regular Observable. If not, we keep the subtree as-is and let that // provider handle the execution. // if (firstParameterType == typeof(IQbservableProvider)) { isOperator = true; // // Since we could be inside a lambda expression where one tries to obtain a query // provider, or that provider could be stored in an outer variable, we need to // evaluate the expression to obtain an IQbservableProvider object. // var provider = Expression.Lambda>(Visit(node.Arguments[0])).Compile()(); // // Let's see whether the ObservableQuery provider is targeted. This one always goes // to local execution. E.g.: // // var xs = Observable.Return(1).AsQbservable(); // var ys = Observable.Return(2).AsQbservable(); // var zs = Observable.Return(3).AsQbservable(); // // var res = Qbservable.Provider.Amb(xs, ys, zs); // ^^^^^^^^^^^^^^^^^^^ // if (provider is ObservableQueryProvider) { // // For further rewrite, simply ignore the query provider argument now to match // up with the Observable signature. E.g.: // // var res = Qbservable.Provider.Amb(xs, ys, zs); // = Qbservable.Amb(Qbservable.Provider, xs, ys, zs)' // ^^^^^^^^^^^^^^^^^^^ // -> // var res = Observable.Amb(xs, ys, zs); // arguments = arguments.Skip(1); } else { // // We've hit an unknown provider and will defer further execution to it. Upon // calling Subscribe to the node's output, that provider will take care of it. // return node; } } else if (typeof(IQbservable).IsAssignableFrom(firstParameterType)) { isOperator = true; } } if (isOperator) { var args = VisitQbservableOperatorArguments(method, arguments); return FindObservableMethod(method, args); } } return base.VisitMethodCall(node); } protected override Expression VisitLambda(Expression node) { return node; } private IList VisitQbservableOperatorArguments(MethodInfo method, IEnumerable arguments) { // // Recognize the Qbservable.When(IQbservableProvider, QueryablePlan[]) // overload in order to substitute the array with a Plan[]. // if (method.Name == "When") { #pragma warning disable CA1851 // (Possible multiple enumerations of 'IEnumerable'.) Simple fixes could actually make things worse (e.g., by making an unnecessary copy), so unless specific perf issues become apparent here, we will tolerate this. var lastArgument = arguments.Last(); #pragma warning restore CA1851 if (lastArgument.NodeType == ExpressionType.NewArrayInit) { var paramsArray = (NewArrayExpression)lastArgument; return new List { Expression.NewArrayInit( typeof(Plan<>).MakeGenericType(method.GetGenericArguments()[0]), paramsArray.Expressions.Select(param => Visit(param)) ) }; } } #pragma warning disable CA1851 // Possible multiple enumerations of 'IEnumerable' collection return arguments.Select(arg => Visit(arg)).ToList(); #pragma warning restore CA1851 } private class Lazy { private readonly Func _factory; private T? _value; private bool _initialized; public Lazy(Func factory) { _factory = factory; } public T Value { get { lock (_factory) { if (!_initialized) { _value = _factory(); _initialized = true; } } return _value!; } } } private static readonly Lazy> ObservableMethods = new(() => GetMethods(typeof(Observable))); private static MethodCallExpression FindObservableMethod(MethodInfo method, IList arguments) { // // Where to look for the matching operator? // Type targetType; ILookup methods; if (method.DeclaringType == typeof(Qbservable)) { targetType = typeof(Observable); methods = ObservableMethods.Value; } else { targetType = method.DeclaringType!; // NB: These methods were found from a declaring type. if (targetType.IsDefined(typeof(LocalQueryMethodImplementationTypeAttribute), false)) { var mapping = (LocalQueryMethodImplementationTypeAttribute)targetType.GetCustomAttributes(typeof(LocalQueryMethodImplementationTypeAttribute), false)[0]; targetType = mapping.TargetType; } methods = GetMethods(targetType); } // // From all the operators with the method's name, find the one that matches all arguments. // var typeArgs = method.IsGenericMethod ? method.GetGenericArguments() : null; var targetMethod = methods[method.Name].FirstOrDefault(candidateMethod => ArgsMatch(candidateMethod, arguments, typeArgs)) ?? throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, Strings_Providers.NO_MATCHING_METHOD_FOUND, method.Name, targetType.Name)); // // Restore generic arguments. // if (typeArgs != null) { targetMethod = targetMethod.MakeGenericMethod(typeArgs); } // // Finally, we need to deal with mismatches on Expression> versus Func<...>. // var parameters = targetMethod.GetParameters(); for (int i = 0, n = parameters.Length; i < n; i++) { arguments[i] = Unquote(arguments[i]); } // // Emit a new call to the discovered target method. // return Expression.Call(null, targetMethod, arguments); } private static ILookup GetMethods(Type type) { return type.GetTypeInfo().DeclaredMethods.Where(m => m.IsStatic && m.IsPublic).ToLookup(m => m.Name); } private static bool ArgsMatch(MethodInfo method, IList arguments, Type[]? typeArgs) { // // Number of parameters should match. Notice we've sanitized IQbservableProvider "this" // parameters first (see VisitMethodCall). // var parameters = method.GetParameters(); if (parameters.Length != arguments.Count) { return false; } // // Genericity should match too. // if (!method.IsGenericMethod && typeArgs != null && typeArgs.Length > 0) { return false; } // // Reconstruct the generic method if needed. // if (method.IsGenericMethodDefinition) { if (typeArgs == null) { return false; } if (method.GetGenericArguments().Length != typeArgs.Length) { return false; } var result = method.MakeGenericMethod(typeArgs); parameters = result.GetParameters(); } // // Check compatibility for the parameter types. // for (int i = 0, n = arguments.Count; i < n; i++) { var parameterType = parameters[i].ParameterType; var argument = arguments[i]; // // For operators that take a function (like Where, Select), we'll be faced // with a quoted argument and a discrepancy between Expression> // and the underlying Func<...>. // if (!parameterType.IsAssignableFrom(argument.Type)) { argument = Unquote(argument); if (!parameterType.IsAssignableFrom(argument.Type)) { return false; } } } return true; } private static Expression Unquote(Expression expression) { // // Get rid of all outer quotes around an expression. // while (expression.NodeType == ExpressionType.Quote) { expression = ((UnaryExpression)expression).Operand; } return expression; } } } }