jj_release_core 0.5.2

Core library for jj-release: semantic releases for jj-vcs
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
//! Workspace support for multi-crate projects.

use std::{collections::HashMap, fs, path::Path, process::Command};

use crate::errors::{ReleaseError, Result};
use cargo_metadata::MetadataCommand;
use semver::Version;
use toml_edit::DocumentMut;

use crate::{
    commits::{self, BumpKind},
    config::WorkspaceMember,
    jj::JjBackend,
    manifest::ManifestBackend,
};

pub struct WorkspaceManifest;

impl ManifestBackend for WorkspaceManifest {
    fn read_version(&self, root: &Path) -> Result<Version> {
        let path = root.join("Cargo.toml");
        let raw = fs::read_to_string(&path)
            .map_err(|e| ReleaseError::Message(format!("reading {}: {e}", path.display())))?;
        let doc: DocumentMut = raw
            .parse()
            .map_err(|e| ReleaseError::Message(format!("reading {}: {e}", path.display())))?;
        let version_str = doc
            .get("workspace")
            .and_then(|w| w.get("package"))
            .and_then(|p| p.get("version"))
            .and_then(|v| v.as_str())
            .ok_or_else(|| ReleaseError::Message("missing [workspace.package].version".into()))?;
        Version::parse(version_str)
            .map_err(|e| ReleaseError::Message(format!("invalid semver {version_str:?}: {e}")))
    }

    fn write_version(&self, root: &Path, version: &Version) -> Result<()> {
        let path = root.join("Cargo.toml");

        let raw = fs::read_to_string(&path)
            .map_err(|e| ReleaseError::Message(format!("reading {}: {e}", path.display())))?;

        let mut doc: DocumentMut = raw
            .parse()
            .map_err(|e| ReleaseError::Message(format!("parsing {}: {e}", path.display())))?;

        doc["workspace"]["package"]["version"] = toml_edit::value(version.to_string());
        fs::write(&path, doc.to_string())
            .map_err(|e| ReleaseError::Message(format!("writing {}: {e}", path.display())))?;

        Ok(())
    }
}

/// Orders publishable workspace members topologically based on their dependencies
/// so they can be published in the correct sequence.
///
/// # Errors
///
/// Returns an error if a circular dependency is detected among the workspace members.
pub fn ordered_members(members: &[WorkspaceMember]) -> Result<Vec<&WorkspaceMember>> {
    let publish: Vec<&WorkspaceMember> = members.iter().filter(|m| m.publish).collect();

    let mut ordered: Vec<&WorkspaceMember> = Vec::new();
    let mut remaining: Vec<&WorkspaceMember> = publish.clone();
    let mut iterations = 0;
    let max = remaining.len() * remaining.len() + 1;

    while !remaining.is_empty() {
        iterations += 1;
        if iterations > max {
            return Err(ReleaseError::Message(
                "circular dependency detected in workspace members".to_string(),
            ));
        }

        let mut progress = false;
        remaining.retain(|member| {
            let deps_satisfied = member.depends_on.iter().all(|dep| {
                // We only care if the dep is scheduled to be published
                let is_publishable = publish.iter().any(|m| &m.name == dep);

                if is_publishable {
                    // If it is, it must have already been processed into `ordered`.
                    ordered.iter().any(|m| &m.name == dep)
                } else {
                    // Not scheduled for publish, so it doesn't block this member.
                    true
                }
            });

            if deps_satisfied {
                ordered.push(member);
                progress = true;
                false // Remove from remaining
            } else {
                true // Keep in remaining
            }
        });

        if !progress {
            return Err(ReleaseError::Message(
                "circular dependency detected in workspace members".to_string(),
            ));
        }
    }

    Ok(ordered)
}

/// Read all workspace member versions via `cargo metadata`.
///
/// # Errors
///
/// This function will return an error in the following situations:
/// * Executing the `cargo metadata` command fails (e.g., if Cargo is not installed
///   or the manifest path is invalid).
/// * Parsing the metadata output or any package version fails.
pub fn member_versions(root: &Path) -> Result<HashMap<String, Version>> {
    let metadata = MetadataCommand::new()
        .manifest_path(root.join("Cargo.toml"))
        .exec()?;

    let mut versions = HashMap::new();
    for package in &metadata.packages {
        // Only include workspace members, not external dependencies.
        if metadata.workspace_members.contains(&package.id) {
            let version = Version::parse(&package.version.to_string())?;
            versions.insert(package.name.clone().to_string(), version);
        }
    }
    Ok(versions)
}

/// Update the version of a workspace member using `cargo set-version`.
///
/// # Errors
///
/// This function will return an error in the following situations:
/// * Spawning the `cargo` command fails (e.g., if Cargo or `cargo-edit` is not installed).
/// * The `cargo set-version` command execution fails with a non-zero exit
pub fn bump_member_version(root: &Path, member_name: &str, version: &Version) -> Result<()> {
    let status = Command::new("cargo")
        .args(["set-version", "-p", member_name, &version.to_string()])
        .current_dir(root)
        .status()
        .map_err(|_| {
            ReleaseError::Message(
                "spawning cargo set-version, is cargo-edit installed?".to_string(),
            )
        })?;
    if !status.success() {
        return Err(ReleaseError::Message(format!(
            "cargo set-version failed for {member_name}"
        )));
    }
    Ok(())
}

