Skip to content

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

fix: skip codex config.toml rewrite when there's nothing to merge (#4564)

Jialong(Bruce) Li335c155a5c93
diff --git a/src/specify_cli/events.py b/src/specify_cli/events.py
index 17a9d7ffb..363266171 100644
--- a/src/specify_cli/events.py
+++ b/src/specify_cli/events.py
@@ -2129,7 +2129,10 @@ def _merge_toml_fragment(dst: Path, fragment: str) -> bool:
An unreadable or undecodable pre-existing file aborts the merge instead
of discarding the user's bytes, mirroring ``_load_user_json`` (#22).
Returns False when skipped so callers avoid tracking the untouched file
- (S5).
+ (S5) β€” including when there is no fragment to add and no owned blocks to
+ remove, so a no-op install doesn't rewrite (and, via text-mode newline
+ translation, mangle the line endings of) an untouched pre-existing file
+ (#4563).
"""
_ensure_safe_destination(dst)
existing = ""
@@ -2144,14 +2147,16 @@ def _merge_toml_fragment(dst: Path, fragment: str) -> bool:
)
logger.debug("Read error detail: %s", exc)
return False
- existing = re.sub(
+ stripped = re.sub(
r'\[\[hooks\.\w+\]\]\n(?:(?!\[\[hooks\.\w+\]\]).)*?speckit_marker = true\n*',
"",
existing,
flags=re.DOTALL,
)
+ if not fragment and stripped == existing:
+ return False
dst.parent.mkdir(parents=True, exist_ok=True)
- dst.write_text(existing.rstrip() + "\n\n" + fragment + "\n", encoding="utf-8")
+ dst.write_text(stripped.rstrip() + "\n\n" + fragment + "\n", encoding="utf-8")
return True
@@ -2195,6 +2200,11 @@ def _remove_toml_entries(dst: Path) -> bool:
"""Remove Specify-marked TOML entries; delete the file if now empty (#14).
Returns True if the file was deleted (no user content remained).
+
+ Leaves the file untouched (no write) when there are no Specify-owned
+ blocks to strip, so a no-op teardown/install doesn't rewrite (and, via
+ text-mode newline translation, mangle the line endings of) an untouched
+ pre-existing file (#4563).
"""
if not dst.exists():
return False
@@ -2221,8 +2231,11 @@ def _remove_toml_entries(dst: Path) -> bool:
existing,
flags=re.DOTALL,
)
- # If only whitespace/comments remain, the file had no user content β€”
- # delete it rather than leaving an empty stub that confuses uninstall.
+ if cleaned == existing:
+ return False
+ # Stripping removed a Specify-owned block. If only whitespace/comments
+ # remain, the file had no user content β€” delete it rather than leaving
+ # an empty stub that confuses uninstall.
stripped = "\n".join(
line for line in cleaned.splitlines()
if line.strip() and not line.strip().startswith("#")
diff --git a/tests/integrations/test_events.py b/tests/integrations/test_events.py
index 0168f4302..3c3289128 100644
--- a/tests/integrations/test_events.py
+++ b/tests/integrations/test_events.py
@@ -937,6 +937,115 @@ class TestTomlUnreadableConfig:
assert config_path.read_bytes() == user_bytes
+class TestTomlNoOpMerge:
+ """#4563: installing with no resolved events must leave a pre-existing,
+ Specify-unowned config.toml byte-for-byte untouched.
+
+ This is the real ``specify integration install codex`` repro: a project
+ with no Codex-specific event hooks configured resolves to ``events={}``
+ (see ``resolve_events``), which routes through
+ ``install_integration_events``'s empty-map branch into
+ ``_remove_native_event_hooks`` -> ``_remove_toml_entries`` β€” not through
+ ``_merge_toml_fragment``, which only runs when there is at least one
+ supported, non-empty event to merge. ``_remove_toml_entries`` computed
+ ``cleaned`` via a regex strip and then unconditionally called
+ ``dst.write_text(cleaned, ...)`` even when ``cleaned == existing`` (no
+ Specify-marked blocks present), which (through Python's text-mode
+ newline translation on read/write) silently changed the file's
+ line-ending convention on Windows β€” turning a clean install into a
+ spurious git diff with no semantic change.
+ """
+
+ def test_no_events_leaves_existing_config_untouched(self, tmp_path):
+ from specify_cli.integrations.codex import CodexIntegration
+
+ integration = CodexIntegration()
+ manifest = _claude_manifest(tmp_path)
+ config_path = tmp_path / ".codex" / "config.toml"
+ config_path.parent.mkdir(parents=True)
+ original_bytes = b"project_doc_max_bytes = 200000"
+ config_path.write_bytes(original_bytes)
+ mtime_before = config_path.stat().st_mtime_ns
+
+ # The real no-extensions-installed shape: resolve_events() returns an
+ # empty map when no built-in defaults, extensions, or overrides
+ # contribute any handlers.
+ install_integration_events(
+ integration, tmp_path, manifest,
+ {},
+ )
+
+ assert config_path.read_bytes() == original_bytes
+ # An unconditional rewrite can reproduce identical bytes on Linux
+ # (text-mode newline translation is a no-op when the platform line
+ # separator is already "\n"), so byte equality alone doesn't catch
+ # the defect here; assert the file was never even opened for
+ # writing, which is what actually mangles line endings on Windows.
+ assert config_path.stat().st_mtime_ns == mtime_before
+ manifest.record_existing.assert_not_called()
+
+ def test_comments_only_config_untouched_on_teardown(self, tmp_path):
+ """The no-op guard must run before the empty/comments-only deletion
+ branch: a comments-only file has no Specify-owned blocks to strip,
+ so ``cleaned == existing`` and the file must be left in place, not
+ unlinked as if it were an empty stub."""
+ from specify_cli.integrations.codex import CodexIntegration
+
+ integration = CodexIntegration()
+ manifest = _claude_manifest(tmp_path)
+ config_path = tmp_path / ".codex" / "config.toml"
+ config_path.parent.mkdir(parents=True)
+ original_bytes = b"# managed by the user, not Specify\n# second comment line\n"
+ config_path.write_bytes(original_bytes)
+ mtime_before = config_path.stat().st_mtime_ns
+
+ install_integration_events(integration, tmp_path, manifest, {})
+
+ assert config_path.exists(), "comments-only user config was deleted"
+ assert config_path.read_bytes() == original_bytes
+ assert config_path.stat().st_mtime_ns == mtime_before
+ manifest.record_existing.assert_not_called()
+
+ def test_blank_config_untouched_on_teardown(self, tmp_path):
+ """Same as above for a whitespace-only pre-existing file."""
+ from specify_cli.integrations.codex import CodexIntegration
+
+ integration = CodexIntegration()
+ manifest = _claude_manifest(tmp_path)
+ config_path = tmp_path / ".codex" / "config.toml"
+ config_path.parent.mkdir(parents=True)
+ original_bytes = b"\n\n"
+ config_path.write_bytes(original_bytes)
+ mtime_before = config_path.stat().st_mtime_ns
+
+ install_integration_events(integration, tmp_path, manifest, {})
+
+ assert config_path.exists(), "blank user config was deleted"
+ assert config_path.read_bytes() == original_bytes
+ assert config_path.stat().st_mtime_ns == mtime_before
+ manifest.record_existing.assert_not_called()
+
+ def test_owned_only_config_still_deleted_on_teardown(self, tmp_path):
+ """The unchanged-content guard must not defeat the existing cleanup:
+ when the file contains only a Specify-owned block that teardown
+ actually strips, ``cleaned != existing`` and the resulting
+ comments/whitespace-only remainder is still deleted (#14)."""
+ from specify_cli.integrations.codex import CodexIntegration
+
+ integration = CodexIntegration()
+ manifest = _claude_manifest(tmp_path)
+ install_integration_events(
+ integration, tmp_path, manifest,
+ {"pre_tool_use": [{"command": "speckit.tdd.validate"}]},
+ )
+ config_path = tmp_path / ".codex" / "config.toml"
+ assert config_path.is_file()
+
+ remove_integration_events(integration, tmp_path, manifest)
+
+ assert not config_path.exists()
+
+
# -- Opencode TS Plugin merging ---------------------------------------------
class TestOpencodePluginMerging: