Merge pull request #2581 from retailcoder/next

ParseTask cancellation and logging

Author: retailcoder

Rubberduck.Parsing/Preprocessing/IVBAPreprocessor.cs

@@ -1,7 +1,9 @@
-namespace Rubberduck.Parsing.Preprocessing
+using System.Threading;
+
+namespace Rubberduck.Parsing.Preprocessing
 {
     public interface IVBAPreprocessor
     {
-        string Execute(string moduleName, string unprocessedCode);
+        string Execute(string moduleName, string unprocessedCode, CancellationToken token);
     }
 }

Rubberduck.Parsing/Preprocessing/VBAPreprocessor.cs

@@ -1,4 +1,6 @@
-namespace Rubberduck.Parsing.Preprocessing
+using System.Threading;
+
+namespace Rubberduck.Parsing.Preprocessing
 {
     public sealed class VBAPreprocessor : IVBAPreprocessor
     {
@@ -11,15 +13,12 @@ public VBAPreprocessor(double vbaVersion)
             _parser = new VBAPrecompilationParser();
         }
 
-        public string Execute(string moduleName, string unprocessedCode)
-        {
-            return Preprocess(moduleName, unprocessedCode);
-        }
-
-        private string Preprocess(string moduleName, string unprocessedCode)
+        public string Execute(string moduleName, string unprocessedCode, CancellationToken token)
         {
-            SymbolTable<string, IValue> symbolTable = new SymbolTable<string, IValue>();
+            token.ThrowIfCancellationRequested();
+            var symbolTable = new SymbolTable<string, IValue>();
             var tree = _parser.Parse(moduleName, unprocessedCode);
+            token.ThrowIfCancellationRequested();
             var stream = tree.Start.InputStream;
             var evaluator = new VBAPreprocessorVisitor(symbolTable, new VBAPredefinedCompilationConstants(_vbaVersion), stream);
             var expr = evaluator.Visit(tree);

Rubberduck.Parsing/Symbols/DeclarationFinder.cs

@@ -488,10 +488,7 @@ public Declaration OnUndeclaredVariable(Declaration enclosingProcedure, string i
         public Declaration OnBracketedExpression(string expression, ParserRuleContext context)
         {
             var hostApp = FindProject(_hostApp == null ? "VBA" : _hostApp.ApplicationName);
-            if (hostApp == null)
-            {
-                
-            }
+            Debug.Assert(hostApp != null, "Host application project can't be null. Make sure VBA standard library is included if host is unknown.");
 
             var qualifiedName = hostApp.QualifiedName.QualifiedModuleName.QualifyMemberName(expression);
 

Rubberduck.Parsing/VBA/AttributeParser.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Threading;
 using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
@@ -27,8 +28,10 @@ public AttributeParser(IModuleExporter exporter, Func<IVBAPreprocessor> preproce
         /// Exports the specified component to a temporary file, loads, and then parses the exported file.
         /// </summary>
         /// <param name="component"></param>
-        public IDictionary<Tuple<string, DeclarationType>, Attributes> Parse(IVBComponent component)
+        /// <param name="token"></param>
+        public IDictionary<Tuple<string, DeclarationType>, Attributes> Parse(IVBComponent component, CancellationToken token)
         {
+            token.ThrowIfCancellationRequested();
             var path = _exporter.Export(component);
             if (!File.Exists(path))
             {
@@ -37,11 +40,13 @@ public IDictionary<Tuple<string, DeclarationType>, Attributes> Parse(IVBComponen
             }
             var code = File.ReadAllText(path);
             File.Delete(path);
+            token.ThrowIfCancellationRequested();
+
             var type = component.Type == ComponentType.StandardModule
                 ? DeclarationType.ProceduralModule
                 : DeclarationType.ClassModule;
             var preprocessor = _preprocessorFactory();
-            var preprocessed = preprocessor.Execute(component.Name, code);
+            var preprocessed = preprocessor.Execute(component.Name, code, token);
             var listener = new AttributeListener(Tuple.Create(component.Name, type));
             // parse tree isn't usable for declarations because
             // line numbers are offset due to module header and attributes

Rubberduck.Parsing/VBA/ComponentParseTask.cs

@@ -30,8 +30,12 @@ class ComponentParseTask
         public event EventHandler<ParseFailureArgs> ParseFailure;
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
+        private readonly Guid _taskId;
+
         public ComponentParseTask(IVBComponent vbComponent, IVBAPreprocessor preprocessor, IAttributeParser attributeParser, TokenStreamRewriter rewriter = null)
         {
+            _taskId = Guid.NewGuid();
+
             _attributeParser = attributeParser;
             _preprocessor = preprocessor;
             _component = vbComponent;
@@ -44,13 +48,13 @@ public void Start(CancellationToken token)
         {
             try
             {
-                var code = RewriteAndPreprocess();
-                token.ThrowIfCancellationRequested();
-
-                var attributes = _attributeParser.Parse(_component);
+                Logger.Trace("Starting ParseTaskID {0} on thread {1}.", _taskId, Thread.CurrentThread.ManagedThreadId);
 
+                var code = RewriteAndPreprocess(token);
                 token.ThrowIfCancellationRequested();
 
+                var attributes = _attributeParser.Parse(_component, token);
+
                 // temporal coupling... comments must be acquired before we walk the parse tree for declarations
                 // otherwise none of the annotations get associated to their respective Declaration
                 var commentListener = new CommentListener();
@@ -60,12 +64,13 @@ public void Start(CancellationToken token)
                 ITokenStream stream;
                 var tree = ParseInternal(_component.Name, code, new IParseTreeListener[]{ commentListener, annotationListener }, out stream);
                 stopwatch.Stop();
+                token.ThrowIfCancellationRequested();
 
                 var comments = QualifyAndUnionComments(_qualifiedName, commentListener.Comments, commentListener.RemComments);
                 token.ThrowIfCancellationRequested();
 
                 var completedHandler = ParseCompleted;
-                if (completedHandler != null)
+                if (completedHandler != null && !token.IsCancellationRequested)
                     completedHandler.Invoke(this, new ParseCompletionArgs
                     {
                         ParseTree = tree,
@@ -77,7 +82,7 @@ public void Start(CancellationToken token)
             }
             catch (COMException exception)
             {
-                Logger.Error(exception, "Exception thrown in thread {0}.", Thread.CurrentThread.ManagedThreadId);
+                Logger.Error(exception, "Exception thrown in thread {0}, ParseTaskID {1}.", Thread.CurrentThread.ManagedThreadId, _taskId);
                 var failedHandler = ParseFailure;
                 if (failedHandler != null)
                     failedHandler.Invoke(this, new ParseFailureArgs
@@ -88,7 +93,7 @@ public void Start(CancellationToken token)
             catch (SyntaxErrorException exception)
             {
                 //System.Diagnostics.Debug.Assert(false, "A RecognitionException should be notified of, not thrown as a SyntaxErrorException. This lets the parser recover from parse errors.");
-                Logger.Error(exception, "Exception thrown in thread {0}.", Thread.CurrentThread.ManagedThreadId);
+                Logger.Error(exception, "Exception thrown in thread {0}, ParseTaskID {1}.", Thread.CurrentThread.ManagedThreadId, _taskId);
                 var failedHandler = ParseFailure;
                 if (failedHandler != null)
                     failedHandler.Invoke(this, new ParseFailureArgs
@@ -157,10 +162,10 @@ private static bool HasNumberedLine(string codeLine, out int? lineNumber)
             return false;
         }
 
-        private string RewriteAndPreprocess()
+        private string RewriteAndPreprocess(CancellationToken token)
         {
             var code = _rewriter == null ? string.Join(Environment.NewLine, GetSanitizedCode(_component.CodeModule)) : _rewriter.GetText();
-            var processed = _preprocessor.Execute(_component.Name, code);
+            var processed = _preprocessor.Execute(_component.Name, code, token);
             return processed;
         }
 
@@ -171,16 +176,6 @@ private IParseTree ParseInternal(string moduleName, string code, IParseTreeListe
             return _parser.Parse(moduleName, code, listeners, new ExceptionErrorListener(), out outStream);
         }
 
-        private void ParserSyntaxError(object sender, SyntaxErrorEventArgs e)
-        {
-            var handler = ParseFailure;
-            if (handler != null)
-            {
-                var args = new ParseFailureArgs {Cause = new SyntaxErrorException(e.Info)}; // todo: refactor. exceptions should be thrown, not passed around as data
-                handler.Invoke(this, args);
-            }
-        }
-
         private IEnumerable<CommentNode> QualifyAndUnionComments(QualifiedModuleName qualifiedName, IEnumerable<VBAParser.CommentContext> comments, IEnumerable<VBAParser.RemCommentContext> remComments)
         {
             var commentNodes = comments.Select(comment => new CommentNode(comment.GetComment(), Tokens.CommentMarker, new QualifiedSelection(qualifiedName, comment.GetSelection())));

Rubberduck.Parsing/VBA/IAttributeParser.cs

@@ -1,12 +1,13 @@
 using System;
 using System.Collections.Generic;
+using System.Threading;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.Parsing.VBA
 {
     public interface IAttributeParser
     {
-        IDictionary<Tuple<string, DeclarationType>, Attributes> Parse(IVBComponent component);
+        IDictionary<Tuple<string, DeclarationType>, Attributes> Parse(IVBComponent component, CancellationToken token);
     }
 }

Rubberduck.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 2013
-VisualStudioVersion = 12.0.31101.0
+VisualStudioVersion = 12.0.40629.0
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Rubberduck", "RetailCoder.VBE\Rubberduck.csproj", "{20589DE8-432E-4359-9232-69EB070B7185}"
 	ProjectSection(ProjectDependencies) = postProject
@@ -31,6 +31,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		libs\Microsoft.VB6.Interop.VBIDE.dll = libs\Microsoft.VB6.Interop.VBIDE.dll
 		libs\Microsoft.Vbe.Interop.dll = libs\Microsoft.Vbe.Interop.dll
 		libs\Office.dll = libs\Office.dll
+		Performance6.psess = Performance6.psess
 	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Rubberduck.VBEditor", "Rubberduck.VBEEditor\Rubberduck.VBEditor.csproj", "{8CE35EB3-8852-4BA1-84DD-DF3F5D2967B0}"

RubberduckTests/Inspections/HostSpecificExpressionInspectionTests.cs

@@ -17,6 +17,7 @@ public class HostSpecificExpressionInspectionTests
     {
         [TestMethod]
         [TestCategory("Inspections")]
+        [DeploymentItem(@"TestFiles\")]
         public void ReturnsResultForExpressionOnLeftHandSide()
         {
             const string code = @"
@@ -27,6 +28,7 @@ End Sub
             var builder = new MockVbeBuilder();
             var project = builder.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
                 .AddComponent("Module1", ComponentType.StandardModule, code)
+                .AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
                 .AddReference("Excel", MockVbeBuilder.LibraryPathMsExcel, 1, 7, true)
                 .Build();
             var vbe = builder.AddProject(project).Build();
@@ -35,6 +37,8 @@ End Sub
             vbe.Setup(m => m.HostApplication()).Returns(() => mockHost.Object);
 
             var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock<ISinks>().Object));
+            parser.State.AddTestLibrary("VBA.4.2.xml");
+            parser.State.AddTestLibrary("Excel.1.8.xml");
             parser.Parse(new CancellationTokenSource());
             if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
 

RubberduckTests/Mocks/MockParser.cs

@@ -39,7 +39,7 @@ public static void ParseString(string inputCode, out QualifiedModuleName qualifi
         public static ParseCoordinator Create(IVBE vbe, RubberduckParserState state, string serializedDeclarationsPath = null)
         {
             var attributeParser = new Mock<IAttributeParser>();
-            attributeParser.Setup(m => m.Parse(It.IsAny<IVBComponent>()))
+            attributeParser.Setup(m => m.Parse(It.IsAny<IVBComponent>(), It.IsAny<CancellationToken>()))
                            .Returns(() => new Dictionary<Tuple<string, DeclarationType>, Attributes>());
             return Create(vbe, state, attributeParser.Object, serializedDeclarationsPath);
         }