Cache deserialized ComProjects in the tests instead of declarations

Previously, we statucally cached serialized declarations we loadedfrom file in tests to avoid loading several MB of text files multiple times in different tests. This is no longer sensible because we derserialize ComProjects now and generate the declarations based on them.

Author: MDoerner

Rubberduck.Parsing/ComReflection/IComProjectDeserializer.cs

@@ -0,0 +1,10 @@
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Parsing.ComReflection
+{
+    public interface IComProjectDeserializer
+    {
+        ComProject DeserializeProject(ReferenceInfo reference);
+        bool SerializedVersionExists(ReferenceInfo reference);
+    }
+}

Rubberduck.Parsing/ComReflection/IComProjectSerializationProvider.cs

@@ -1,12 +1,8 @@
-using Rubberduck.VBEditor;
-
-namespace Rubberduck.Parsing.ComReflection
+namespace Rubberduck.Parsing.ComReflection
 {
-    public interface IComProjectSerializationProvider
+    public interface IComProjectSerializationProvider : IComProjectDeserializer
     {
         string Target { get; }
         void SerializeProject(ComProject project);
-        ComProject DeserializeProject(ReferenceInfo reference);
-        bool SerializedVersionExists(ReferenceInfo reference);
     }
 }

Rubberduck.Parsing/ComReflection/SerializedReferencedDeclarationsCollector.cs

@@ -6,16 +6,16 @@ namespace Rubberduck.Parsing.ComReflection
 {
     public class SerializedReferencedDeclarationsCollector : ReferencedDeclarationsCollectorBase
     {
-        private readonly IComProjectSerializationProvider _serializer;
+        private readonly IComProjectDeserializer _deserializer;
 
-        public SerializedReferencedDeclarationsCollector(string serializedDeclarationsPath = null)
+        public SerializedReferencedDeclarationsCollector(IComProjectDeserializer deserializer)
         {
-            _serializer = new XmlComProjectSerializer(serializedDeclarationsPath);
+            _deserializer = deserializer;
         }
 
         public override IReadOnlyCollection<Declaration> CollectedDeclarations(ReferenceInfo reference)
         {
-            if (!_serializer.SerializedVersionExists(reference))
+            if (!_deserializer.SerializedVersionExists(reference))
             {
                 return new List<Declaration>();
             }
@@ -25,7 +25,7 @@ public override IReadOnlyCollection<Declaration> CollectedDeclarations(Reference
 
         private IReadOnlyCollection<Declaration> LoadDeclarationsFromProvider(ReferenceInfo reference)
         {
-            var type = _serializer.DeserializeProject(reference);
+            var type = _deserializer.DeserializeProject(reference);
             return LoadDeclarationsFromComProject(type); 
         }
     }

Rubberduck.Parsing/Rubberduck.Parsing.csproj

@@ -148,6 +148,7 @@
     <Compile Include="Common\ParsingStageTimer.cs" />
     <Compile Include="ComReflection\ComLibraryProvider.cs" />
     <Compile Include="ComReflection\IComLibraryProvider.cs" />
+    <Compile Include="ComReflection\IComProjectDeserializer.cs" />
     <Compile Include="ComReflection\IComProjectSerializationProvider.cs" />
     <Compile Include="ComReflection\LibraryReferencedDeclarationsCollector.cs" />
     <Compile Include="ComReflection\ReferencedDeclarationsCollector.cs" />

RubberduckTests/Mocks/MockParser.cs

@@ -72,8 +72,9 @@ public static SynchronousParseCoordinator Create(IVBE vbe, RubberduckParserState
             var supertypeClearer = new SynchronousSupertypeClearer(state); 
             var parserStateManager = new SynchronousParserStateManager(state);
             var referenceRemover = new SynchronousReferenceRemover(state, moduleToModuleReferenceManager);
-            var baseReferencedDeclarationsCollector = new SerializedReferencedDeclarationsCollector(path);
-            var referencedDeclarationsCollector = new StaticCachingReferencedDeclarationsCollectorDecorator(baseReferencedDeclarationsCollector);
+            var baseComDeserializer = new XmlComProjectSerializer(path);
+            var comDeserializer = new StaticCachingComDeserializerDecorator(baseComDeserializer);
+            var referencedDeclarationsCollector = new SerializedReferencedDeclarationsCollector(comDeserializer);
             var comSynchronizer = new SynchronousCOMReferenceSynchronizer(
                 state, 
                 parserStateManager,

RubberduckTests/Mocks/StaticCachingComDeserializerDecorator.cs

@@ -0,0 +1,43 @@
+using System.Collections.Generic;
+using Rubberduck.Parsing.ComReflection;
+using Rubberduck.VBEditor;
+
+namespace RubberduckTests.Mocks
+{
+    public class StaticCachingComDeserializerDecorator : IComProjectDeserializer
+    {
+        private static readonly Dictionary<ReferenceInfo, ComProject> CachedReferences = new Dictionary<ReferenceInfo, ComProject>();
+
+        private static readonly object _lockObject = new object();
+
+        private IComProjectDeserializer _baseDeserializer;
+
+        public StaticCachingComDeserializerDecorator(IComProjectDeserializer baseDeserializer)
+        {
+            _baseDeserializer = baseDeserializer;
+        }
+
+        public bool SerializedVersionExists(ReferenceInfo reference)
+        {
+            lock(_lockObject)
+            {
+                return CachedReferences.TryGetValue(reference, out _) || _baseDeserializer.SerializedVersionExists(reference);
+            }
+        }
+
+        public ComProject DeserializeProject(ReferenceInfo reference)
+        {
+            lock (_lockObject)
+            {
+                if (CachedReferences.TryGetValue(reference, out var cachedProject))
+                {
+                    return cachedProject;
+                }
+
+                var comProject = _baseDeserializer.DeserializeProject(reference);
+                CachedReferences[reference] = comProject;
+                return comProject;
+            }
+        } 
+    }
+}

RubberduckTests/Mocks/StaticCachingReferencedDeclarationsCollectorDecorator.cs

@@ -129,7 +129,7 @@
     <Compile Include="CodeStringExtensions.cs" />
     <Compile Include="Mocks\MockVbeEvents.cs" />
     <Compile Include="Inspections\SheetAccessedUsingStringInspectionTests.cs" />
-    <Compile Include="Mocks\StaticCachingReferencedDeclarationsCollectorDecorator.cs" />
+    <Compile Include="Mocks\StaticCachingComDeserializerDecorator.cs" />
     <Compile Include="ParserState\ParserStateTests.cs" />
     <Compile Include="Parsing\Coordination\TokenStreamParserTests.cs" />
     <Compile Include="Parsing\VBACodeStringParserTests.cs" />