added some comments and renamed some fields on PathResolver and Snapshot.

Author: heejaechang

src/Analysis/Core/Impl/DependencyResolution/PathResolver.cs

@@ -20,6 +20,9 @@
 namespace Microsoft.Python.Analysis.Core.DependencyResolution {
     public sealed class PathResolver {
         public PathResolver(in PythonLanguageVersion pythonLanguageVersion, in string root, in ImmutableArray<string> interpreterSearchPaths, in ImmutableArray<string> userSearchPaths) {
+            // need to audit whether CurrentSnapshot ever get updated concurrently
+            // thread safety is probably fine but serialization is another issue where if 2 callers do TryAddModulePath or other calls concurrently, 
+            // they will use same CurrentSnapshot to update which ends up with 2 different snapshots with same version.
             CurrentSnapshot = new PathResolverSnapshot(pythonLanguageVersion, root, interpreterSearchPaths, userSearchPaths);
         }
 

src/Analysis/Core/Impl/DependencyResolution/PathResolverSnapshot.Edge.cs

@@ -35,55 +35,69 @@ private readonly struct Edge {
             //  ┌─╚═╗
             // [x] [y] 
             //
-            // will be stored as list of pairs: (2, a), (0, i), (1, y)
+            // will be stored as list of pairs: (2, c), (0, i), (1, y)
             // 
             // To provide immutability, it must be changed only by calling List<T>.Add
-            private readonly ImmutableArray<(int index, Node node)> _vertices;
-            private readonly int _index;
+            private readonly ImmutableArray<(int nodeIndexInParent, Node node)> _pathFromRoot;
 
-            public Node Start => IsFirst ? default : _vertices[_index - 1].node;
-            public int EndIndex => _vertices[_index].index;
-            public Node End => _vertices[_index].node;
-            public Edge Previous => IsFirst ? default : new Edge(_vertices, _index - 1);
-            public Edge Next => IsLast ? default : new Edge(_vertices, _index + 1);
-            public int PathLength => _vertices.Count;
-            public bool IsFirst => _index == 0;
-            public bool IsNonRooted => _vertices.Count > 0 && _vertices[0].node.Name == "*";
-            public bool IsEmpty => _vertices.Count == 0;
-            private bool IsLast => _index == _vertices.Count - 1;
+            // indicates which entry in the _pathFromRoot correspond to this edge.
+            private readonly int _indexInPath;
+
+            public Node ParentNode => IsFirst ? default : _pathFromRoot[_indexInPath - 1].node;
+            public int NodeIndexInParent => _pathFromRoot[_indexInPath].nodeIndexInParent;
+            public Node Node => _pathFromRoot[_indexInPath].node;
+            public Edge Previous => IsFirst ? default : new Edge(_pathFromRoot, _indexInPath - 1);
+            public Edge Next => IsLast ? default : new Edge(_pathFromRoot, _indexInPath + 1);
+            public int PathLength => _pathFromRoot.Count;
+            public bool IsFirst => _indexInPath == 0;
+            public bool IsNonRooted => _pathFromRoot.Count > 0 && _pathFromRoot[0].node.Name == "*";
+            public bool IsEmpty => _pathFromRoot.Count == 0;
+            private bool IsLast => _indexInPath == _pathFromRoot.Count - 1;
 
             public Edge(int startIndex, Node start) {
-                _vertices = ImmutableArray<(int, Node)>.Empty.Add((startIndex, start));
-                _index = 0;
+                _pathFromRoot = ImmutableArray<(int, Node)>.Empty.Add((startIndex, start));
+                _indexInPath = 0;
             }
 
-            public Edge FirstEdge => new Edge(_vertices, 0);
-            public Edge GetPrevious(int count) => count > _index ? default : new Edge(_vertices, _index - count);
-            public Edge GetNext(int count) => _index + count > _vertices.Count - 1 ? default : new Edge(_vertices, _index + count);
+            public Edge FirstEdge => new Edge(_pathFromRoot, indexInVertices: 0);
+            public Edge GetPrevious(int count) => count > _indexInPath ? default : new Edge(_pathFromRoot, _indexInPath - count);
+            public Edge GetNext(int count) => _indexInPath + count > _pathFromRoot.Count - 1 ? default : new Edge(_pathFromRoot, _indexInPath + count);
+
+            private Edge(ImmutableArray<(int index, Node node)> vertices, int indexInVertices) {
+                // Node has only down pointers for the immutable tree so that when tree needs to be updated
+                // it can update only spine of the tree and reuse all other tree nodes. basically making
+                // the tree incrementally updatable.
+                // but not having Parent pointer makes using the tree data structure hard. so 
+                // Edge tracks the spine (provide Back/Parent pointer) but only created on demand for
+                // a specific node requested.
+                // 
+                // concept is similar to green-red tree.
+                // see https://blog.yaakov.online/red-green-trees/
+                //     https://blogs.msdn.microsoft.com/ericlippert/2012/06/08/persistence-facades-and-roslyns-red-green-trees/
+                //     https://github.com/KirillOsenkov/Bliki/wiki/Roslyn-Immutable-Trees
 
-            private Edge(ImmutableArray<(int index, Node node)> vertices, int index) {
-                _vertices = vertices;
-                _index = index;
+                _pathFromRoot = vertices;
+                _indexInPath = indexInVertices;
             }
 
             /// <summary>
             /// Appends new arc to the end vertex of current arc
             /// </summary>
-            /// <param name="nextVertexIndex"></param>
+            /// <param name="childVertexIndexToAppened"></param>
             /// <returns>New last arc</returns>
-            public Edge Append(int nextVertexIndex) {
-                var nextVertex = End.Children[nextVertexIndex];
-                var trimLength = _vertices.Count - _index - 1;
-                var vertices = _vertices.ReplaceAt(_index + 1, trimLength, (nextVertexIndex, nextVertex));
-                return new Edge(vertices, _index + 1);
+            public Edge Append(int childVertexIndexToAppened) {
+                var nextVertex = Node.Children[childVertexIndexToAppened];
+                var trimLength = _pathFromRoot.Count - _indexInPath - 1;
+                var vertices = _pathFromRoot.ReplaceAt(_indexInPath + 1, trimLength, (childVertexIndexToAppened, nextVertex));
+                return new Edge(vertices, _indexInPath + 1);
             }
 
             public override bool Equals(object obj) => obj is Edge other && Equals(other);
-            public bool Equals(Edge other) => Equals(_vertices, other._vertices) && _index == other._index;
+            public bool Equals(Edge other) => Equals(_pathFromRoot, other._pathFromRoot) && _indexInPath == other._indexInPath;
 
             public override int GetHashCode() {
                 unchecked {
-                    return (_vertices.GetHashCode() * 397) ^ _index;
+                    return (_pathFromRoot.GetHashCode() * 397) ^ _indexInPath;
                 }
             }
 
@@ -92,9 +106,9 @@ public override int GetHashCode() {
 
             private string DebuggerDisplay {
                 get {
-                    var start = _index > 0 ? _vertices[_index - 1].node.Name : "null";
-                    var endIndex = _vertices[_index].index.ToString();
-                    var end = _vertices[_index].node.Name;
+                    var start = _indexInPath > 0 ? _pathFromRoot[_indexInPath - 1].node.Name : "null";
+                    var endIndex = _pathFromRoot[_indexInPath].nodeIndexInParent.ToString();
+                    var end = _pathFromRoot[_indexInPath].node.Name;
                     return $"[{start}]-{endIndex}-[{end}]";
                 }
             }

src/Analysis/Core/Impl/DependencyResolution/PathResolverSnapshot.Node.cs

@@ -110,7 +110,7 @@ public ImmutableArray<string> GetChildrenNames() {
                 var results = ImmutableArray<string>.Empty;
 
                 foreach (var edge in _edges) {
-                    var children = edge.End.Children;
+                    var children = edge.Node.Children;
                     foreach (var child in children) {
                         if (IsNotInitPy(child)) {
                             results = results.Add(child.Name);
@@ -123,7 +123,7 @@ public ImmutableArray<string> GetChildrenNames() {
 
             public bool TryGetChildImport(string name, out IImportSearchResult child) {
                 foreach (var edge in _edges) {
-                    var index = edge.End.GetChildIndex(name);
+                    var index = edge.Node.GetChildIndex(name);
                     if (index == -1) {
                         continue;
                     }
@@ -132,7 +132,7 @@ public bool TryGetChildImport(string name, out IImportSearchResult child) {
                     if (_snapshot.TryCreateModuleImport(childEdge, out var moduleImport)) {
                         child = moduleImport;
                     } else {
-                        child = new ImplicitPackageImport(new ChildrenSource(_snapshot, childEdge), childEdge.End.Name, childEdge.End.FullModuleName);
+                        child = new ImplicitPackageImport(new ChildrenSource(_snapshot, childEdge), childEdge.Node.Name, childEdge.Node.FullModuleName);
                     }
 
                     return true;