/// Compute the bump kind for each workspace member based on commits
/// that touched its path since the last tag.
///
/// # Errors
///
/// This function will return an error in the following situations:
/// * Querying commit logs for any workspace member path via the backend fails.
/// * Resolving the version bump fails (e.g., if an invalid `force` override string is provided).
pub fn member_bumps(
    backend: &dyn JjBackend,
    members: &[WorkspaceMember],
    since: &str,
    force: Option<&String>,
    tag_prefix: &str,
) -> Result<HashMap<String, BumpKind>> {
    let mut bumps = HashMap::new();
    for member in members {
        // Use member's tag_prefix if set, otherwise workspace default.
        let prefix = member.tag_prefix.as_deref().unwrap_or(tag_prefix);
        let all_tags = backend.list_tags()?;
        let member_since = all_tags
            .iter()
            .filter_map(|name| {
                let stripped = name.strip_prefix(prefix)?;
                let version = Version::parse(stripped).ok()?;
                Some((name.clone(), version))
            })
            .max_by(|a, b| a.1.cmp(&b.1))
            .map_or_else(|| since.to_owned(), |(name, _)| name);
        let member_commits =
            backend.log_commits_for_path(&format!("{member_since}..@"), &member.path)?;
        let bump = commits::resolve_bump(force, &member_commits)?;
        bumps.insert(member.name.clone(), bump);
    }
    Ok(bumps)
}

