fix(copilot): make Python hook installation transactional
This commit is contained in:
ZacharyZhang-NY committed
1 parent
97d1525227
commit
16ceac81c4
14 files changed
+2121
-583
No files matched your search
@@ -0,0 +1,277 @@
|
||||
"""Transactional GitHub Copilot CLI hook installation."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from typing import List, Optional, Sequence, Tuple
|
||||
|
||||
from elydora._runtime_paths import resolve_agent_directory
|
||||
|
||||
from ._managed_files import MAX_CONFIG_BYTES, MAX_SECRET_BYTES, MAX_SOURCE_BYTES
|
||||
from ._transaction import (
|
||||
FileChange,
|
||||
FilePrecondition,
|
||||
file_change,
|
||||
source_change,
|
||||
write_changes,
|
||||
)
|
||||
from .base import InstallConfig
|
||||
from .copilot_contract import (
|
||||
AGENT_KEY,
|
||||
AUDIT_SCRIPT,
|
||||
GUARD_SCRIPT,
|
||||
CopilotSources,
|
||||
RenderedDocument,
|
||||
runtime_root,
|
||||
same_path,
|
||||
)
|
||||
from .copilot_io import (
|
||||
require_hooks_enabled,
|
||||
validate_api_origin,
|
||||
validate_private_key,
|
||||
validate_runtime_tree,
|
||||
)
|
||||
from .copilot_schema import validate_javascript_regexes
|
||||
from .guard_template import generate_guard_script
|
||||
from .hook_template import generate_hook_script
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class CopilotRuntimePaths:
|
||||
agent_id: str
|
||||
agent_directory: str
|
||||
guard_path: str
|
||||
audit_path: str
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class PreparedCopilotInstallation:
|
||||
changes: Tuple[FileChange, ...]
|
||||
preconditions: Tuple[FilePrecondition, ...]
|
||||
|
||||
|
||||
def _runtime_config(config: InstallConfig, agent_id: str) -> dict:
|
||||
value = {
|
||||
"org_id": config.get("org_id", ""),
|
||||
"agent_id": agent_id,
|
||||
"kid": config.get("kid", ""),
|
||||
"base_url": config.get("base_url", "https://api.elydora.com"),
|
||||
"agent_name": AGENT_KEY,
|
||||
}
|
||||
token = config.get("token")
|
||||
if token:
|
||||
value["token"] = token
|
||||
return value
|
||||
|
||||
|
||||
def _json_source(value: dict) -> str:
|
||||
return json.dumps(value, indent=2) + "\n"
|
||||
|
||||
|
||||
def _agent_paths(config: InstallConfig) -> CopilotRuntimePaths:
|
||||
agent_id = config.get("agent_id", "")
|
||||
if not agent_id:
|
||||
raise ValueError("agent_id is required")
|
||||
agent_directory = resolve_agent_directory(runtime_root(), agent_id)
|
||||
guard_path = os.path.join(agent_directory, GUARD_SCRIPT)
|
||||
audit_path = os.path.join(agent_directory, AUDIT_SCRIPT)
|
||||
if not same_path(config.get("guard_script_path", ""), guard_path):
|
||||
raise ValueError(
|
||||
"Elydora guard runtime must use the managed agent directory: "
|
||||
f"{guard_path}"
|
||||
)
|
||||
return CopilotRuntimePaths(
|
||||
agent_id,
|
||||
agent_directory,
|
||||
guard_path,
|
||||
audit_path,
|
||||
)
|
||||
|
||||
|
||||
def _validate_install_config(config: InstallConfig) -> None:
|
||||
for field in ("org_id", "agent_id", "kid", "private_key", "base_url"):
|
||||
value = config.get(field)
|
||||
if not isinstance(value, str) or not value:
|
||||
raise ValueError(f"{field} is required")
|
||||
if config.get("agent_name") != AGENT_KEY:
|
||||
raise ValueError(
|
||||
f"GitHub Copilot CLI installation requires agent_name {AGENT_KEY}"
|
||||
)
|
||||
if not os.path.isabs(sys.executable):
|
||||
raise RuntimeError(
|
||||
"GitHub Copilot CLI requires an absolute Python executable path"
|
||||
)
|
||||
validate_private_key(config["private_key"])
|
||||
validate_api_origin(config["base_url"])
|
||||
if "token" in config:
|
||||
token = config["token"]
|
||||
if not isinstance(token, str) or not token:
|
||||
raise ValueError("token must be a non-empty string when provided")
|
||||
_agent_paths(config)
|
||||
|
||||
|
||||
def preflight_copilot_installation(
|
||||
config: InstallConfig,
|
||||
sources: CopilotSources,
|
||||
) -> CopilotRuntimePaths:
|
||||
if not sources.user.file_path:
|
||||
raise ValueError(
|
||||
"GitHub Copilot CLI installation requires a user hook path"
|
||||
)
|
||||
require_hooks_enabled(sources)
|
||||
hook_sources = [sources.user.hooks]
|
||||
if sources.legacy is not None:
|
||||
hook_sources.append(sources.legacy.hooks)
|
||||
validate_javascript_regexes(hook_sources)
|
||||
_validate_install_config(config)
|
||||
paths = _agent_paths(config)
|
||||
validate_runtime_tree(paths.agent_directory, paths.agent_id)
|
||||
return paths
|
||||
|
||||
|
||||
def _runtime_change(
|
||||
file_path: str,
|
||||
label: str,
|
||||
next_source: str,
|
||||
mode: int,
|
||||
maximum_bytes: int = MAX_SOURCE_BYTES,
|
||||
) -> Optional[FileChange]:
|
||||
return file_change(file_path, label, next_source, mode, maximum_bytes)
|
||||
|
||||
|
||||
def _document_change(rendered: RenderedDocument) -> Optional[FileChange]:
|
||||
if not rendered.changed:
|
||||
return None
|
||||
return source_change(
|
||||
rendered.document.file_path,
|
||||
"GitHub Copilot hook source",
|
||||
rendered.document.raw,
|
||||
rendered.next_source,
|
||||
0o600,
|
||||
MAX_SOURCE_BYTES,
|
||||
rendered.document.snapshot,
|
||||
)
|
||||
|
||||
|
||||
def _present(
|
||||
changes: Sequence[Optional[FileChange]],
|
||||
) -> Tuple[FileChange, ...]:
|
||||
return tuple(change for change in changes if change is not None)
|
||||
|
||||
|
||||
def _document_preconditions(
|
||||
rendered: Sequence[RenderedDocument],
|
||||
) -> Tuple[FilePrecondition, ...]:
|
||||
return tuple(
|
||||
FilePrecondition(
|
||||
item.document.file_path,
|
||||
"GitHub Copilot hook source",
|
||||
item.document.snapshot,
|
||||
MAX_SOURCE_BYTES,
|
||||
)
|
||||
for item in rendered
|
||||
if not item.changed
|
||||
)
|
||||
|
||||
|
||||
def _settings_preconditions(
|
||||
sources: CopilotSources,
|
||||
) -> Tuple[FilePrecondition, ...]:
|
||||
return tuple(
|
||||
FilePrecondition(
|
||||
item.file_path,
|
||||
item.label,
|
||||
item.snapshot,
|
||||
MAX_SOURCE_BYTES,
|
||||
)
|
||||
for item in sources.settings_preconditions
|
||||
)
|
||||
|
||||
|
||||
def _validate_rendered_documents(
|
||||
sources: CopilotSources,
|
||||
rendered: Sequence[RenderedDocument],
|
||||
) -> None:
|
||||
expected = [sources.user]
|
||||
if sources.legacy is not None:
|
||||
expected.append(sources.legacy)
|
||||
if len(rendered) != len(expected):
|
||||
raise ValueError("GitHub Copilot rendered source set is incomplete")
|
||||
for document in expected:
|
||||
matches = [
|
||||
item for item in rendered
|
||||
if same_path(item.document.file_path, document.file_path)
|
||||
]
|
||||
if len(matches) != 1:
|
||||
raise ValueError(
|
||||
"GitHub Copilot rendered source set contains unexpected paths"
|
||||
)
|
||||
|
||||
|
||||
def prepare_copilot_installation(
|
||||
config: InstallConfig,
|
||||
sources: CopilotSources,
|
||||
rendered: Sequence[RenderedDocument],
|
||||
) -> PreparedCopilotInstallation:
|
||||
paths = preflight_copilot_installation(config, sources)
|
||||
_validate_rendered_documents(sources, rendered)
|
||||
guard_script = generate_guard_script(AGENT_KEY, paths.agent_id)
|
||||
audit_script = generate_hook_script(
|
||||
org_id=config.get("org_id", ""),
|
||||
agent_id=paths.agent_id,
|
||||
kid=config.get("kid", ""),
|
||||
base_url=config.get("base_url", "https://api.elydora.com"),
|
||||
native_payload=True,
|
||||
agent_name=AGENT_KEY,
|
||||
)
|
||||
changes = _present((
|
||||
_runtime_change(
|
||||
paths.guard_path, "Elydora guard runtime", guard_script, 0o700
|
||||
),
|
||||
_runtime_change(
|
||||
os.path.join(paths.agent_directory, "config.json"),
|
||||
"Elydora runtime config",
|
||||
_json_source(_runtime_config(config, paths.agent_id)),
|
||||
0o600,
|
||||
MAX_CONFIG_BYTES,
|
||||
),
|
||||
_runtime_change(
|
||||
os.path.join(paths.agent_directory, "private.key"),
|
||||
"Elydora private key",
|
||||
config.get("private_key", ""),
|
||||
0o600,
|
||||
MAX_SECRET_BYTES,
|
||||
),
|
||||
_runtime_change(
|
||||
paths.audit_path, "Elydora audit runtime", audit_script, 0o700
|
||||
),
|
||||
*(_document_change(item) for item in rendered),
|
||||
))
|
||||
preconditions = (
|
||||
*_settings_preconditions(sources),
|
||||
*_document_preconditions(rendered),
|
||||
)
|
||||
return PreparedCopilotInstallation(changes, preconditions)
|
||||
|
||||
|
||||
def commit_copilot_installation(
|
||||
prepared: PreparedCopilotInstallation,
|
||||
) -> None:
|
||||
write_changes(
|
||||
prepared.changes,
|
||||
"Install GitHub Copilot hooks",
|
||||
prepared.preconditions,
|
||||
)
|
||||
|
||||
|
||||
def prepare_copilot_uninstall(
|
||||
rendered: Sequence[RenderedDocument],
|
||||
) -> Tuple[FileChange, ...]:
|
||||
return _present(tuple(_document_change(item) for item in rendered))
|
||||
|
||||
|
||||
def commit_copilot_uninstall(changes: Sequence[FileChange]) -> None:
|
||||
write_changes(changes, "Uninstall GitHub Copilot hooks")
|
||||
Reference in new issue
Block a user