use std::fs;
use std::io::BufReader;
use std::io::BufWriter;
use std::io::Write;
use std::path::Path;
use std::path::PathBuf;
use std::time::Instant;
use monochange_core::MonochangeError;
use monochange_core::MonochangeResult;
use monochange_core::WorkspaceConfiguration;
use monochange_core::git::git_command_output;
use monochange_core::git::git_error_detail;
use monochange_core::git::git_head_commit;
use serde::Deserialize;
use serde::Serialize;
use serde::ser::SerializeSeq;
use similar::TextDiff;
use crate::PreparedFileDiff;
use crate::PreparedRelease;
use crate::PreparedReleaseExecution;
use crate::StepPhaseTiming;
use crate::resolve_config_path;
use crate::root_relative;
const PREPARED_RELEASE_ARTIFACT_SCHEMA_VERSION: u32 = 1;
const DEFAULT_PREPARED_RELEASE_CACHE_PATH: &str = ".monochange/local/prepared-release-cache.json";
const CONFIGURATION_SNAPSHOT_ERROR: &str =
"failed to serialize workspace configuration for prepared release caching";
#[derive(Debug, Clone, Eq, PartialEq)]
pub(crate) struct LoadedPreparedReleaseExecution {
pub(crate) execution: PreparedReleaseExecution,
pub(crate) message: String,
}
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
struct PreparedReleaseArtifact {
schema_version: u32,
configuration_snapshot: String,
head_commit: String,
worktree_status: Vec<String>,
tracked_paths: Vec<PreparedReleaseTrackedPath>,
prepared_release: PreparedRelease,
#[serde(default)]
file_diffs: Vec<PersistedPreparedFileDiff>,
}
#[derive(Serialize)]
#[serde(rename_all = "snake_case")]
struct PreparedReleaseArtifactRef<'a> {
schema_version: u32,
configuration_snapshot: String,
head_commit: String,
worktree_status: Vec<String>,
tracked_paths: Vec<PreparedReleaseTrackedPath>,
prepared_release: &'a PreparedRelease,
file_diffs: PreparedFileDiffsRef<'a>,
}
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
struct PreparedReleaseTrackedPath {
path: PathBuf,
state: PreparedReleaseTrackedPathState,
hash: Option<String>,
}
#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
enum PreparedReleaseTrackedPathState {
File,
Deleted,
}
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
struct PersistedPreparedFileDiff {
path: PathBuf,
diff: String,
display_diff: String,
}
struct PreparedFileDiffsRef<'a>(&'a [PreparedFileDiff]);
impl Serialize for PreparedFileDiffsRef<'_> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let mut sequence = serializer.serialize_seq(Some(self.0.len()))?;
for file_diff in self.0 {
sequence.serialize_element(&PreparedFileDiffRef {
path: file_diff.path.as_path(),
diff: file_diff.diff.as_str(),
display_diff: file_diff.display_diff.as_str(),
})?;
}
sequence.end()
}
}
#[derive(Serialize)]
#[serde(rename_all = "snake_case")]
struct PreparedFileDiffRef<'a> {
path: &'a Path,
diff: &'a str,
display_diff: &'a str,
}
pub(crate) fn default_prepared_release_cache_path(root: &Path) -> PathBuf {
root.join(DEFAULT_PREPARED_RELEASE_CACHE_PATH)
}
pub(crate) fn resolve_prepared_release_artifact_path(
root: &Path,
explicit_path: Option<&Path>,
) -> PathBuf {
explicit_path.map_or_else(
|| default_prepared_release_cache_path(root),
|path| resolve_config_path(root, path),
)
}
pub(crate) async fn load_prepared_release_execution(
root: &Path,
configuration: &WorkspaceConfiguration,
explicit_path: Option<&Path>,
current_dry_run: bool,
build_file_diffs: bool,
) -> MonochangeResult<Option<LoadedPreparedReleaseExecution>> {
let artifact_path = resolve_prepared_release_artifact_path(root, explicit_path);
if !artifact_path.exists() {
return Ok(None);
}
let artifact = read_prepared_release_artifact(&artifact_path)?;
validate_prepared_release_artifact(
root,
configuration,
&artifact_path,
&artifact,
current_dry_run,
build_file_diffs,
)
.await?;
let load_started_at = Instant::now();
let file_diffs = artifact
.file_diffs
.into_iter()
.map(|file_diff| {
PreparedFileDiff {
path: file_diff.path,
diff: file_diff.diff,
display_diff: file_diff.display_diff,
}
})
.collect();
let execution = PreparedReleaseExecution {
prepared_release: artifact.prepared_release,
file_diffs,
phase_timings: vec![StepPhaseTiming {
label: "load prepared release artifact".to_string(),
duration: load_started_at.elapsed(),
}],
};
let message = format!(
"reused prepared release artifact `{}`",
root_relative(root, &artifact_path).display()
);
Ok(Some(LoadedPreparedReleaseExecution { execution, message }))
}
pub(crate) async fn maybe_load_prepared_release_execution(
root: &Path,
configuration: &WorkspaceConfiguration,
explicit_path: Option<&Path>,
current_dry_run: bool,
build_file_diffs: bool,
) -> MonochangeResult<Option<LoadedPreparedReleaseExecution>> {
match load_prepared_release_execution(
root,
configuration,
explicit_path,
current_dry_run,
build_file_diffs,
)
.await
{
Ok(Some(loaded)) => Ok(Some(loaded)),
Ok(None) => Ok(None),
Err(error) if explicit_path.is_none() => {
tracing::warn!(%error, "ignoring stale prepared release artifact");
Ok(None)
}
Err(error) => Err(error),
}
}
pub(crate) async fn save_prepared_release_execution(
root: &Path,
configuration: &WorkspaceConfiguration,
prepared_release: &PreparedRelease,
file_diffs: &[PreparedFileDiff],
explicit_path: Option<&Path>,
) -> MonochangeResult<()> {
let artifact_path = resolve_prepared_release_artifact_path(root, explicit_path);
ensure_monochange_artifact_ignored(root, &artifact_path).await?;
if let Some(parent) = artifact_path.parent() {
fs::create_dir_all(parent).map_err(|error| {
MonochangeError::Io(format!(
"failed to create prepared release artifact directory {}: {error}",
parent.display()
))
})?;
}
let artifact = PreparedReleaseArtifactRef {
schema_version: PREPARED_RELEASE_ARTIFACT_SCHEMA_VERSION,
configuration_snapshot: configuration_snapshot(configuration)?,
head_commit: git_head_commit(root).await?,
worktree_status: git_status_snapshot(root, Some(&artifact_path)).await?,
tracked_paths: tracked_path_snapshots(root, prepared_release).await?,
prepared_release,
file_diffs: PreparedFileDiffsRef(file_diffs),
};
let file = fs::File::create(&artifact_path)
.map_err(|error| prepared_release_artifact_io_error(&artifact_path, &error))?;
let mut writer = BufWriter::new(file);
serde_json::to_writer_pretty(&mut writer, &artifact)
.map_err(|error| prepared_release_artifact_write_error(&artifact_path, &error))?;
writer
.flush()
.map_err(|error| prepared_release_artifact_io_error(&artifact_path, &error))
}
fn prepared_release_artifact_io_error(
path: &Path,
error: impl std::fmt::Display,
) -> MonochangeError {
MonochangeError::Io(format!(
"failed to write prepared release artifact {}: {error}",
path.display()
))
}
fn prepared_release_artifact_write_error(
path: &Path,
error: &serde_json::Error,
) -> MonochangeError {
if error.is_io() {
prepared_release_artifact_io_error(path, error)
} else {
MonochangeError::Config(format!(
"failed to serialize prepared release artifact: {error}"
))
}
}
fn read_prepared_release_artifact(path: &Path) -> MonochangeResult<PreparedReleaseArtifact> {
let file = fs::File::open(path).map_err(|error| {
MonochangeError::Io(format!(
"failed to read prepared release artifact {}: {error}",
path.display()
))
})?;
serde_json::from_reader(BufReader::new(file)).map_err(|error| {
MonochangeError::Config(format!(
"failed to parse prepared release artifact {}: {error}",
path.display()
))
})
}
async fn validate_prepared_release_artifact(
root: &Path,
configuration: &WorkspaceConfiguration,
artifact_path: &Path,
artifact: &PreparedReleaseArtifact,
current_dry_run: bool,
build_file_diffs: bool,
) -> MonochangeResult<()> {
if artifact.schema_version != PREPARED_RELEASE_ARTIFACT_SCHEMA_VERSION {
return Err(stale_artifact_error(
artifact_path,
format!(
"schema version {} does not match supported version {}",
artifact.schema_version, PREPARED_RELEASE_ARTIFACT_SCHEMA_VERSION
),
));
}
if !current_dry_run && artifact.prepared_release.dry_run {
return Err(stale_artifact_error(
artifact_path,
"dry-run artifacts cannot drive non-dry-run follow-up commands",
));
}
if configuration_snapshot(configuration)? != artifact.configuration_snapshot {
return Err(stale_artifact_error(
artifact_path,
"workspace configuration changed",
));
}
let current_head = git_head_commit(root).await?;
if current_head != artifact.head_commit {
return Err(stale_artifact_error(
artifact_path,
format!(
"HEAD changed from {} to {}",
artifact.head_commit, current_head
),
));
}
let current_status = git_status_snapshot(root, Some(artifact_path)).await?;
if current_status != artifact.worktree_status {
return Err(stale_artifact_error(
artifact_path,
"workspace status no longer matches the saved prepared release",
));
}
let current_tracked_paths = tracked_path_snapshots(root, &artifact.prepared_release).await?;
if current_tracked_paths != artifact.tracked_paths {
return Err(stale_artifact_error(
artifact_path,
"workspace content drifted from the saved prepared release",
));
}
if build_file_diffs && artifact.file_diffs.is_empty() {
return Err(stale_artifact_error(
artifact_path,
"diff previews were not captured in the saved prepared release",
));
}
Ok(())
}
fn stale_artifact_error(path: &Path, detail: impl AsRef<str>) -> MonochangeError {
MonochangeError::Config(format!(
"prepared release artifact `{}` is stale: {}",
path.display(),
detail.as_ref()
))
}
fn configuration_snapshot(configuration: &WorkspaceConfiguration) -> MonochangeResult<String> {
serde_json::to_string(configuration).map_err(|error| configuration_snapshot_error(&error))
}
fn configuration_snapshot_error(error: &serde_json::Error) -> MonochangeError {
MonochangeError::Config(format!("{CONFIGURATION_SNAPSHOT_ERROR}: {error}"))
}
async fn git_status_snapshot(
root: &Path,
excluded_path: Option<&Path>,
) -> MonochangeResult<Vec<String>> {
let output = git_command_output(
root,
&["status", "--short", "--untracked-files=all", "--porcelain"],
)
.await
.map_err(|error| MonochangeError::Io(format!("failed to read git status: {error}")))?;
if !output.status.success() {
return Err(MonochangeError::Config(format!(
"failed to read git status: {}",
git_error_detail(&output)
)));
}
let excluded = excluded_path.map(|path| root_relative(root, path));
let stdout = String::from_utf8_lossy(&output.stdout);
let mut lines = stdout
.lines()
.filter(|line| {
let Some(excluded) = &excluded else {
return true;
};
status_line_path(line).is_none_or(|path| Path::new(path) != excluded.as_path())
})
.map(str::to_string)
.collect::<Vec<_>>();
lines.sort();
Ok(lines)
}
#[allow(clippy::unused_async)]
fn status_line_path(line: &str) -> Option<&str> {
if line.len() < 4 {
return None;
}
Some(line[3..].trim())
}
#[allow(clippy::unused_async)]
async fn tracked_path_snapshots(
root: &Path,
prepared_release: &PreparedRelease,
) -> MonochangeResult<Vec<PreparedReleaseTrackedPath>> {
let mut tracked_paths = Vec::with_capacity(
prepared_release.changed_files.len() + prepared_release.deleted_changesets.len(),
);
tracked_paths.extend(prepared_release.changed_files.iter());
tracked_paths.extend(prepared_release.deleted_changesets.iter());
tracked_paths.sort();
tracked_paths.dedup();
let mut snapshots = Vec::with_capacity(tracked_paths.len());
let mut file_paths = Vec::with_capacity(tracked_paths.len());
let mut file_snapshot_indices = Vec::with_capacity(tracked_paths.len());
for path in tracked_paths {
let absolute_path = resolve_config_path(root, path);
if absolute_path.exists() {
let relative_path = root_relative(root, &absolute_path);
let relative = relative_path.to_string_lossy().into_owned();
file_paths.push(relative);
file_snapshot_indices.push(snapshots.len());
snapshots.push(PreparedReleaseTrackedPath {
path: path.clone(),
state: PreparedReleaseTrackedPathState::File,
hash: None,
});
} else {
snapshots.push(PreparedReleaseTrackedPath {
path: path.clone(),
state: PreparedReleaseTrackedPathState::Deleted,
hash: None,
});
}
}
let hashes = hash_files_at_paths(root, &file_paths).await?;
for (snapshot_index, hash) in file_snapshot_indices.into_iter().zip(hashes) {
if let Some(snapshot) = snapshots.get_mut(snapshot_index) {
snapshot.hash = Some(hash);
}
}
Ok(snapshots)
}
#[cfg(test)]
fn first_hash_for_path(path: &Path, hashes: Vec<String>) -> MonochangeResult<String> {
hashes.into_iter().next().ok_or_else(|| {
MonochangeError::Config(format!(
"failed to hash {}: git returned no hash",
path.display()
))
})
}
#[cfg(test)]
async fn hash_file_at_path(root: &Path, path: &Path) -> MonochangeResult<String> {
let relative_path = root_relative(root, path);
let relative = relative_path.to_string_lossy().into_owned();
let hashes = hash_files_at_paths(root, &[relative]).await?;
first_hash_for_path(path, hashes)
}
async fn hash_files_at_paths(root: &Path, paths: &[String]) -> MonochangeResult<Vec<String>> {
if paths.is_empty() {
return Ok(Vec::new());
}
let mut args = Vec::with_capacity(paths.len() + 2);
args.push("hash-object");
args.push("--");
args.extend(paths.iter().map(String::as_str));
let output = git_command_output(root, &args)
.await
.map_err(|error| MonochangeError::Io(format!("failed to hash files: {error}")))?;
if !output.status.success() {
return Err(MonochangeError::Config(format!(
"failed to hash files: {}",
git_error_detail(&output)
)));
}
parse_hash_object_output(&output.stdout, paths.len())
}
fn parse_hash_object_output(stdout: &[u8], expected_count: usize) -> MonochangeResult<Vec<String>> {
let hashes = String::from_utf8_lossy(stdout)
.lines()
.map(str::trim)
.filter(|hash| !hash.is_empty())
.map(str::to_string)
.collect::<Vec<_>>();
if hashes.len() != expected_count {
return Err(MonochangeError::Config(format!(
"failed to hash files: expected {expected_count} hashes, got {}",
hashes.len()
)));
}
Ok(hashes)
}
pub(crate) async fn ensure_monochange_artifact_ignored(
root: &Path,
artifact_path: &Path,
) -> MonochangeResult<()> {
let monochange_dir = root.join(".monochange");
if !artifact_path.starts_with(&monochange_dir) {
return Ok(());
}
let output = git_command_output(root, &["rev-parse", "--git-path", "info/exclude"])
.await
.map_err(|error| {
MonochangeError::Io(format!("failed to resolve git exclude path: {error}"))
})?;
if !output.status.success() {
return Ok(());
}
let exclude_path = {
let raw_path = PathBuf::from(String::from_utf8_lossy(&output.stdout).trim());
if raw_path.is_absolute() {
raw_path
} else {
root.join(raw_path)
}
};
if let Some(parent) = exclude_path.parent() {
fs::create_dir_all(parent).map_err(|error| {
MonochangeError::Io(format!(
"failed to create git exclude directory {}: {error}",
parent.display()
))
})?;
}
let existing = fs::read_to_string(&exclude_path).unwrap_or_default();
if existing
.lines()
.any(|line| line.trim() == ".monochange/local/")
{
return Ok(());
}
let mut updated = existing;
if !updated.is_empty() && !updated.ends_with('\n') {
updated.push('\n');
}
updated.push_str(".monochange/local/\n");
fs::write(&exclude_path, updated).map_err(|error| {
MonochangeError::Io(format!(
"failed to update git exclude file {}: {error}",
exclude_path.display()
))
})
}
#[allow(dead_code)]
fn render_unified_file_diff(path: &Path, before: &[u8], after: &[u8]) -> String {
let before_text = String::from_utf8_lossy(before);
let after_text = String::from_utf8_lossy(after);
let context_radius = before_text.lines().count().max(after_text.lines().count());
let diff = TextDiff::from_lines(before_text.as_ref(), after_text.as_ref());
let mut unified = diff.unified_diff();
unified.context_radius(context_radius).header(
&format!("a/{}", path.display()),
&format!("b/{}", path.display()),
);
unified.to_string().trim_end_matches('\n').to_string()
}
#[cfg(test)]
#[path = "__tests__/prepared_release_cache_tests.rs"]
mod tests;