fix: do not stack overflow when namespace exports itself or an ancestor (#706)

Author: dsherret

src/parser.rs

@@ -733,11 +733,26 @@ impl<'a> DocParser<'a> {
   fn get_doc_for_ts_namespace(
     &self,
     module_info: &EsModuleInfo,
-    symbol: &Symbol,
+    ns_symbol: &Symbol,
     ts_module: &TsModuleDecl,
     full_range: &SourceRange,
   ) -> Option<DocNode> {
-    let first_ns_decl = symbol
+    fn symbol_in_ancestors(
+      id: UniqueSymbolId,
+      parent: &Symbol,
+      module_info: &EsModuleInfo,
+    ) -> bool {
+      let mut current_symbol = Some(parent);
+      while let Some(symbol) = current_symbol.take() {
+        if symbol.unique_id() == id {
+          return true;
+        }
+        current_symbol = symbol.parent_id().and_then(|s| module_info.symbol(s));
+      }
+      false
+    }
+
+    let first_ns_decl = ns_symbol
       .decls()
       .iter()
       .filter_map(|d| {
@@ -766,7 +781,7 @@ impl<'a> DocParser<'a> {
     let mut elements = Vec::new();
     let mut handled_symbols = HashSet::new();
 
-    for (export_name, export_symbol_id) in symbol.exports() {
+    for (export_name, export_symbol_id) in ns_symbol.exports() {
       handled_symbols.insert(UniqueSymbolId::new(
         module_info.module_id(),
         *export_symbol_id,
@@ -778,7 +793,12 @@ impl<'a> DocParser<'a> {
       let original_range = &export_symbol.decls().first().unwrap().range;
 
       for definition in definitions {
-        handled_symbols.insert(definition.symbol.unique_id());
+        let definition_id = definition.symbol.unique_id();
+        if symbol_in_ancestors(definition_id, ns_symbol, module_info) {
+          continue;
+        }
+
+        handled_symbols.insert(definition_id);
 
         let maybe_docs = self.docs_for_maybe_node(
           definition.module,
@@ -799,7 +819,7 @@ impl<'a> DocParser<'a> {
     }
 
     let is_ambient = elements.is_empty() && !module_has_import(module_info);
-    for child_id in symbol.child_ids() {
+    for child_id in ns_symbol.child_ids() {
       let unique_id = UniqueSymbolId::new(module_info.module_id(), child_id);
       if !handled_symbols.insert(unique_id) {
         continue; // already handled

tests/specs/namespace_exports_self.txt

@@ -0,0 +1,286 @@
+# mod.ts
+/** Description. */
+export declare namespace a {
+  /** Description. */
+  const a: string;
+  export { a };
+}
+
+/** Description. */
+export declare namespace b {
+  /** Description. */
+  export class b {}
+}
+
+/** Description. */
+export namespace c {
+    export { c };
+}
+
+/** Description. */
+export namespace d {
+  /** Description. */
+  export namespace e {
+    export { d };
+  }
+}
+
+/** Description. */
+export namespace f {
+  /** Description. */
+  export namespace g {
+    /** Description. */
+    const value: f;
+    export { value };
+  }
+}
+
+# output.txt
+Defined in file:///mod.ts:2:1
+
+namespace a
+  Description.
+
+  const a: string
+    Description.
+
+Defined in file:///mod.ts:9:1
+
+namespace b
+  Description.
+
+  class b
+    Description.
+
+Defined in file:///mod.ts:15:1
+
+namespace c
+  Description.
+
+
+Defined in file:///mod.ts:20:1
+
+namespace d
+  Description.
+
+  namespace e
+    Description.
+
+Defined in file:///mod.ts:28:1
+
+namespace f
+  Description.
+
+  namespace g
+    Description.
+
+
+# output.json
+[
+  {
+    "name": "a",
+    "isDefault": false,
+    "location": {
+      "filename": "file:///mod.ts",
+      "line": 2,
+      "col": 0,
+      "byteIndex": 20
+    },
+    "declarationKind": "export",
+    "jsDoc": {
+      "doc": "Description."
+    },
+    "kind": "namespace",
+    "namespaceDef": {
+      "elements": [
+        {
+          "name": "a",
+          "isDefault": false,
+          "location": {
+            "filename": "file:///mod.ts",
+            "line": 4,
+            "col": 8,
+            "byteIndex": 79
+          },
+          "declarationKind": "export",
+          "jsDoc": {
+            "doc": "Description."
+          },
+          "kind": "variable",
+          "variableDef": {
+            "tsType": {
+              "repr": "string",
+              "kind": "keyword",
+              "keyword": "string"
+            },
+            "kind": "const"
+          }
+        }
+      ]
+    }
+  },
+  {
+    "name": "b",
+    "isDefault": false,
+    "location": {
+      "filename": "file:///mod.ts",
+      "line": 9,
+      "col": 0,
+      "byteIndex": 129
+    },
+    "declarationKind": "export",
+    "jsDoc": {
+      "doc": "Description."
+    },
+    "kind": "namespace",
+    "namespaceDef": {
+      "elements": [
+        {
+          "name": "b",
+          "isDefault": false,
+          "location": {
+            "filename": "file:///mod.ts",
+            "line": 11,
+            "col": 2,
+            "byteIndex": 182
+          },
+          "declarationKind": "export",
+          "jsDoc": {
+            "doc": "Description."
+          },
+          "kind": "class",
+          "classDef": {
+            "isAbstract": false,
+            "constructors": [],
+            "properties": [],
+            "indexSignatures": [],
+            "methods": [],
+            "extends": null,
+            "implements": [],
+            "typeParams": [],
+            "superTypeParams": []
+          }
+        }
+      ]
+    }
+  },
+  {
+    "name": "c",
+    "isDefault": false,
+    "location": {
+      "filename": "file:///mod.ts",
+      "line": 15,
+      "col": 0,
+      "byteIndex": 223
+    },
+    "declarationKind": "export",
+    "jsDoc": {
+      "doc": "Description."
+    },
+    "kind": "namespace",
+    "namespaceDef": {
+      "elements": []
+    }
+  },
+  {
+    "name": "d",
+    "isDefault": false,
+    "location": {
+      "filename": "file:///mod.ts",
+      "line": 20,
+      "col": 0,
+      "byteIndex": 285
+    },
+    "declarationKind": "export",
+    "jsDoc": {
+      "doc": "Description."
+    },
+    "kind": "namespace",
+    "namespaceDef": {
+      "elements": [
+        {
+          "name": "e",
+          "isDefault": false,
+          "location": {
+            "filename": "file:///mod.ts",
+            "line": 22,
+            "col": 2,
+            "byteIndex": 330
+          },
+          "declarationKind": "export",
+          "jsDoc": {
+            "doc": "Description."
+          },
+          "kind": "namespace",
+          "namespaceDef": {
+            "elements": []
+          }
+        }
+      ]
+    }
+  },
+  {
+    "name": "f",
+    "isDefault": false,
+    "location": {
+      "filename": "file:///mod.ts",
+      "line": 28,
+      "col": 0,
+      "byteIndex": 396
+    },
+    "declarationKind": "export",
+    "jsDoc": {
+      "doc": "Description."
+    },
+    "kind": "namespace",
+    "namespaceDef": {
+      "elements": [
+        {
+          "name": "g",
+          "isDefault": false,
+          "location": {
+            "filename": "file:///mod.ts",
+            "line": 30,
+            "col": 2,
+            "byteIndex": 441
+          },
+          "declarationKind": "export",
+          "jsDoc": {
+            "doc": "Description."
+          },
+          "kind": "namespace",
+          "namespaceDef": {
+            "elements": [
+              {
+                "name": "value",
+                "isDefault": false,
+                "location": {
+                  "filename": "file:///mod.ts",
+                  "line": 32,
+                  "col": 10,
+                  "byteIndex": 496
+                },
+                "declarationKind": "export",
+                "jsDoc": {
+                  "doc": "Description."
+                },
+                "kind": "variable",
+                "variableDef": {
+                  "tsType": {
+                    "repr": "f",
+                    "kind": "typeRef",
+                    "typeRef": {
+                      "typeParams": null,
+                      "typeName": "f"
+                    }
+                  },
+                  "kind": "const"
+                }
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+]