Files
graphify/tests/test_external_stub_endpoints.py
rohit-jsfreaky 1965a00841 fix(watch): drop an external import stub once no edge references it
External import stubs (#2873) are minted without an _origin stamp. On
the next update the #2334 tier backfill stamped them by shape, and a
stub has no L<line> location, so it became `semantic`. Reconcile keeps
semantic nodes, so once the last file importing a module stopped
importing it, the stub stayed in graph.json forever with no edge. It
also made a rebuild of an unchanged tree differ from the first build.

A stub is derived from its import edges and minted again on every
write, so it has no tier. The backfill (now one helper shared by
_load_existing_graph and the reconcile path) skips stubs and removes a
stamp an earlier run gave one; every tier decision reads an unstamped
stub exactly as before. Reconcile drops a preserved stub that no fresh
or preserved edge references.

On graphify's own repo a warm rebuild now equals the cold build (125
stub nodes differed), a long-lived graph heals to the cold node set
(8 ghost stubs removed), and the changed-files path equals the full
rebuild for edits and additions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
(cherry picked from commit d3fbf6458f)
2026-10-07 17:26:17 +01:00

239 lines
10 KiB
Python

"""Every edge endpoint in graph.json must be a declared node (#2873).
`graph.json` used to ship `imports`/`imports_from`/`re_exports` edges whose
target was an external module (stdlib, a third-party dependency) with no
matching entry in `nodes[]`. Every loader (networkx `node_link_graph`)
materialises such an endpoint as an attribute-less phantom node, so the node
set the file declares and the node set it produces disagree, and `merge-graphs`
fragments the same external module into one node per repo. These tests pin the
fix: mint a typed external stub node instead, keep it global across repos, and
never stub a non-import relation (a sourceless external call target stays
suppressed per #3156).
"""
from __future__ import annotations
import json
from pathlib import Path
import networkx as nx
import pytest
from graphify.build import (
build_from_json,
mint_external_stubs_in_data,
prefix_graph_for_global,
)
def _import_extraction(target: str, relation: str = "imports") -> dict:
return {
"nodes": [
{"id": "pkg_a", "label": "a.py", "file_type": "code", "source_file": "pkg/a.py"},
],
"links": [
{"source": "pkg_a", "target": target, "relation": relation,
"source_file": "pkg/a.py", "confidence": "EXTRACTED", "weight": 1.0},
],
}
def test_build_from_json_mints_external_import_stub():
G = build_from_json(_import_extraction("typing"))
assert "typing" in G.nodes, "external import target must be a declared node, not dangling"
assert G.nodes["typing"].get("external") is True
assert G.nodes["typing"].get("type") == "external"
assert G.has_edge("pkg_a", "typing"), "the import edge must survive"
def test_external_stub_makes_serialized_graph_self_consistent():
from networkx.readwrite import json_graph
G = build_from_json(_import_extraction("pathlib", relation="imports_from"))
data = json_graph.node_link_data(G, edges="links")
declared = {n["id"] for n in data["nodes"]}
for e in data["links"]:
assert e["source"] in declared and e["target"] in declared, (
"serialized graph must have no undeclared edge endpoint"
)
def test_non_import_dangling_edge_is_still_dropped():
"""A sourceless external CALL target is deliberately suppressed (#3156) to
avoid a phantom god-node: only import-family relations get a stub."""
G = build_from_json(_import_extraction("some_external_fn", relation="calls"))
assert "some_external_fn" not in G.nodes
assert not G.has_edge("pkg_a", "some_external_fn")
def test_mint_external_stubs_in_data_is_idempotent():
data = {
"nodes": [{"id": "pkg_a", "label": "a.py", "file_type": "code",
"source_file": "pkg/a.py"}],
"links": [{"source": "pkg_a", "target": "typing", "relation": "imports"}],
}
mint_external_stubs_in_data(data)
mint_external_stubs_in_data(data) # second pass must not duplicate
stubs = [n for n in data["nodes"] if n.get("external")]
assert [n["id"] for n in stubs] == ["typing"]
def test_external_stub_unifies_across_repos_in_merge():
def mk(file_id: str) -> nx.Graph:
return build_from_json({
"nodes": [{"id": file_id, "label": f"{file_id}.py", "file_type": "code",
"source_file": f"{file_id}.py"}],
"links": [{"source": file_id, "target": "typing", "relation": "imports",
"source_file": f"{file_id}.py", "confidence": "EXTRACTED", "weight": 1.0}],
})
merged = nx.compose(
prefix_graph_for_global(mk("a"), "repoA"),
prefix_graph_for_global(mk("b"), "repoB"),
)
assert "typing" in merged.nodes, "external module must stay a single global id"
assert "repoA::typing" not in merged.nodes and "repoB::typing" not in merged.nodes
assert merged.nodes["typing"].get("repo") is None, "an external node belongs to no repo"
# both repos' import edges land on the one shared node
assert merged.degree("typing") == 2
def test_no_cluster_update_leaves_no_undeclared_endpoint(tmp_path: Path):
"""End-to-end: `graphify update --no-cluster` writes the raw merged
extraction, not a build_from_json graph, so it must stub external endpoints
on that path too. Routes through the real watch rebuild."""
from graphify.watch import _rebuild_code
corpus = tmp_path / "corpus"
(corpus / "pkg").mkdir(parents=True)
(corpus / "pkg" / "a.py").write_text(
"import typing\nfrom pathlib import Path\nfrom .b import helper\n\n"
"def go(x: 'typing.Any') -> None:\n helper(Path(str(x)))\n",
encoding="utf-8",
)
(corpus / "pkg" / "b.py").write_text(
"import re\n\ndef helper(x):\n return re.match(r'.', str(x))\n", encoding="utf-8"
)
(corpus / "pkg" / "__init__.py").write_text("from .a import go\n", encoding="utf-8")
assert _rebuild_code(corpus, no_cluster=True, acquire_lock=False) is True
data = json.loads((corpus / "graphify-out" / "graph.json").read_text(encoding="utf-8"))
declared = {n["id"] for n in data["nodes"]}
dangling = [
(e.get("source"), e.get("target"))
for e in data["links"]
if e.get("source") not in declared or e.get("target") not in declared
]
assert not dangling, f"graph.json has undeclared edge endpoints: {dangling}"
# networkx must not have to materialise any phantom node
G = nx.node_link_graph(data, edges="links")
assert G.number_of_nodes() == len(data["nodes"])
# the stdlib imports resolved to typed external stubs
externals = {n["id"] for n in data["nodes"] if n.get("external")}
assert {"typing", "pathlib", "re"} <= externals
def _graph(corpus: Path) -> dict:
return json.loads((corpus / "graphify-out" / "graph.json").read_text(encoding="utf-8"))
def _two_file_corpus(tmp_path: Path) -> Path:
corpus = tmp_path / "corpus"
corpus.mkdir()
(corpus / "a.py").write_text(
"import bisect\nimport json\n\n\ndef find(xs, x):\n return bisect.bisect_left(xs, x)\n",
encoding="utf-8",
)
(corpus / "b.py").write_text(
"import json\nfrom a import find\n\n\ndef use():\n return json.dumps(find([1, 2], 2))\n",
encoding="utf-8",
)
return corpus
@pytest.mark.parametrize("no_cluster", [True, False], ids=["no_cluster", "clustered"])
@pytest.mark.parametrize("incremental", [False, True], ids=["full", "incremental"])
def test_external_stub_is_dropped_with_its_last_import(tmp_path: Path, no_cluster: bool, incremental: bool):
"""A stub outlived its last import edge: the reload backfill stamped it
`_origin=semantic`, reconcile keeps semantic nodes, and the node stayed in
graph.json forever with no edge — a node a fresh build does not have."""
from graphify.watch import _rebuild_code
corpus = _two_file_corpus(tmp_path)
assert _rebuild_code(corpus, no_cluster=no_cluster, acquire_lock=False) is True
assert _rebuild_code(corpus, no_cluster=no_cluster, acquire_lock=False) is True
assert "bisect" in {n["id"] for n in _graph(corpus)["nodes"]}
(corpus / "a.py").write_text(
"import json\n\n\ndef find(xs, x):\n return xs.index(x)\n", encoding="utf-8"
)
changed = [corpus / "a.py"] if incremental else None
assert _rebuild_code(corpus, changed_paths=changed, no_cluster=no_cluster, acquire_lock=False) is True
data = _graph(corpus)
ids = {n["id"] for n in data["nodes"]}
assert "bisect" not in ids, "stub of a removed import must not outlive its last edge"
# a stub other import edges still point at is kept
assert "json" in ids
links = data.get("links", data.get("edges", []))
assert any(e["target"] == "json" for e in links)
def test_rebuild_writes_external_stubs_like_a_fresh_build(tmp_path: Path):
"""Rebuilding an unchanged tree gave external stubs `_origin: semantic`
that the first build never wrote, so the same tree had two graph.json files."""
from graphify.watch import _rebuild_code
corpus = _two_file_corpus(tmp_path)
assert _rebuild_code(corpus, no_cluster=True, acquire_lock=False) is True
first = {n["id"]: n for n in _graph(corpus)["nodes"]}
assert _rebuild_code(corpus, no_cluster=True, acquire_lock=False) is True
second = {n["id"]: n for n in _graph(corpus)["nodes"]}
assert first["bisect"] == second["bisect"]
assert first["json"] == second["json"]
assert "_origin" not in second["json"]
def test_rebuild_heals_stub_left_by_an_earlier_version(tmp_path: Path):
"""A graph written before the fix carries `_origin: semantic` stubs, some
with no edge left. One rebuild drops the orphan and clears the stamp."""
from graphify.watch import _rebuild_code
corpus = _two_file_corpus(tmp_path)
assert _rebuild_code(corpus, no_cluster=True, acquire_lock=False) is True
graph_path = corpus / "graphify-out" / "graph.json"
data = _graph(corpus)
for node in data["nodes"]:
if node.get("external"):
node["_origin"] = "semantic"
data["nodes"].append({
"id": "requests", "label": "requests", "file_type": "concept", "type": "external",
"external": True, "source_file": "", "_origin": "semantic",
})
graph_path.write_text(json.dumps(data), encoding="utf-8")
assert _rebuild_code(corpus, no_cluster=True, acquire_lock=False) is True
nodes = {n["id"]: n for n in _graph(corpus)["nodes"]}
assert "requests" not in nodes
assert "_origin" not in nodes["bisect"]
def test_backfill_origin_leaves_external_stubs_unstamped():
from graphify.build import _backfill_origin
stub = {"id": "os", "label": "os", "file_type": "concept", "type": "external",
"external": True, "source_file": "", "_origin": "semantic"}
_backfill_origin(stub)
assert "_origin" not in stub
legacy_ast = {"id": "a_f", "source_file": "a.py", "source_location": "L3"}
_backfill_origin(legacy_ast)
assert legacy_ast["_origin"] == "ast"
legacy_semantic = {"id": "concept_x", "source_file": "notes.md", "source_location": None}
_backfill_origin(legacy_semantic)
assert legacy_semantic["_origin"] == "semantic"
stamped = {"id": "b_g", "source_file": "b.py", "_origin": "semantic", "external": True}
_backfill_origin(stamped) # not a stub (has a source file): an explicit stamp wins
assert stamped["_origin"] == "semantic"