Fixed memory leaks, fixed Excel.Application references in non-global AppDomains

Author: Fabian

ExcelScript/AddinFunctions/Evaluate.cs

@@ -2,6 +2,7 @@
 using ExcelScript.Registration;
 using ScriptingAbstractions;
 using System;
+using System.Diagnostics;
 using System.Linq;
 
 namespace ExcelScript

ExcelScript/AddinFunctions/Parse.cs

@@ -29,7 +29,6 @@ public static object Parse(
             // CAREFUL: This method may be run in a different AppDomain! Don't reference anything from outside of the delegate
             Func<MethodInfo[], MethodInfo> EntryMethodSelector = (methods) =>
             {
-                var _DEBUG_APPD = AppDomain.CurrentDomain.Id;
                 MethodInfo result = null;
 
                 // When only one method is available, we'll just return that one...

ExcelScript/ExcelScriptAddin.cs

@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Linq.Expressions;
+using System.Reflection;
 using System.Text;
 using Excel = NetOffice.ExcelApi;
 
@@ -61,6 +62,9 @@ private static IScriptGlobals GlobalsFactory(AppDomain TargetDomain)
             if (TargetDomain != AppDomain.CurrentDomain)
                 throw new InvalidOperationException($"Tried to create script globals for AppDomain {TargetDomain}, but was called in AppDomain {AppDomain.CurrentDomain}");
 
+            var excelDnaUtilInitialize = typeof(ExcelDnaUtil).GetMethod("Initialize", BindingFlags.Static | BindingFlags.NonPublic);
+            excelDnaUtilInitialize.Invoke(null, Array.Empty<object>());
+
             var typename = typeof(Globals).AssemblyQualifiedName;
             Type type = Type.GetType(typename);
             Func<Excel.Application> applicationFactory = () => new Excel.Application(null, ExcelDna.Integration.ExcelDnaUtil.Application);

Resources/Examples.xlsm

@@ -4,7 +4,7 @@
 
 namespace RoslynScripting
 {
-    [Serializable]
+    //[Serializable]
     public struct FormatColorScheme
     {
         public readonly Color Keyword;

RoslynScripting/FormatColorScheme.cs

@@ -8,7 +8,7 @@
 
 namespace RoslynScripting
 {
-    [Serializable]
+   // [Serializable]
     public struct TextSpan
     {
         public readonly int Start;
@@ -34,8 +34,8 @@ private TextSpan(int start, int length, int end)
         }
     }
 
-    [Serializable]
-    public class TextFormat
+    //[Serializable]
+    public class TextFormat : MarshalByRefObject
     {
         public readonly Color TextColor;
 
@@ -45,8 +45,8 @@ public TextFormat(Color TextColor)
         }
     }
 
-    [Serializable]
-    public class FormattedTextLinePart
+   // [Serializable]
+    public class FormattedTextLinePart : MarshalByRefObject
     {
         /// <summary>
         /// Line number of the text
@@ -81,8 +81,8 @@ public override string ToString()
         }
     }
 
-    [Serializable]
-    public class FormattedTextLine
+   // [Serializable]
+    public class FormattedTextLine : MarshalByRefObject
     {
         /// <summary>
         /// The text this line is part of
@@ -121,7 +121,9 @@ public void AddPart(FormattedTextLinePart Part)
 
         public FormattedTextLinePart AppendText(string Text, TextFormat Format)
         {
-            int SpanStart = _Parts.Any() ? _Parts.Last().LineSpan.End : 0;
+            var lastPart = Parts.Last();
+            var lastPartLineSpan = lastPart.LineSpan;
+            int SpanStart = _Parts.Any() ? lastPartLineSpan.End : 0;
             int SpanEnd = SpanStart + Text.Length;
 
             var LineSpan = TextSpan.FromBounds(SpanStart, SpanEnd);
@@ -137,8 +139,8 @@ public override string ToString()
         }
     }
 
-    [Serializable]
-    public class FormattedText
+   // [Serializable]
+    public class FormattedText : MarshalByRefObject
     {
         /// <summary>
         /// The lines that make up this text

RoslynScripting/FormattedText.cs

@@ -8,8 +8,8 @@
 
 namespace RoslynScripting
 {
-    [Serializable]
-    public class Parameter : IXmlSerializable, IParameter
+  //  [Serializable]
+    public class Parameter : MarshalByRefObject, IXmlSerializable, IParameter
     {
         [HashValue]
         public string Name { get; set; }

RoslynScripting/HostedScriptRunner.cs

@@ -163,6 +163,42 @@ internal static async Task<IParseResult<TGlobals>> ParseFromAsync(Func<AppDomain
             script.Code = code;
             script.m_ScriptingOptions = ScriptingOptions;
 
+            // TODO: This is not a great solution.. can we improve this?
+            // Ideal would be to avoid double-parsing as to not garbage up the appdomain with lot of unneeded assemblies (or having to create individual ones like below)
+            // but then again we can't use the EntryMethodSelector that nicely anymore
+            // maybe only compile to semanticmodel and work with that?
+            var helper = new HostingHelper();
+            AppDomain domain = null;
+            ParseResult<TGlobals> result;
+
+            try
+            {
+                domain = helper.IndividualScriptDomain;
+                var scriptRunner = (HostedScriptRunner<TGlobals>)Activator.CreateInstance(domain, typeof(HostedScriptRunner<TGlobals>).Assembly.FullName, typeof(HostedScriptRunner<TGlobals>).FullName).Unwrap();
+                var task = RemoteTask.ClientComplete<RoslynScripting.Internal.IParseResult>(scriptRunner.ParseAsync(script.Code, script.m_ScriptingOptions, EntryMethodSelector, EntryMethodParameterFactory), CancellationToken.None);
+
+                var parseResult = await task;
+
+                IList<IParameter> marshalledParameters = new List<IParameter>();
+
+                foreach (var parameter in parseResult.Parameters)
+                    marshalledParameters.Add(new Parameter { DefaultValue = parameter.DefaultValue, Description = parameter.Description, IsOptional = parameter.IsOptional, Name = parameter.Name, Type = parameter.Type });
+
+                script.Code = parseResult.RefactoredCode;
+                script.Parameters = marshalledParameters;
+                result = new ParseResult<TGlobals>(script, parseResult.EntryMethodName);
+            } finally
+            {
+                if(domain != null)
+                    AppDomain.Unload(domain);
+            }
+           
+           
+            return result;
+
+          
+            /*
+
             var hostedScriptRunner = script.GetOrCreateScriptRunner(new IParameter[0], script.Code, script.m_ScriptingOptions);
             var task = RemoteTask.ClientComplete<RoslynScripting.Internal.IParseResult>(hostedScriptRunner.ParseAsync(script.Code, script.m_ScriptingOptions, EntryMethodSelector, EntryMethodParameterFactory), CancellationToken.None);
             var parseResult = await task;
@@ -171,7 +207,7 @@ internal static async Task<IParseResult<TGlobals>> ParseFromAsync(Func<AppDomain
             script.Parameters = parseResult.Parameters.ToList();
 
             var result = new ParseResult<TGlobals>(script, parseResult.EntryMethodName);
-            return result;
+            return result;*/
         }
 
         public IScriptRunResult Run(IEnumerable<IParameterValue> Parameters)
@@ -230,10 +266,13 @@ private IScriptRunner GetOrCreateScriptRunner(IParameter[] parameters, string sc
             // C) the AppDomain in which the script runner is hosted is the same that we would like to use now
             if (m_ScriptRunnerCacheInfo != null && !m_ScriptRunnerCacheInfo.ScriptRunner.NeedsRecompilationFor(parameters, scriptCode, Options) && m_ScriptRunnerCacheInfo.HostingDomain == sandbox)
             {
+                Trace.WriteLine("Using cached script runner");
                 return m_ScriptRunnerCacheInfo.ScriptRunner;
             }
             else
             {
+                Trace.WriteLine("Creating new script runner");
+
                 TryUnregisterLease();
 
                 var scriptRunner = (HostedScriptRunner<TGlobals>)Activator.CreateInstance(sandbox, typeof(HostedScriptRunner<TGlobals>).Assembly.FullName, typeof(HostedScriptRunner<TGlobals>).FullName).Unwrap();

RoslynScripting/Parameter.cs

@@ -27,7 +27,7 @@ public enum HostingType
         IndividualScriptAppDomain
     }
 
-    [Serializable]
+   // [Serializable]
     public class ScriptingOptions : MarshalByRefObject, IXmlSerializable
     {
         public virtual List<Assembly> References { get; protected set; } = new List<Assembly>();