Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

fix(presets): skip an unreadable restore source in `preset remove` (#4020)

Noor ul ain1a44a6aa080c
diff --git a/src/specify_cli/presets/__init__.py b/src/specify_cli/presets/__init__.py
index 224e28681..6a359f5b2 100644
--- a/src/specify_cli/presets/__init__.py
+++ b/src/specify_cli/presets/__init__.py
@@ -3268,6 +3268,30 @@ class PresetManager:
if source in owned_sources:
shutil.rmtree(skill_subdir)
+ @staticmethod
+ def _warn_unrestored_skill(
+ skill_name: str, source_file: Path, exc: BaseException
+ ) -> None:
+ """Warn that a skill kept preset content because its restore source is unreadable.
+
+ Skipping the restore is the safe recovery β€” the alternative branch
+ deletes the skill outright β€” but it is still a partial removal: the
+ preset directory and registry entry go away while this ``SKILL.md``
+ keeps the removed preset's content, and reconciliation never revisits
+ it because the name is left out of ``mutated_names``. Name the skill
+ and the source so the condition is actionable instead of silent.
+ """
+ import warnings
+
+ warnings.warn(
+ f"Skill '{skill_name}' still contains the removed preset's content: "
+ f"its restore source '{source_file}' could not be read "
+ f"({exc.__class__.__name__}: {exc}). The skill was left in place "
+ f"rather than deleted. Fix or remove that file and re-run "
+ f"'specify preset add'/'specify preset remove' to refresh it.",
+ stacklevel=2,
+ )
+
def _unregister_skills_in_dir(
self,
skill_names: List[str],
@@ -3394,8 +3418,20 @@ class PresetManager:
core_file = None
if core_file:
- # Restore from core template
- content = core_file.read_text(encoding="utf-8")
+ # Restore from core template. An unreadable/undecodable
+ # source cannot produce restored content, so leave the
+ # existing skill untouched rather than leaking a raw
+ # OSError/UnicodeDecodeError out of `preset remove` β€” and
+ # rather than falling through to the rmtree below, which
+ # would delete a skill precisely when its replacement
+ # cannot be generated. Matches the `continue` guards above
+ # (unsafe name, missing subdir, foreign owner), which also
+ # skip without recording the name as mutated.
+ try:
+ content = core_file.read_text(encoding="utf-8")
+ except (OSError, UnicodeDecodeError) as exc:
+ self._warn_unrestored_skill(skill_name, core_file, exc)
+ continue
frontmatter, body = registrar.parse_frontmatter(content)
if isinstance(selected_ai, str):
body = registrar.resolve_skill_placeholders(
@@ -3436,7 +3472,16 @@ class PresetManager:
continue
if extension_restore:
- content = extension_restore["source_file"].read_text(encoding="utf-8")
+ # Same boundary as the core-template branch above: an
+ # unreadable extension source leaves the skill in place
+ # instead of crashing or being deleted.
+ try:
+ content = extension_restore["source_file"].read_text(encoding="utf-8")
+ except (OSError, UnicodeDecodeError) as exc:
+ self._warn_unrestored_skill(
+ skill_name, extension_restore["source_file"], exc
+ )
+ continue
frontmatter, body = registrar.parse_frontmatter(content)
# Mirror the register-time rewrite (#2101): resolve
# extension-relative subdir references (agents/,
diff --git a/tests/test_presets.py b/tests/test_presets.py
index 3cad6608d..317a1b437 100644
--- a/tests/test_presets.py
+++ b/tests/test_presets.py
@@ -9452,6 +9452,155 @@ class TestPresetSkills:
"---\nname: speckit-specify\n---\n\nuser-owned content\n"
)
+ def test_unregister_skills_in_dir_unreadable_core_template_skips(
+ self, project_dir
+ ):
+ """An undecodable core template must not crash `preset remove`.
+
+ Every other failure in the restore loop β€” an unsafe registry name,
+ a missing skill subdirectory, a foreign owner β€” skips the skill
+ with ``continue``. The core-template read was outside that
+ boundary, so one non-UTF-8 project-owned override in
+ ``.specify/templates/commands/`` raised a raw ``UnicodeDecodeError``
+ straight out of ``PresetManager.remove()``, which has no handler
+ for it. Sibling reads of the very same directory are already
+ guarded (``_substitute_core_template``, the provenance reads in
+ ``_infer_legacy_skill_provenance``).
+ """
+ self._write_init_options(project_dir, ai="claude", ai_skills=True)
+ skills_dir = project_dir / ".claude" / "skills"
+ skill_dir = self._create_skill(
+ skills_dir, "speckit-specify", "installed content"
+ )
+ core_commands = project_dir / ".specify" / "templates" / "commands"
+ core_commands.mkdir(parents=True, exist_ok=True)
+ (core_commands / "specify.md").write_bytes(
+ b"---\ndescription: \xff\xfe not utf-8\n---\n\nCore body\n"
+ )
+
+ manager = PresetManager(project_dir)
+ with pytest.warns(UserWarning, match="speckit-specify"):
+ mutated = manager._unregister_skills_in_dir(
+ ["speckit-specify"], skills_dir, "claude"
+ )
+
+ assert mutated == [], (
+ "a skill whose restore source could not be read was not "
+ "restored, so it must not be reported as mutated"
+ )
+ assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
+ "---\nname: speckit-specify\n---\n\ninstalled content\n"
+ ), (
+ "an unreadable core template must leave the skill untouched β€” "
+ "falling through to the rmtree branch would delete it exactly "
+ "when its replacement cannot be generated"
+ )
+
+ def test_unregister_skills_in_dir_unreadable_core_template_oserror_skips(
+ self, project_dir, monkeypatch
+ ):
+ """The same boundary must cover ``OSError`` (e.g. permission denied).
+
+ Mocked rather than chmod-based so the case also holds under
+ privileged CI, where permission bits are not enforced.
+ """
+ self._write_init_options(project_dir, ai="claude", ai_skills=True)
+ skills_dir = project_dir / ".claude" / "skills"
+ skill_dir = self._create_skill(
+ skills_dir, "speckit-specify", "installed content"
+ )
+ core_commands = project_dir / ".specify" / "templates" / "commands"
+ core_commands.mkdir(parents=True, exist_ok=True)
+ core_template = core_commands / "specify.md"
+ core_template.write_text(
+ "---\ndescription: Core specify\n---\n\nCore body\n",
+ encoding="utf-8",
+ )
+
+ original_read_text = Path.read_text
+
+ def failing_read_text(self_path, *args, **kwargs):
+ if self_path == core_template:
+ raise PermissionError(13, "Permission denied")
+ return original_read_text(self_path, *args, **kwargs)
+
+ monkeypatch.setattr(Path, "read_text", failing_read_text)
+
+ manager = PresetManager(project_dir)
+ with pytest.warns(UserWarning, match="speckit-specify"):
+ mutated = manager._unregister_skills_in_dir(
+ ["speckit-specify"], skills_dir, "claude"
+ )
+
+ monkeypatch.undo()
+
+ assert mutated == []
+ assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
+ "---\nname: speckit-specify\n---\n\ninstalled content\n"
+ )
+
+ def test_unregister_skills_in_dir_unreadable_extension_source_skips(
+ self, project_dir
+ ):
+ """The extension-restore arm needs the same boundary as the core arm.
+
+ The two restore reads are independent branches β€” a skill backed by an
+ installed extension never reaches the core-template read β€” so this
+ half of the guard can regress on its own. An undecodable extension
+ command file must warn, leave the skill byte-for-byte intact, and stay
+ out of ``mutated_names``.
+ """
+ self._write_init_options(project_dir, ai="claude", ai_skills=True)
+ skills_dir = project_dir / ".claude" / "skills"
+ skill_dir = self._create_skill(
+ skills_dir, "speckit-fakeext-cmd", "installed content"
+ )
+
+ extension_dir = project_dir / ".specify" / "extensions" / "fakeext"
+ (extension_dir / "commands").mkdir(parents=True, exist_ok=True)
+ (extension_dir / "commands" / "cmd.md").write_bytes(
+ b"---\ndescription: \xff\xfe not utf-8\n---\n\nExtension body\n"
+ )
+ extension_manifest = {
+ "schema_version": "1.0",
+ "extension": {
+ "id": "fakeext",
+ "name": "Fake Extension",
+ "version": "1.0.0",
+ "description": "Test",
+ },
+ "requires": {"speckit_version": ">=0.1.0"},
+ "provides": {
+ "commands": [
+ {
+ "name": "speckit.fakeext.cmd",
+ "file": "commands/cmd.md",
+ "description": "Fake extension command",
+ }
+ ]
+ },
+ }
+ with open(extension_dir / "extension.yml", "w") as f:
+ yaml.dump(extension_manifest, f)
+
+ manager = PresetManager(project_dir)
+ with pytest.warns(UserWarning, match="speckit-fakeext-cmd"):
+ mutated = manager._unregister_skills_in_dir(
+ ["speckit-fakeext-cmd"], skills_dir, "claude"
+ )
+
+ assert mutated == [], (
+ "a skill whose extension restore source could not be read was "
+ "not restored, so it must not be reported as mutated"
+ )
+ assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
+ "---\nname: speckit-fakeext-cmd\n---\n\ninstalled content\n"
+ ), (
+ "an unreadable extension source must leave the skill untouched β€” "
+ "falling through to the rmtree branch would delete it exactly "
+ "when its replacement cannot be generated"
+ )
+
def test_unregister_skills_in_dir_rejects_absolute_registry_name(
self, project_dir
):