Skip to content

Commit e63bd4b

Browse files
authored
Remove hook marker schema 0 (#2622)
Drops support for schema 0 hook environment markers.
1 parent 8c433ae commit e63bd4b

3 files changed

Lines changed: 15 additions & 172 deletions

File tree

‎crates/prek/src/cli/cache_gc.rs‎

Lines changed: 4 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
use std::borrow::Cow;
21
use std::fmt::Write;
32
use std::fmt::{Display, Formatter};
43
use std::ops::AddAssign;
@@ -739,16 +738,15 @@ fn detail_lines_for_entry(
739738
info.language_version
740739
));
741740

742-
let (repo_dep, deps) = marker_repo_and_dependencies(info);
743-
if let Some(repo_dep) = repo_dep {
741+
if let Some(repo) = info.repo() {
744742
lines.push(format!(
745743
"{}: {}",
746744
"repo".dimmed().bold(),
747-
truncate_end(&repo_dep, MAX_VALUE_CHARS)
745+
truncate_end(&repo.to_string(), MAX_VALUE_CHARS)
748746
));
749747
}
750-
if !deps.is_empty() {
751-
let deps_str = format_dependency_list(&deps, 6, MAX_VALUE_CHARS);
748+
if !info.dependencies.is_empty() {
749+
let deps_str = format_dependency_list(&info.dependencies, 6, MAX_VALUE_CHARS);
752750
lines.push(format!("{}: {deps_str}", "deps".dimmed().bold()));
753751
}
754752
lines
@@ -785,42 +783,6 @@ fn truncate_end(s: &str, max_chars: usize) -> String {
785783
out
786784
}
787785

788-
fn split_repo_dependency(deps: &[String]) -> (Option<String>, Vec<String>) {
789-
// Legacy markers stored the remote repo identity as a `repo@rev` dependency.
790-
// Prefer URL-like values to avoid accidentally treating PEP508 deps as repo identifiers.
791-
let mut repo_dep: Option<String> = None;
792-
let mut rest = Vec::new();
793-
794-
for dep in deps {
795-
if repo_dep.is_none()
796-
&& dep.contains('@')
797-
&& (dep.contains("://")
798-
|| dep.starts_with('/')
799-
|| dep.starts_with("..")
800-
|| dep.starts_with('.'))
801-
{
802-
repo_dep = Some(dep.clone());
803-
} else {
804-
rest.push(dep.clone());
805-
}
806-
}
807-
808-
rest.sort_unstable();
809-
(repo_dep, rest)
810-
}
811-
812-
fn marker_repo_and_dependencies(info: &InstallInfo) -> (Option<String>, Cow<'_, [String]>) {
813-
if info.schema_version() == 0 {
814-
let (repo, dependencies) = split_repo_dependency(&info.dependencies);
815-
(repo, Cow::Owned(dependencies))
816-
} else {
817-
(
818-
info.repo().map(|repo| repo.to_string()),
819-
Cow::Borrowed(&info.dependencies),
820-
)
821-
}
822-
}
823-
824786
fn format_dependency_list(deps: &[String], max_items: usize, max_chars: usize) -> String {
825787
if deps.is_empty() {
826788
return String::new();
@@ -858,58 +820,6 @@ mod tests {
858820
assert_eq!(truncate_end("ééé", 2), "é…");
859821
}
860822

861-
#[test]
862-
fn split_repo_dependency_prefers_url_like_repo_at_rev() {
863-
let deps = vec![
864-
"requests==2.32.0".to_string(),
865-
"black==24.1.0".to_string(),
866-
"https://github.com/pre-commit/[email protected]".to_string(),
867-
];
868-
869-
let (repo_dep, rest) = split_repo_dependency(&deps);
870-
871-
assert_eq!(
872-
repo_dep.as_deref(),
873-
Some("https://github.com/pre-commit/[email protected]")
874-
);
875-
assert_eq!(rest, vec!["black==24.1.0", "requests==2.32.0"]);
876-
}
877-
878-
#[test]
879-
fn split_repo_dependency_returns_none_when_no_repo_like_dep() {
880-
let deps = vec!["requests==2.32.0".to_string(), "black==24.1.0".to_string()];
881-
882-
let (repo_dep, rest) = split_repo_dependency(&deps);
883-
assert!(repo_dep.is_none());
884-
assert_eq!(rest, vec!["black==24.1.0", "requests==2.32.0"]);
885-
}
886-
887-
#[test]
888-
fn marker_repo_and_dependencies_uses_structured_repo() {
889-
let info: InstallInfo = serde_json::from_value(serde_json::json!({
890-
"schema_version": 1,
891-
"language": "python",
892-
"language_version": "3.12.0",
893-
"repo": {
894-
"url": "https://example.com/repo",
895-
"rev": "v1.0.0",
896-
},
897-
"dependencies": ["https://example.com/[email protected]"],
898-
"env_path": "/tmp/hook-env",
899-
"toolchain": "/usr/bin/python3",
900-
"extra": {},
901-
}))
902-
.expect("deserialize install info");
903-
904-
let (repo, dependencies) = marker_repo_and_dependencies(&info);
905-
906-
assert_eq!(repo.as_deref(), Some("https://example.com/[email protected]"));
907-
assert_eq!(
908-
dependencies.as_ref(),
909-
&["https://example.com/[email protected]".to_string()]
910-
);
911-
}
912-
913823
#[test]
914824
fn format_dependency_list_includes_more_suffix() {
915825
let deps = vec!["a".to_string(), "b".to_string(), "c".to_string()];

‎crates/prek/src/hook.rs‎

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -688,7 +688,6 @@ impl InstalledHook {
688688

689689
#[derive(Debug, Deserialize, Serialize)]
690690
pub(crate) struct InstallInfo {
691-
#[serde(default)]
692691
schema_version: u8,
693692
pub(crate) language: Language,
694693
pub(crate) language_version: semver::Version,
@@ -762,10 +761,6 @@ impl InstallInfo {
762761
self.schema_version == INSTALL_INFO_SCHEMA_VERSION
763762
}
764763

765-
pub(crate) fn schema_version(&self) -> u8 {
766-
self.schema_version
767-
}
768-
769764
pub(crate) fn repo(&self) -> Option<RepoIdentityRef<'_>> {
770765
self.repo.as_ref().map(RepoIdentity::as_ref)
771766
}
@@ -1253,7 +1248,7 @@ mod tests {
12531248
let hooks_dir = temp.path().join("hooks");
12541249
fs_err::create_dir(&hooks_dir)?;
12551250
let install_info = InstallInfo::new(&hook, &hooks_dir)?;
1256-
assert_eq!(install_info.schema_version(), INSTALL_INFO_SCHEMA_VERSION);
1251+
assert!(install_info.is_current_schema());
12571252
assert_eq!(install_info.repo(), Some(repo_identity));
12581253
assert_eq!(install_info.dependencies, additional_dependencies);
12591254
assert!(requirement.is_satisfied_by(&install_info));
@@ -1271,27 +1266,18 @@ mod tests {
12711266
}
12721267

12731268
#[test]
1274-
fn legacy_install_info_does_not_satisfy_current_requirement() -> Result<()> {
1275-
let install_info: InstallInfo = serde_json::from_value(json!({
1269+
fn install_info_requires_schema_version() {
1270+
let err = serde_json::from_value::<InstallInfo>(json!({
12761271
"language": "python",
12771272
"language_version": "3.12.0",
12781273
"dependencies": ["dep"],
12791274
"env_path": "/tmp/legacy-env",
12801275
"toolchain": "/usr/bin/python3",
12811276
"extra": {},
1282-
}))?;
1283-
let dependencies = vec!["dep".to_string()];
1284-
let language_request = LanguageRequest::parse(Language::Python, "")?;
1285-
let requirement = HookEnvRequirementRef {
1286-
language: Language::Python,
1287-
repo: None,
1288-
dependencies: &dependencies,
1289-
language_request: &language_request,
1290-
};
1277+
}))
1278+
.unwrap_err();
12911279

1292-
assert_eq!(install_info.schema_version(), 0);
1293-
assert!(!requirement.is_satisfied_by(&install_info));
1294-
Ok(())
1280+
assert_eq!(err.to_string(), "missing field `schema_version`");
12951281
}
12961282

12971283
#[test]

‎crates/prek/tests/cache.rs‎

Lines changed: 5 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,14 @@ fn cache_gc_verbose_shows_removed_entries() {
4949
home.child("hooks/hook-env-dead/.prek-hook.json")
5050
.write_str(
5151
&serde_json::to_string_pretty(&json!({
52+
"schema_version": 1,
5253
"language": "python",
5354
"language_version": "3.12.0",
55+
"repo": {
56+
"url": "https://example.com/repo",
57+
"rev": "v1.0.0",
58+
},
5459
"dependencies": [
55-
"https://example.com/[email protected]",
5660
"dep1",
5761
"dep2",
5862
"dep3",
@@ -102,63 +106,6 @@ fn cache_gc_verbose_shows_removed_entries() {
102106
");
103107
}
104108

105-
#[test]
106-
fn cache_gc_removes_legacy_hook_env_when_config_matches() -> anyhow::Result<()> {
107-
let context = TestEnv::new_without_git().with_config(indoc::indoc! {r#"
108-
repos:
109-
- repo: local
110-
hooks:
111-
- id: local-python
112-
name: Local Python Hook
113-
entry: "python -c \"print(1)\""
114-
language: python
115-
"#});
116-
117-
let home = context.home_dir();
118-
let config_path = context.work_dir().child(PRE_COMMIT_CONFIG_YAML);
119-
write_config_tracking_file(home, &[config_path.path()])?;
120-
let legacy_env = home.child("hooks/python-legacy");
121-
let current_env = home.child("hooks/python-current");
122-
legacy_env.create_dir_all()?;
123-
current_env.create_dir_all()?;
124-
125-
legacy_env
126-
.child(".prek-hook.json")
127-
.write_str(&serde_json::to_string_pretty(&json!({
128-
"language": "python",
129-
"language_version": "3.12.0",
130-
"dependencies": [],
131-
"env_path": legacy_env.path(),
132-
"toolchain": "/usr/bin/python3",
133-
"extra": {},
134-
}))?)?;
135-
current_env
136-
.child(".prek-hook.json")
137-
.write_str(&serde_json::to_string_pretty(&json!({
138-
"schema_version": 1,
139-
"language": "python",
140-
"language_version": "3.12.0",
141-
"dependencies": [],
142-
"env_path": current_env.path(),
143-
"toolchain": "/usr/bin/python3",
144-
"extra": {},
145-
}))?)?;
146-
147-
cmd_snapshot!(context, context.command().args(["cache", "gc"]), @r"
148-
success: true
149-
exit_code: 0
150-
----- stdout -----
151-
Removed 1 hook env ([SIZE])
152-
153-
----- stderr -----
154-
");
155-
156-
legacy_env.assert(predicates::path::missing());
157-
current_env.assert(predicates::path::is_dir());
158-
159-
Ok(())
160-
}
161-
162109
#[test]
163110
fn cache_clean() -> anyhow::Result<()> {
164111
let context = TestEnv::new_without_git().with_filter(

0 commit comments

Comments
 (0)