quantconnect--lean/Common/Exceptions/StackExceptionInterpreter.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/

using System;
using System.Linq;
using QuantConnect.Util;
using System.Reflection;
using QuantConnect.Logging;
using System.Collections.Generic;

namespace QuantConnect.Exceptions
{
    /// <summary>
    /// Interprets exceptions using the configured interpretations
    /// </summary>
    public class StackExceptionInterpreter : IExceptionInterpreter
    {
        private readonly List<IExceptionInterpreter> _interpreters;

        /// <summary>
        /// Stack interpreter instance
        /// </summary>
        public static readonly Lazy<StackExceptionInterpreter> Instance = new Lazy<StackExceptionInterpreter>(
            () => StackExceptionInterpreter.CreateFromAssemblies());

        /// <summary>
        /// Determines the order that an instance of this class should be called
        /// </summary>
        public int Order => 0;

        /// <summary>
        /// Initializes a new instance of the <see cref="StackExceptionInterpreter"/> class
        /// </summary>
        /// <param name="interpreters">The interpreters to use</param>
        public StackExceptionInterpreter(IEnumerable<IExceptionInterpreter> interpreters)
        {
            _interpreters = interpreters.OrderBy(x => x.Order).ToList();
        }

        /// <summary>
        /// Gets the interpreters loaded into this instance
        /// </summary>
        public IEnumerable<IExceptionInterpreter> Interpreters => _interpreters;

        /// <summary>
        /// Determines if this interpreter should be applied to the specified exception.
        /// </summary>
        /// <param name="exception">The exception to check</param>
        /// <returns>True if the exception can be interpreted, false otherwise</returns>
        public bool CanInterpret(Exception exception)
        {
            return _interpreters.Any(interpreter => interpreter.CanInterpret(exception));
        }

        /// <summary>
        /// Interprets the specified exception into a new exception
        /// </summary>
        /// <param name="exception">The exception to be interpreted</param>
        /// <param name="innerInterpreter">An interpreter that should be applied to the inner exception.
        /// This provides a link back allowing the inner exceptions to be interpreted using the intepretators
        /// configured in the <see cref="StackExceptionInterpreter"/>. Individual implementations *may* ignore
        /// this value if required.</param>
        /// <returns>The interpreted exception</returns>
        public Exception Interpret(Exception exception, IExceptionInterpreter innerInterpreter = null)
        {
            if (exception == null)
            {
                return null;
            }

            foreach (var interpreter in _interpreters)
            {
                try
                {
                    if (interpreter.CanInterpret(exception))
                    {
                        // use this instance to interpret inner exceptions as well, unless one was specified
                        return interpreter.Interpret(exception, innerInterpreter ?? this);
                    }
                }
                catch (Exception err)
                {
                    Log.Error(err);
                }
            }

            return exception;
        }

        /// <summary>
        /// Combines the exception messages from this exception and all inner exceptions.
        /// </summary>
        /// <param name="exception">The exception to create a collated message from</param>
        /// <returns>The collate exception message</returns>
        public string GetExceptionMessageHeader(Exception exception)
        {
            return string.Join(" ", InnersAndSelf(exception).Select(e => e.Message));
        }

        /// <summary>
        /// Creates a new <see cref="StackExceptionInterpreter"/> by loading implementations with default constructors from the specified assemblies
        /// </summary>
        /// <returns>A new <see cref="StackExceptionInterpreter"/> containing interpreters from the specified assemblies</returns>
        public static StackExceptionInterpreter CreateFromAssemblies()
        {
            var interpreters =
                // type implements IExceptionInterpreter
                from type in Composer.Instance.GetExportedTypes<IExceptionInterpreter>()
                // ignore non-public and non-instantiable abstract types
                // type has default parameterless ctor
                where type.IsPublic && !type.IsAbstract && type.GetConstructor([]) != null
                // provide guarantee of deterministic ordering
                orderby type.FullName
                select (IExceptionInterpreter) Activator.CreateInstance(type);

            var stackExceptionInterpreter = new StackExceptionInterpreter(interpreters);

            foreach (var interpreter in stackExceptionInterpreter.Interpreters)
            {
                Log.Debug(Messages.StackExceptionInterpreter.LoadedExceptionInterpreter(interpreter));
            }

            return stackExceptionInterpreter;
        }

        private IEnumerable<Exception> InnersAndSelf(Exception exception)
        {
            yield return exception;
            while (exception.InnerException != null)
            {
                exception = exception.InnerException;
                yield return exception;
            }
        }
    }
}