/// Get the effective tag name for a member version.
#[must_use]
pub fn member_tag_name(
    member: &WorkspaceMember,
    version: &Version,
    default_prefix: &str,
) -> String {
    let prefix = member.tag_prefix.as_deref().unwrap_or(default_prefix);
    format!("{prefix}{version}")
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::commits::CommitInfo;
    use crate::test_helpers::mock::MockBackend;

    #[test]
    fn ordered_members_lib_before_cli() {
        let members = vec![
            WorkspaceMember {
                name: "mycli".into(),
                path: "cli".into(),
                publish: true,
                depends_on: vec!["mylib".into()],
                tag_prefix: None,
            },
            WorkspaceMember {
                name: "mylib".into(),
                path: "lib".into(),
                publish: true,
                depends_on: vec![],
                tag_prefix: None,
            },
        ];
        let ordered = ordered_members(&members).unwrap();
        assert_eq!(ordered[0].name, "mylib");
        assert_eq!(ordered[1].name, "mycli");
    }

    #[test]
    fn ordered_members_no_deps_preserves_order() {
        let members = vec![
            WorkspaceMember {
                name: "a".into(),
                path: "a".into(),
                publish: true,
                depends_on: vec![],
                tag_prefix: None,
            },
            WorkspaceMember {
                name: "b".into(),
                path: "b".into(),
                publish: true,
                depends_on: vec![],
                tag_prefix: None,
            },
        ];
        let ordered = ordered_members(&members).unwrap();
        assert_eq!(ordered[0].name, "a");
        assert_eq!(ordered[1].name, "b");
    }

    #[test]
    fn ordered_members_skips_unpublished() {
        let members = vec![
            WorkspaceMember {
                name: "internal".into(),
                path: "internal".into(),
                publish: false,
                depends_on: vec![],
                tag_prefix: None,
            },
            WorkspaceMember {
                name: "mylib".into(),
                path: "lib".into(),
                publish: true,
                depends_on: vec![],
                tag_prefix: None,
            },
        ];
        let ordered = ordered_members(&members).unwrap();
        assert_eq!(ordered.len(), 1);
        assert_eq!(ordered[0].name, "mylib");
    }

    #[test]
    fn workspace_manifest_reads_version() {
        let dir = tempfile::tempdir().unwrap();
        fs::write(
            dir.path().join("Cargo.toml"),
            r#"
[workspace.package]
version = "0.5.32"
edition = "2024"
"#,
        )
        .unwrap();
        let manifest = WorkspaceManifest;
        let v = manifest.read_version(dir.path()).unwrap();
        assert_eq!(v, Version::parse("0.5.32").unwrap());
    }

    #[test]
    fn workspace_manifest_writes_version() {
        let dir = tempfile::tempdir().unwrap();
        fs::write(
            dir.path().join("Cargo.toml"),
            r#"
[workspace.package]
version = "0.5.32"
edition = "2024"
"#,
        )
        .unwrap();
        let manifest = WorkspaceManifest;
        manifest
            .write_version(dir.path(), &Version::parse("0.6.0").unwrap())
            .unwrap();
        let updated = fs::read_to_string(dir.path().join("Cargo.toml")).unwrap();
        assert!(updated.contains("\"0.6.0\""));
        assert!(!updated.contains("\"0.5.32\""));
    }

    #[test]
    fn independent_versioning_reads_per_member_versions() {
        let dir = tempfile::tempdir().unwrap();

        // Write workspace Cargo.toml
        fs::write(
            dir.path().join("Cargo.toml"),
            r#"
[workspace]
members = ["lib", "cli"]
resolver = "2"
"#,
        )
        .unwrap();

        // Write lib member
        fs::create_dir(dir.path().join("lib")).unwrap();
        fs::write(
            dir.path().join("lib/Cargo.toml"),
            r#"
[package]
name = "mylib"
version = "0.3.0"
edition = "2024"
"#,
        )
        .unwrap();
        fs::create_dir(dir.path().join("lib/src")).unwrap();
        fs::write(dir.path().join("lib/src/lib.rs"), "").unwrap();

        // Write cli member
        fs::create_dir(dir.path().join("cli")).unwrap();
        fs::write(
            dir.path().join("cli/Cargo.toml"),
            r#"
[package]
name = "mycli"
version = "0.5.0"
edition = "2024"
"#,
        )
        .unwrap();
        fs::create_dir(dir.path().join("cli/src")).unwrap();
        fs::write(dir.path().join("cli/src/main.rs"), "fn main() {}").unwrap();

        let versions = member_versions(dir.path()).unwrap();
        assert_eq!(versions.get("mylib").unwrap().to_string(), "0.3.0");
        assert_eq!(versions.get("mycli").unwrap().to_string(), "0.5.0");
    }

    #[test]
    fn bump_member_version_requires_cargo_edit() {
        // If cargo-edit isn't installed this test documents the requirement.
        let dir = tempfile::tempdir().unwrap();
        fs::write(
            dir.path().join("Cargo.toml"),
            r#"
[workspace]
members = ["lib"]
resolver = "2"
"#,
        )
        .unwrap();
        fs::create_dir(dir.path().join("lib")).unwrap();
        fs::write(
            dir.path().join("lib/Cargo.toml"),
            r#"
[package]
name = "mylib"
version = "0.3.0"
edition = "2024"
"#,
        )
        .unwrap();
        fs::create_dir(dir.path().join("lib/src")).unwrap();
        fs::write(dir.path().join("lib/src/lib.rs"), "").unwrap();

        let new_version = Version::parse("0.4.0").unwrap();
        let result = bump_member_version(dir.path(), "mylib", &new_version);

        if let Err(err) = result {
            // cargo-edit not installed, that's ok, just document it
            let msg = err.to_string();
            assert!(
                msg.contains("cargo set-version") || msg.contains("cargo-edit"),
                "unexpected error: {msg}"
            );
        } else {
            // cargo-edit is installed, verify the version was bumped
            let versions = member_versions(dir.path()).unwrap();
            assert_eq!(versions.get("mylib").unwrap().to_string(), "0.4.0");
        }
    }

    #[test]
    fn member_bumps_computes_per_member() {
        let backend = MockBackend {
            commits: vec![CommitInfo {
                change_id: "abc".into(),
                description: "feat: add thing".into(),
            }],
            ..MockBackend::default()
        };
        let members = vec![WorkspaceMember {
            name: "mylib".into(),
            path: "lib".into(),
            publish: true,
            depends_on: vec![],
            tag_prefix: None,
        }];
        let bumps = member_bumps(&backend, &members, "v0.1.0", None, "v").unwrap();
        assert_eq!(*bumps.get("mylib").unwrap(), BumpKind::Minor);
    }

    #[test]
    fn member_tag_name_uses_member_prefix() {
        let member = WorkspaceMember {
            name: "mylib".into(),
            path: "lib".into(),
            publish: true,
            depends_on: vec![],
            tag_prefix: Some("mylib-v".into()),
        };
        let v = Version::parse("0.5.0").unwrap();
        assert_eq!(member_tag_name(&member, &v, "v"), "mylib-v0.5.0");
    }

    #[test]
    fn member_tag_name_falls_back_to_default_prefix() {
        let member = WorkspaceMember {
            name: "mycli".into(),
            path: "cli".into(),
            publish: true,
            depends_on: vec![],
            tag_prefix: None,
        };
        let v = Version::parse("0.8.0").unwrap();
        assert_eq!(member_tag_name(&member, &v, "v"), "v0.8.0");
    }

    #[test]
    fn ordered_members_ignores_unpublished_dependencies() {
        let members = vec![
            WorkspaceMember {
                name: "mycli".into(),
                path: "cli".into(),
                publish: true,
                depends_on: vec!["internal-core".into()], // Depends on unpublished crate
                tag_prefix: None,
            },
            WorkspaceMember {
                name: "internal-core".into(),
                path: "core".into(),
                publish: false, // NOT published
                depends_on: vec![],
                tag_prefix: None,
            },
        ];

        // This will currently panic with a fake "circular dependency" error
        let ordered = ordered_members(&members).unwrap();

        assert_eq!(ordered.len(), 1);
        assert_eq!(ordered[0].name, "mycli");
    }
}