mirror of
https://github.com/github/spec-kit.git
synced 2026-03-19 11:53:08 +00:00
feat(extensions,presets): add priority-based resolution ordering (#1855)
* feat(extensions,presets): add priority-based resolution ordering Add priority field to extension and preset registries for deterministic template resolution when multiple sources provide the same template. Extensions: - Add `list_by_priority()` method to ExtensionRegistry - Add `--priority` option to `extension add` command - Add `extension set-priority` command - Show priority in `extension list` and `extension info` - Preserve priority during `extension update` - Update RFC documentation Presets: - Add `preset set-priority` command - Show priority in `preset info` output - Use priority ordering in PresetResolver for extensions Both systems: - Lower priority number = higher precedence (default: 10) - Backwards compatible with legacy entries (missing priority defaults to 10) - Comprehensive test coverage including backwards compatibility Closes #1845 Closes #1854 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address code review feedback - list_by_priority(): add secondary sort by ID for deterministic ordering, return deep copies to prevent mutation - install_from_directory/zip: validate priority >= 1 early - extension add CLI: validate --priority >= 1 before install - PresetRegistry.update(): preserve installed_at timestamp - Test assertions: use exact source string instead of substring match Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address additional review feedback - PresetResolver: add fallback to directory scanning when registry is empty/corrupted for robustness and backwards compatibility - PresetRegistry.update(): add guard to prevent injecting installed_at when absent in existing entry (mirrors ExtensionRegistry behavior) - RFC: update extension list example to match actual CLI output format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: restore defensive code and RFC descriptions lost in rebase - Restore defensive code in list_by_priority() with .get() and isinstance check - Restore detailed --from URL and --dev option descriptions in RFC Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: add defensive code to presets list_by_priority() - Add .get() and isinstance check for corrupted/empty registry - Move copy import to module level (remove local import) - Matches defensive pattern used in extensions.py Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address reviewer feedback on priority resolution - Rename _normalize_priority to normalize_priority (public API) - Add comprehensive tests for normalize_priority function (9 tests) - Filter non-dict metadata entries in list_by_priority() methods - Fix extension priority resolution to merge registered and unregistered extensions into unified sorted list (unregistered get implicit priority 10) - Add tests for extension priority resolution ordering (4 tests) The key fix ensures unregistered extensions with implicit priority 10 correctly beat registered extensions with priority > 10, and vice versa. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: DRY refactor and strengthen test assertions - Extract _get_all_extensions_by_priority() helper in PresetResolver to eliminate duplicated extension list construction - Add priority=10 assertion to test_legacy_extension_without_priority_field - Add priority=10 assertion to test_legacy_preset_without_priority_field Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: add isinstance(dict) checks for corrupted registry entries Add defensive checks throughout CLI commands and manager methods to handle cases where registry entries may be corrupted (non-dict values). This prevents AttributeError when calling .get() on non-dict metadata. Locations fixed: - __init__.py: preset/extension info, set-priority, enable/disable, upgrade commands - extensions.py: list_installed() - presets.py: list_installed() Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: normalize priority display to match resolution behavior Use normalize_priority() for all priority display in CLI commands to ensure displayed values match actual resolution behavior when registry data is corrupted/hand-edited. Locations fixed: - extensions.py: list_installed() - presets.py: list_installed(), PresetResolver - __init__.py: preset info, extension info, set-priority commands Also added GraphQL query for unresolved PR comments to CLAUDE.md. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: repair corrupted priority values in set-priority commands Changed set-priority commands to check if the raw stored value is already a valid int equal to the requested priority before skipping. This ensures corrupted values (e.g., "high") get repaired even when setting to the default priority (10). Also removed CLAUDE.md that was accidentally added to the repo. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: harden registry update methods against corrupted entries - Normalize priority when restoring during extension update to prevent propagating corrupted values (e.g., "high", 0, negative) - Add isinstance(dict) checks in ExtensionRegistry.update() and PresetRegistry.update() to handle corrupted entries (string/list) that would cause TypeError on merge Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use safe fallback for version in list_installed() When registry entry is corrupted (non-dict), metadata becomes {} after the isinstance check. Use metadata.get("version", manifest.version) instead of metadata["version"] to avoid KeyError. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: iamaeroplane <michal.bachorik@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -32,6 +32,7 @@ from specify_cli.presets import (
|
||||
PresetCompatibilityError,
|
||||
VALID_PRESET_TEMPLATE_TYPES,
|
||||
)
|
||||
from specify_cli.extensions import ExtensionRegistry
|
||||
|
||||
|
||||
# ===== Fixtures =====
|
||||
@@ -573,6 +574,24 @@ class TestRegistryPriority:
|
||||
assert sorted_packs[0][0] == "pack-b"
|
||||
assert sorted_packs[1][0] == "pack-a"
|
||||
|
||||
def test_list_by_priority_invalid_priority_defaults(self, temp_dir):
|
||||
"""Malformed priority values fall back to the default priority."""
|
||||
packs_dir = temp_dir / "packs"
|
||||
packs_dir.mkdir()
|
||||
registry = PresetRegistry(packs_dir)
|
||||
|
||||
registry.add("pack-high", {"version": "1.0.0", "priority": 1})
|
||||
registry.data["presets"]["pack-invalid"] = {
|
||||
"version": "1.0.0",
|
||||
"priority": "high",
|
||||
}
|
||||
registry._save()
|
||||
|
||||
sorted_packs = registry.list_by_priority()
|
||||
|
||||
assert [item[0] for item in sorted_packs] == ["pack-high", "pack-invalid"]
|
||||
assert sorted_packs[1][1]["priority"] == 10
|
||||
|
||||
|
||||
# ===== PresetResolver Tests =====
|
||||
|
||||
@@ -678,6 +697,11 @@ class TestPresetResolver:
|
||||
ext_template = ext_templates_dir / "custom-template.md"
|
||||
ext_template.write_text("# Extension Custom Template\n")
|
||||
|
||||
# Register extension in registry
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("my-ext", {"version": "1.0.0", "priority": 10})
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve("custom-template")
|
||||
assert result is not None
|
||||
@@ -741,10 +765,15 @@ class TestPresetResolver:
|
||||
ext_template = ext_templates_dir / "unique-template.md"
|
||||
ext_template.write_text("# Unique\n")
|
||||
|
||||
# Register extension in registry
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("my-ext", {"version": "1.0.0", "priority": 10})
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve_with_source("unique-template")
|
||||
assert result is not None
|
||||
assert result["source"] == "extension:my-ext"
|
||||
assert result["source"] == "extension:my-ext v1.0.0"
|
||||
|
||||
def test_resolve_with_source_not_found(self, project_dir):
|
||||
"""Test resolve_with_source for nonexistent template."""
|
||||
@@ -765,6 +794,104 @@ class TestPresetResolver:
|
||||
assert result is None
|
||||
|
||||
|
||||
class TestExtensionPriorityResolution:
|
||||
"""Test extension priority resolution with registered and unregistered extensions."""
|
||||
|
||||
def test_unregistered_beats_registered_with_lower_precedence(self, project_dir):
|
||||
"""Unregistered extension (implicit priority 10) beats registered with priority 20."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
extensions_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Create registered extension with priority 20 (lower precedence than 10)
|
||||
registered_dir = extensions_dir / "registered-ext"
|
||||
(registered_dir / "templates").mkdir(parents=True)
|
||||
(registered_dir / "templates" / "test-template.md").write_text("# From Registered\n")
|
||||
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("registered-ext", {"version": "1.0.0", "priority": 20})
|
||||
|
||||
# Create unregistered extension directory (implicit priority 10)
|
||||
unregistered_dir = extensions_dir / "unregistered-ext"
|
||||
(unregistered_dir / "templates").mkdir(parents=True)
|
||||
(unregistered_dir / "templates" / "test-template.md").write_text("# From Unregistered\n")
|
||||
|
||||
# Unregistered (priority 10) should beat registered (priority 20)
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve("test-template")
|
||||
assert result is not None
|
||||
assert "From Unregistered" in result.read_text()
|
||||
|
||||
def test_registered_with_higher_precedence_beats_unregistered(self, project_dir):
|
||||
"""Registered extension with priority 5 beats unregistered (implicit priority 10)."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
extensions_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Create registered extension with priority 5 (higher precedence than 10)
|
||||
registered_dir = extensions_dir / "registered-ext"
|
||||
(registered_dir / "templates").mkdir(parents=True)
|
||||
(registered_dir / "templates" / "test-template.md").write_text("# From Registered\n")
|
||||
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("registered-ext", {"version": "1.0.0", "priority": 5})
|
||||
|
||||
# Create unregistered extension directory (implicit priority 10)
|
||||
unregistered_dir = extensions_dir / "unregistered-ext"
|
||||
(unregistered_dir / "templates").mkdir(parents=True)
|
||||
(unregistered_dir / "templates" / "test-template.md").write_text("# From Unregistered\n")
|
||||
|
||||
# Registered (priority 5) should beat unregistered (priority 10)
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve("test-template")
|
||||
assert result is not None
|
||||
assert "From Registered" in result.read_text()
|
||||
|
||||
def test_unregistered_attribution_with_priority_ordering(self, project_dir):
|
||||
"""Test resolve_with_source correctly attributes unregistered extension."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
extensions_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Create registered extension with priority 20
|
||||
registered_dir = extensions_dir / "registered-ext"
|
||||
(registered_dir / "templates").mkdir(parents=True)
|
||||
(registered_dir / "templates" / "test-template.md").write_text("# From Registered\n")
|
||||
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("registered-ext", {"version": "1.0.0", "priority": 20})
|
||||
|
||||
# Create unregistered extension (implicit priority 10)
|
||||
unregistered_dir = extensions_dir / "unregistered-ext"
|
||||
(unregistered_dir / "templates").mkdir(parents=True)
|
||||
(unregistered_dir / "templates" / "test-template.md").write_text("# From Unregistered\n")
|
||||
|
||||
# Attribution should show unregistered extension
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve_with_source("test-template")
|
||||
assert result is not None
|
||||
assert "unregistered-ext" in result["source"]
|
||||
assert "(unregistered)" in result["source"]
|
||||
|
||||
def test_same_priority_sorted_alphabetically(self, project_dir):
|
||||
"""Extensions with same priority are sorted alphabetically by ID."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
extensions_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Create two unregistered extensions (both implicit priority 10)
|
||||
# "aaa-ext" should come before "zzz-ext" alphabetically
|
||||
zzz_dir = extensions_dir / "zzz-ext"
|
||||
(zzz_dir / "templates").mkdir(parents=True)
|
||||
(zzz_dir / "templates" / "test-template.md").write_text("# From ZZZ\n")
|
||||
|
||||
aaa_dir = extensions_dir / "aaa-ext"
|
||||
(aaa_dir / "templates").mkdir(parents=True)
|
||||
(aaa_dir / "templates" / "test-template.md").write_text("# From AAA\n")
|
||||
|
||||
# AAA should win due to alphabetical ordering at same priority
|
||||
resolver = PresetResolver(project_dir)
|
||||
result = resolver.resolve("test-template")
|
||||
assert result is not None
|
||||
assert "From AAA" in result.read_text()
|
||||
|
||||
|
||||
# ===== PresetCatalog Tests =====
|
||||
|
||||
|
||||
@@ -979,8 +1106,13 @@ class TestIntegration:
|
||||
ext_templates_dir.mkdir(parents=True)
|
||||
(ext_templates_dir / "spec-template.md").write_text("# Extension\n")
|
||||
|
||||
# Register extension in registry
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_registry = ExtensionRegistry(extensions_dir)
|
||||
ext_registry.add("my-ext", {"version": "1.0.0", "priority": 10})
|
||||
|
||||
result = resolver.resolve_with_source("spec-template")
|
||||
assert result["source"] == "extension:my-ext"
|
||||
assert result["source"] == "extension:my-ext v1.0.0"
|
||||
|
||||
# Install pack — should win over extension
|
||||
manager = PresetManager(project_dir)
|
||||
@@ -1710,3 +1842,162 @@ class TestPresetSkills:
|
||||
|
||||
metadata = manager.registry.get("self-test")
|
||||
assert metadata.get("registered_skills", []) == []
|
||||
|
||||
|
||||
class TestPresetSetPriority:
|
||||
"""Test preset set-priority CLI command."""
|
||||
|
||||
def test_set_priority_changes_priority(self, project_dir, pack_dir):
|
||||
"""Test set-priority command changes preset priority."""
|
||||
from typer.testing import CliRunner
|
||||
from unittest.mock import patch
|
||||
from specify_cli import app
|
||||
|
||||
runner = CliRunner()
|
||||
|
||||
# Install preset with default priority
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(pack_dir, "0.1.5")
|
||||
|
||||
# Verify default priority
|
||||
assert manager.registry.get("test-pack")["priority"] == 10
|
||||
|
||||
with patch.object(Path, "cwd", return_value=project_dir):
|
||||
result = runner.invoke(app, ["preset", "set-priority", "test-pack", "5"])
|
||||
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "priority changed: 10 → 5" in result.output
|
||||
|
||||
# Reload registry to see updated value
|
||||
manager2 = PresetManager(project_dir)
|
||||
assert manager2.registry.get("test-pack")["priority"] == 5
|
||||
|
||||
def test_set_priority_same_value_no_change(self, project_dir, pack_dir):
|
||||
"""Test set-priority with same value shows already set message."""
|
||||
from typer.testing import CliRunner
|
||||
from unittest.mock import patch
|
||||
from specify_cli import app
|
||||
|
||||
runner = CliRunner()
|
||||
|
||||
# Install preset with priority 5
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(pack_dir, "0.1.5", priority=5)
|
||||
|
||||
with patch.object(Path, "cwd", return_value=project_dir):
|
||||
result = runner.invoke(app, ["preset", "set-priority", "test-pack", "5"])
|
||||
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "already has priority 5" in result.output
|
||||
|
||||
def test_set_priority_invalid_value(self, project_dir, pack_dir):
|
||||
"""Test set-priority rejects invalid priority values."""
|
||||
from typer.testing import CliRunner
|
||||
from unittest.mock import patch
|
||||
from specify_cli import app
|
||||
|
||||
runner = CliRunner()
|
||||
|
||||
# Install preset
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(pack_dir, "0.1.5")
|
||||
|
||||
with patch.object(Path, "cwd", return_value=project_dir):
|
||||
result = runner.invoke(app, ["preset", "set-priority", "test-pack", "0"])
|
||||
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "Priority must be a positive integer" in result.output
|
||||
|
||||
def test_set_priority_not_installed(self, project_dir):
|
||||
"""Test set-priority fails for non-installed preset."""
|
||||
from typer.testing import CliRunner
|
||||
from unittest.mock import patch
|
||||
from specify_cli import app
|
||||
|
||||
runner = CliRunner()
|
||||
|
||||
with patch.object(Path, "cwd", return_value=project_dir):
|
||||
result = runner.invoke(app, ["preset", "set-priority", "nonexistent", "5"])
|
||||
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "not installed" in result.output.lower()
|
||||
|
||||
|
||||
class TestPresetPriorityBackwardsCompatibility:
|
||||
"""Test backwards compatibility for presets installed before priority feature."""
|
||||
|
||||
def test_legacy_preset_without_priority_field(self, temp_dir):
|
||||
"""Presets installed before priority feature should default to 10."""
|
||||
presets_dir = temp_dir / ".specify" / "presets"
|
||||
presets_dir.mkdir(parents=True)
|
||||
|
||||
# Simulate legacy registry entry without priority field
|
||||
registry = PresetRegistry(presets_dir)
|
||||
registry.data["presets"]["legacy-pack"] = {
|
||||
"version": "1.0.0",
|
||||
"source": "local",
|
||||
"enabled": True,
|
||||
"installed_at": "2025-01-01T00:00:00Z",
|
||||
# No "priority" field - simulates pre-feature preset
|
||||
}
|
||||
registry._save()
|
||||
|
||||
# Reload registry
|
||||
registry2 = PresetRegistry(presets_dir)
|
||||
|
||||
# list_by_priority should use default of 10
|
||||
result = registry2.list_by_priority()
|
||||
assert len(result) == 1
|
||||
assert result[0][0] == "legacy-pack"
|
||||
# Priority defaults to 10 and is normalized in returned metadata
|
||||
assert result[0][1]["priority"] == 10
|
||||
|
||||
def test_legacy_preset_in_list_installed(self, project_dir, pack_dir):
|
||||
"""list_installed returns priority=10 for legacy presets without priority field."""
|
||||
manager = PresetManager(project_dir)
|
||||
|
||||
# Install preset normally
|
||||
manager.install_from_directory(pack_dir, "0.1.5")
|
||||
|
||||
# Manually remove priority to simulate legacy preset
|
||||
pack_data = manager.registry.data["presets"]["test-pack"]
|
||||
del pack_data["priority"]
|
||||
manager.registry._save()
|
||||
|
||||
# list_installed should still return priority=10
|
||||
installed = manager.list_installed()
|
||||
assert len(installed) == 1
|
||||
assert installed[0]["priority"] == 10
|
||||
|
||||
def test_mixed_legacy_and_new_presets_ordering(self, temp_dir):
|
||||
"""Legacy presets (no priority) sort with default=10 among prioritized presets."""
|
||||
presets_dir = temp_dir / ".specify" / "presets"
|
||||
presets_dir.mkdir(parents=True)
|
||||
|
||||
registry = PresetRegistry(presets_dir)
|
||||
|
||||
# Add preset with explicit priority=5
|
||||
registry.add("pack-with-priority", {"version": "1.0.0", "priority": 5})
|
||||
|
||||
# Add legacy preset without priority (manually)
|
||||
registry.data["presets"]["legacy-pack"] = {
|
||||
"version": "1.0.0",
|
||||
"source": "local",
|
||||
"enabled": True,
|
||||
# No priority field
|
||||
}
|
||||
|
||||
# Add another preset with priority=15
|
||||
registry.add("low-priority-pack", {"version": "1.0.0", "priority": 15})
|
||||
registry._save()
|
||||
|
||||
# Reload and check ordering
|
||||
registry2 = PresetRegistry(presets_dir)
|
||||
sorted_presets = registry2.list_by_priority()
|
||||
|
||||
# Should be: pack-with-priority (5), legacy-pack (default 10), low-priority-pack (15)
|
||||
assert [p[0] for p in sorted_presets] == [
|
||||
"pack-with-priority",
|
||||
"legacy-pack",
|
||||
"low-priority-pack",
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user