CSharpScriptCompilerEngine.cs

using System;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.CSharp.Scripting;
using Microsoft.CodeAnalysis.Scripting;
using ScriptCs.Contracts;
using ScriptCs.Exceptions;
using Microsoft.CodeAnalysis.Emit;

namespace ScriptCs.Engine.Roslyn
{
    public abstract class CSharpScriptCompilerEngine : CommonScriptEngine
    {
        private const string CompiledScriptClass = "Submission#0";
        private const string CompiledScriptMethod = "<Factory>";
        private readonly ILog _log;

        protected CSharpScriptCompilerEngine(IScriptHostFactory scriptHostFactory, ILogProvider logProvider)
            : base(scriptHostFactory, logProvider)
        {
            Guard.AgainstNullArgument("logProvider", logProvider);
            _log = logProvider.ForCurrentType();
        }

        protected abstract bool ShouldCompile();

        protected abstract Assembly LoadAssembly(byte[] exeBytes, byte[] pdbBytes);

        protected abstract Assembly LoadAssemblyFromCache();

        protected override ScriptResult Execute(string code, object globals, SessionState<ScriptState> sessionState)
        {
            return ShouldCompile()
                ? CompileAndExecute(code, globals)
                : InvokeEntryPointMethod(globals, LoadAssemblyFromCache());
        }

        protected override ScriptState GetScriptState(string code, object globals)
        {
            return null;
        }

        protected ScriptResult CompileAndExecute(string code, object globals)
        {
            _log.Debug("Compiling submission");
            try
            {
                var script = CSharpScript.Create(code, ScriptOptions, globals.GetType());
                var compilation = script.GetCompilation();

                using (var exeStream = new MemoryStream())
                using (var pdbStream = new MemoryStream())
                {
                    var result = compilation.Emit(exeStream, pdbStream: pdbStream, options: new EmitOptions().
                        WithDebugInformationFormat(GetPlatformSpecificDebugInformationFormat()));

                    if (result.Success)
                    {
                        _log.Debug("Compilation was successful.");

                        var assembly = LoadAssembly(exeStream.ToArray(), pdbStream.ToArray());
                        return InvokeEntryPointMethod(globals, assembly);
                    }

                    var errors = string.Join(Environment.NewLine, result.Diagnostics.Select(x => x.ToString()));

                    _log.ErrorFormat("Error occurred when compiling: {0})", errors);

                    return new ScriptResult(compilationException: new ScriptCompilationException(errors));
                }
            }
            catch (Exception compileException)
            {
                //we catch Exception rather than CompilationErrorException because there might be issues with assembly loading too
                return new ScriptResult(compilationException: new ScriptCompilationException(compileException.Message, compileException));
            }
        }

        private ScriptResult InvokeEntryPointMethod(object globals, Assembly assembly)
        {
            _log.Debug("Retrieving compiled script class (reflection).");

            // the following line can throw NullReferenceException, if that happens it's useful to notify that an error ocurred
            var type = assembly.GetType(CompiledScriptClass);
            _log.Debug("Retrieving compiled script method (reflection).");
            var method = type.GetMethod(CompiledScriptMethod, BindingFlags.Static | BindingFlags.Public);

            try
            {
                _log.Debug("Invoking method.");
                var submissionStates = new object[2];
                submissionStates[0] = globals;
                var result = method.Invoke(null, new[] {submissionStates}) as Task<object>;
                return new ScriptResult(returnValue: result.GetAwaiter().GetResult());
            }
            catch (Exception executeException)
            {
                _log.Error("An error occurred when executing the scripts.");

                var ex = executeException.InnerException ?? executeException;
                return new ScriptResult(executionException: ex);
            }
        }

        private static DebugInformationFormat GetPlatformSpecificDebugInformationFormat()
        {
            // Mono, use PortablePdb
            if (Type.GetType("Mono.Runtime") != null)
            {
                return DebugInformationFormat.PortablePdb;
            }

            // otherwise standard PDB
            return DebugInformationFormat.Pdb;
        }
    }
}