Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions src/specify_cli/extensions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -828,13 +828,32 @@ def is_corrupt(self) -> bool:
return False

def _save(self):
"""Save registry to disk."""
"""Save registry to disk.

The JSON goes to a temporary file that then replaces the registry, so
a write that fails part-way (disk full, interrupted process) leaves
the previous registry intact. Truncating the registry in place would
leave a partial file that ``_load()`` treats as corrupt and empty.
"""
from ..integrations._file_changes import after_file_change, before_file_change

before_file_change(self.registry_path)
self.extensions_dir.mkdir(parents=True, exist_ok=True)
with open(self.registry_path, "w", encoding="utf-8") as f:
json.dump(self.data, f, indent=2)
fd, temp_name = tempfile.mkstemp(
prefix=f"{self.REGISTRY_FILE}.", suffix=".tmp", dir=self.extensions_dir
)
temp_path = Path(temp_name)
try:
with os.fdopen(fd, "w", encoding="utf-8") as f:
json.dump(self.data, f, indent=2)
try:
mode = stat.S_IMODE(self.registry_path.stat().st_mode)
except OSError:
mode = 0o644
temp_path.chmod(mode)
Comment on lines +851 to +853
os.replace(temp_path, self.registry_path)
finally:
temp_path.unlink(missing_ok=True)
after_file_change(self.registry_path)

def add(self, extension_id: str, metadata: dict):
Expand Down
52 changes: 52 additions & 0 deletions tests/test_extensions.py
Original file line number Diff line number Diff line change
Expand Up @@ -1628,6 +1628,58 @@ def test_load_starts_fresh_for_non_utf8_registry(self, temp_dir):
assert registry.list() == {}
assert not registry.is_installed("test-ext")

def test_interrupted_save_keeps_previous_registry(self, temp_dir, monkeypatch):
"""A write that fails part-way must not truncate the saved registry.

``_save()`` used to open the registry with ``"w"`` (truncating it) and
then stream the JSON. A disk-full error mid-write left a truncated
file, which ``_load()`` reads as corrupt and replaces with an empty
registry, so every installed extension disappeared from it.
"""
extensions_dir = temp_dir / "extensions"
extensions_dir.mkdir()
registry = ExtensionRegistry(extensions_dir)
registry.add("first-ext", {"version": "1.0.0"})
saved = registry.registry_path.read_text(encoding="utf-8")

real_dumps = json.dumps

def partial_dump(obj, fp, **kwargs):
fp.write(real_dumps(obj, **kwargs)[:20])
raise OSError(28, "No space left on device")

monkeypatch.setattr(_ext_module.json, "dump", partial_dump)
with pytest.raises(OSError, match="No space left"):
registry.add("second-ext", {"version": "2.0.0"})
monkeypatch.undo()

assert registry.registry_path.read_text(encoding="utf-8") == saved
reloaded = ExtensionRegistry(extensions_dir)
assert reloaded.is_installed("first-ext")
assert not reloaded.is_installed("second-ext")
assert sorted(p.name for p in extensions_dir.iterdir()) == [
ExtensionRegistry.REGISTRY_FILE
]

@pytest.mark.skipif(os.name == "nt", reason="POSIX mode bits")
def test_save_replaces_registry_and_keeps_its_mode(self, temp_dir):
"""A successful save writes the new data, keeps the file mode, and
leaves no temporary file next to the registry."""
extensions_dir = temp_dir / "extensions"
extensions_dir.mkdir()
registry = ExtensionRegistry(extensions_dir)
registry.add("first-ext", {"version": "1.0.0"})
registry.registry_path.chmod(0o640)

registry.add("second-ext", {"version": "2.0.0"})

data = json.loads(registry.registry_path.read_text(encoding="utf-8"))
assert sorted(data["extensions"]) == ["first-ext", "second-ext"]
assert registry.registry_path.stat().st_mode & 0o777 == 0o640
assert sorted(p.name for p in extensions_dir.iterdir()) == [
ExtensionRegistry.REGISTRY_FILE
]


# ===== ExtensionManager Tests =====

Expand Down
Loading