Files
coa-server-manager/crates/coa-core/src/update.rs
T
CorfireanandClaude Sonnet 5.5 5c21ef106d fix(config): an imported server gets the module config files it lacks at start and after an update
A server without a module's active file (an old repack updated by the Manager) made two modules log a
'missing property' line on every world tick.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 05:39:12 +05:00

780 lines
35 KiB
Rust

//! Update transaction: Prepare -> Verify -> Snapshot -> Apply -> Migrate -> Validate -> Commit.
//!
//! Nothing is changed until the signed package is downloaded, verified and extracted into staging. Every file that is
//! about to change is first copied into the transaction's `before/` folder, each operation is journaled, and a crash or
//! failure at any point leaves the installation recoverable: `rollback` restores binaries and configuration exactly.
//! Databases are never rolled back automatically (players may have progressed); restoring one is a separate action.
use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::config::{merge, parser::ConfFile};
use crate::download::Cancel;
use crate::error::{Error, Result};
use crate::fsx;
use crate::manifest::{FileEntry, Kind, Manifest, ReplacePolicy};
use crate::migrations::ApplyReport;
use crate::package;
use crate::pkgsource::{fetch_manifest, fetch_parts, Source};
use crate::registry::{InstallMeta, MetaDir};
const STAGED_PREFIX: &str = "_migrations/";
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum State {
Prepared,
Applying,
/// Files replaced; waiting for migrations / health check.
Applied,
/// Files replaced but the new build did not become healthy; the owner decides (rollback is offered).
NeedsDecision,
Committed,
RolledBack,
Failed,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum Action {
Create,
Replace,
MergeConfig,
Skip,
Conflict,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Op {
pub path: String,
pub action: Action,
pub reason: Option<String>,
/// sha256 the file will have after the operation.
pub new_sha256: String,
pub had_previous: bool,
pub started: bool,
pub done: bool,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum Resolution {
Keep,
Replace,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Txn {
pub id: String,
pub state: State,
pub from_version: Option<String>,
pub to_version: String,
pub recovery_point: Option<String>,
pub ops: Vec<Op>,
pub message: Option<String>,
}
/// Everything the transaction needs from the outside world; tests provide a fake.
pub trait Env {
fn ensure_stopped(&self) -> Result<()>;
/// Create a recovery point for the databases and configuration; returns its id.
fn snapshot(&self) -> Result<String>;
fn migrate(&self, manifest: &Manifest, staged_migrations: &Path) -> Result<ApplyReport>;
/// Start the server and confirm it becomes healthy.
fn validate(&self) -> Result<()>;
}
fn updates_dir(meta: &Path) -> PathBuf {
meta.join("updates")
}
fn txn_dir(meta: &Path, id: &str) -> Result<PathBuf> {
if id.is_empty() || !id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_')) {
return Err(Error::PathRejected(format!("bad update id {id:?}")));
}
Ok(updates_dir(meta).join(id))
}
fn save(meta: &Path, t: &Txn) -> Result<()> {
fsx::atomic_write_json(&txn_dir(meta, &t.id)?.join("txn.json"), t)
}
pub fn load(meta: &Path, id: &str) -> Result<Txn> {
fsx::read_json(&txn_dir(meta, id)?.join("txn.json"))
}
/// A transaction that started but never reached a final state (crash, power loss). The UI offers rollback.
pub fn unfinished(meta: &Path) -> Option<Txn> {
let rd = fs::read_dir(updates_dir(meta)).ok()?;
let mut all: Vec<Txn> = rd.flatten().filter_map(|e| fsx::read_json::<Txn>(&e.path().join("txn.json")).ok()).collect();
all.sort_by(|a, b| b.id.cmp(&a.id));
all.into_iter().find(|t| !matches!(t.state, State::Committed | State::RolledBack | State::Failed | State::Prepared))
}
fn sha_if_exists(p: &Path) -> Option<String> {
p.is_file().then(|| fsx::sha256_file(p).ok()).flatten()
}
#[derive(Debug, Serialize)]
pub struct PlanItem {
pub path: String,
pub action: Action,
pub reason: Option<String>,
}
/// What an update would do to this installation. Read-only.
pub fn plan(root: &Path, meta: &InstallMeta, manifest: &Manifest, resolutions: &BTreeMap<String, Resolution>, staged: Option<&Path>) -> Result<Vec<PlanItem>> {
let mut out = Vec::new();
for f in manifest.files.iter().filter(|f| !f.path.starts_with(STAGED_PREFIX)) {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &f.path)?)?;
let cur = sha_if_exists(&target);
let recorded = meta.original_hashes.get(&f.path);
let (action, reason) = match (f.policy, &cur) {
(ReplacePolicy::NeverTouch, _) => (Action::Skip, Some("managed by you".to_string())),
(_, None) => (Action::Create, None),
(ReplacePolicy::CreateIfMissing, Some(_)) => (Action::Skip, Some("kept your existing file".into())),
(ReplacePolicy::MergeConfig, Some(_)) => {
let would_add = match staged {
Some(tree) => {
let (a, b) = (fs::read(&target)?, fs::read(fsx::safe_join(tree, &f.path)?)?);
!merge::plan(&ConfFile::parse_bytes(&a)?, &ConfFile::parse_bytes(&b)?).added.is_empty()
}
None => true,
};
if would_add { (Action::MergeConfig, Some("new settings are added; your values are kept".into())) } else { (Action::Skip, Some("no new settings".into())) }
}
(_, Some(c)) if c.eq_ignore_ascii_case(&f.sha256) => (Action::Skip, Some("already up to date".into())),
(ReplacePolicy::Replace | ReplacePolicy::ReplaceIfPristine, Some(c)) => {
if recorded.map(|r| r.eq_ignore_ascii_case(c)).unwrap_or(false) {
(Action::Replace, None)
} else if f.policy == ReplacePolicy::ReplaceIfPristine {
(Action::Skip, Some("modified outside CoA Server Manager; kept".into()))
} else {
match resolutions.get(&f.path) {
Some(Resolution::Replace) => (Action::Replace, Some("you chose to replace your modified file".into())),
Some(Resolution::Keep) => (Action::Skip, Some("you chose to keep your modified file".into())),
None => (Action::Conflict, Some("modified outside CoA Server Manager".into())),
}
}
}
};
out.push(PlanItem { path: f.path.clone(), action, reason });
}
Ok(out)
}
#[derive(Debug, Serialize)]
pub struct Preview {
pub from_version: Option<String>,
pub to_version: String,
pub items: Vec<PlanItem>,
pub conflicts: Vec<String>,
pub migrations: usize,
pub download_bytes: u64,
}
/// Check the signed manifest and describe the update without downloading the payload.
pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>) -> Result<Preview> {
let (m, _) = fetch_manifest(source, trusted_key)?;
check_manifest(&m)?;
let items = plan(root, meta, &m, resolutions, None)?;
Ok(Preview {
from_version: meta.core.version.clone(),
to_version: m.version.clone(),
conflicts: items.iter().filter(|i| i.action == Action::Conflict).map(|i| i.path.clone()).collect(),
items,
migrations: m.migrations.len(),
download_bytes: m.archive.as_ref().map(|a| a.parts.iter().map(|p| p.size).sum()).unwrap_or(0),
})
}
fn check_manifest(m: &Manifest) -> Result<()> {
if m.kind != Kind::Update {
return Err(Error::Invalid("This is not an update package.".into()));
}
if !m.compatible_with_manager(crate::MANAGER_VERSION) {
return Err(Error::Invalid("This update needs a newer version of CoA Server Manager.".into()));
}
Ok(())
}
pub struct Params<'a> {
pub root: &'a Path,
pub meta_dir: &'a Path,
pub source: Source,
pub trusted_key: &'a str,
pub cancel: Cancel,
pub resolutions: BTreeMap<String, Resolution>,
pub env: &'a dyn Env,
/// Test hook: fail after this many completed file operations.
pub fail_after_ops: Option<usize>,
}
#[derive(Debug, Serialize)]
pub struct Outcome {
pub txn: Txn,
pub migrations: Option<ApplyReport>,
}
fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
report(name, pct);
}
/// Run the whole update. On failure before the new build is validated the files are rolled back automatically;
/// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses.
pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
let (root, meta_dir) = (p.root, p.meta_dir);
let (md, mut meta) = MetaDir::open(meta_dir)?;
let _ = md;
step(report, "Checking the update", 2);
let (m, _) = fetch_manifest(&p.source, p.trusted_key)?;
check_manifest(&m)?;
let archive = m.archive.clone().ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), m.version.replace('.', "_"));
let tdir = txn_dir(meta_dir, &id)?;
let (tree, before) = (tdir.join("tree"), tdir.join("before"));
fs::create_dir_all(&before)?;
let mut txn = Txn { id: id.clone(), state: State::Prepared, from_version: meta.core.version.clone(), to_version: m.version.clone(), recovery_point: None, ops: Vec::new(), message: None };
save(meta_dir, &txn)?;
// Nothing has touched the installation yet; failures up to here just discard the staging area.
let staged = (|| -> Result<PathBuf> {
step(report, "Downloading the update", 5);
let parts = fetch_parts(&p.source, &m, &meta_dir.join("staging").join("download"), &p.cancel, &|f, _| step(report, "Downloading the update", 5 + (f * 35.0) as u8))?;
step(report, "Verifying the update", 42);
package::extract(&parts, &m, &tree, &|_, _| {})?;
Ok(tree.clone())
})();
let tree = match staged {
Ok(t) => t,
Err(e) => {
txn.state = State::Failed;
txn.message = Some(e.to_string());
let _ = save(meta_dir, &txn);
let _ = fs::remove_dir_all(&tree);
return Err(e);
}
};
let items = plan(root, &meta, &m, &p.resolutions, Some(&tree))?;
if let Some(c) = items.iter().find(|i| i.action == Action::Conflict) {
txn.state = State::Failed;
txn.message = Some(format!("{} needs a decision", c.path));
save(meta_dir, &txn)?;
let _ = fs::remove_dir_all(&tree);
return Err(Error::Invalid(format!("Some files were modified outside CoA Server Manager and need your decision (for example {}).", c.path)));
}
let need: u64 = m.files.iter().filter(|f| items.iter().any(|i| i.path == f.path && matches!(i.action, Action::Replace | Action::Create | Action::MergeConfig))).map(|f| f.size).sum();
fsx::require_space(root, need)?;
fsx::require_space(meta_dir, need)?;
step(report, "Making sure the server is stopped", 48);
p.env.ensure_stopped()?;
step(report, "Saving a recovery point", 52);
txn.recovery_point = Some(p.env.snapshot().map_err(|e| Error::Invalid(format!("The update was not applied because the safety backup failed: {e}")))?);
txn.ops = items
.iter()
.filter(|i| i.action != Action::Skip)
.map(|i| {
let f = m.files.iter().find(|f| f.path == i.path).expect("planned from manifest");
Op { path: i.path.clone(), action: i.action, reason: i.reason.clone(), new_sha256: f.sha256.clone(), had_previous: fsx::safe_join(root, &i.path).map(|t| t.is_file()).unwrap_or(false), started: false, done: false }
})
.collect();
txn.state = State::Applying;
save(meta_dir, &txn)?;
step(report, "Applying the update", 58);
let applied = apply_ops(root, &tree, &before, &m.files, &mut txn, meta_dir, p.fail_after_ops);
if let Err(e) = applied {
step(report, "Undoing the update", 70);
let restore = restore_files(root, &before, &mut txn);
txn.state = if restore.is_ok() { State::RolledBack } else { State::Failed };
txn.message = Some(e.to_string());
save(meta_dir, &txn)?;
let _ = fs::remove_dir_all(&tree);
return Err(e);
}
txn.state = State::Applied;
save(meta_dir, &txn)?;
// Database migrations: a failure here undoes the file changes; the databases are left as they are.
let mut migrated = None;
if !m.migrations.is_empty() {
step(report, "Updating the database", 75);
match p.env.migrate(&m, &tree.join("_migrations")) {
Ok(r) if r.failed.is_none() => migrated = Some(r),
Ok(r) => {
let (mid, why) = r.failed.clone().unwrap();
return fail_after_apply(p, &mut txn, &before, &tree, format!("Database update {mid} failed: {why}"), Some(r));
}
Err(e) => return fail_after_apply(p, &mut txn, &before, &tree, e.to_string(), None),
}
}
step(report, "Starting the updated server", 85);
if let Err(e) = p.env.validate() {
txn.state = State::NeedsDecision;
txn.message = Some(format!("The updated server did not start correctly: {e}"));
save(meta_dir, &txn)?;
return Ok(Outcome { txn, migrations: migrated });
}
// Commit
step(report, "Finishing", 96);
meta.core.version = Some(m.version.clone());
meta.core.commit = m.core.commit.clone().or(meta.core.commit);
for op in &txn.ops {
meta.original_hashes.insert(op.path.clone(), op.new_sha256.clone());
if !meta.managed_files.contains(&op.path) {
meta.managed_files.push(op.path.clone());
}
}
for i in items.iter().filter(|i| i.action == Action::Skip && i.reason.as_deref() == Some("already up to date")) {
if let Some(f) = m.files.iter().find(|f| f.path == i.path) {
meta.original_hashes.insert(f.path.clone(), f.sha256.clone());
}
}
fsx::atomic_write_json(&meta_dir.join("install.json"), &meta)?;
fsx::atomic_write(&meta_dir.join("manifests").join(format!("update-{}.json", m.version)), &serde_json::to_vec_pretty(&m)?)?;
txn.state = State::Committed;
save(meta_dir, &txn)?;
let _ = fs::remove_dir_all(&tree);
prune(meta_dir, 3);
step(report, "Done", 100);
let _ = archive;
Ok(Outcome { txn, migrations: migrated })
}
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
let restored = restore_files(p.root, before, txn);
txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed };
txn.message = Some(why.clone());
save(p.meta_dir, txn)?;
let _ = fs::remove_dir_all(tree);
let _ = report;
Err(Error::Invalid(format!("{why} Your files were restored and your databases were not touched by the restore.")))
}
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
let mut completed = 0usize;
for i in 0..txn.ops.len() {
if fail_after == Some(completed) {
return Err(Error::Invalid("simulated failure".into()));
}
let (path, action) = (txn.ops[i].path.clone(), txn.ops[i].action);
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
let staged = fsx::safe_join(tree, &path)?;
let entry = files.iter().find(|f| f.path == path).expect("listed");
txn.ops[i].started = true;
save(meta_dir, txn)?;
if target.is_file() {
let keep = fsx::safe_join(before, &path)?;
fs::create_dir_all(keep.parent().unwrap())?;
fs::copy(&target, &keep)?;
}
fs::create_dir_all(target.parent().unwrap())?;
match action {
Action::Create | Action::Replace => {
// Same-volume temp file + rename: the target is either the old or the new file, never half of one.
let tmp = target.with_file_name(format!("{}.coa-new", target.file_name().unwrap().to_string_lossy()));
fs::copy(&staged, &tmp)?;
if let Err(e) = fs::rename(&tmp, &target) {
let _ = fs::remove_file(&tmp);
return Err(e.into());
}
if !fsx::sha256_file(&target)?.eq_ignore_ascii_case(&entry.sha256) {
return Err(Error::HashMismatch { path, expected: entry.sha256.clone(), actual: "different after writing".into() });
}
}
Action::MergeConfig => {
let mut conf = ConfFile::parse_bytes(&fs::read(&target)?)?;
let incoming = ConfFile::parse_bytes(&fs::read(&staged)?)?;
merge::apply(&mut conf, &incoming);
fsx::atomic_write(&target, conf.to_text().as_bytes())?;
txn.ops[i].new_sha256 = fsx::sha256_file(&target)?;
}
Action::Skip | Action::Conflict => {}
}
txn.ops[i].done = true;
save(meta_dir, txn)?;
completed += 1;
}
Ok(())
}
/// Put every touched file back the way it was. Files created by the update (no previous version) are removed only if
/// they still hold exactly what the update wrote.
fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> {
for op in txn.ops.iter().rev().filter(|o| o.started) {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &op.path)?)?;
let _ = fs::remove_file(target.with_file_name(format!("{}.coa-new", target.file_name().unwrap().to_string_lossy())));
if op.had_previous {
let saved = fsx::safe_join(before, &op.path)?;
if !saved.is_file() {
return Err(Error::Invalid(format!("the saved copy of {} is missing", op.path)));
}
fsx::atomic_write(&target, &fs::read(saved)?)?;
} else if sha_if_exists(&target).map(|h| h.eq_ignore_ascii_case(&op.new_sha256)).unwrap_or(false) {
fs::remove_file(&target)?;
}
}
Ok(())
}
/// Roll a transaction back (binaries and configuration only; databases are never touched).
pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> {
let mut txn = load(meta_dir, id)?;
if matches!(txn.state, State::Committed | State::RolledBack) {
return Err(Error::Invalid("This update cannot be rolled back.".into()));
}
env.ensure_stopped()?;
restore_files(root, &txn_dir(meta_dir, id)?.join("before"), &mut txn)?;
txn.state = State::RolledBack;
txn.message = Some("rolled back".into());
save(meta_dir, &txn)?;
let _ = fs::remove_dir_all(txn_dir(meta_dir, id)?.join("tree"));
Ok(txn)
}
fn prune(meta_dir: &Path, keep: usize) {
let Ok(rd) = fs::read_dir(updates_dir(meta_dir)) else { return };
let mut dirs: Vec<_> = rd.flatten().filter(|e| e.path().join("txn.json").is_file()).map(|e| e.path()).collect();
dirs.sort();
while dirs.len() > keep {
let _ = fs::remove_dir_all(dirs.remove(0));
}
}
/// The real environment: a repack-shaped installation driven through its launcher.
pub struct RepackEnv<'a> {
pub root: &'a Path,
pub meta_dir: &'a Path,
}
impl Env for RepackEnv<'_> {
fn ensure_stopped(&self) -> Result<()> {
use crate::process::{observe, ServiceState};
let o = observe(self.root, &crate::layout::read_ports(self.root));
if o.world.state != ServiceState::Stopped || o.auth.state != ServiceState::Stopped {
return Err(Error::Invalid("Stop the server before updating it; files cannot be replaced while it is running.".into()));
}
Ok(())
}
fn snapshot(&self) -> Result<String> {
let label = Some("before update".to_string());
Ok(crate::backup::create(self.root, self.meta_dir, crate::backup::Kind::Quick, crate::backup::Trigger::BeforeUpdate, label, &|_| {})?.id)
}
fn migrate(&self, manifest: &Manifest, staged: &Path) -> Result<ApplyReport> {
let (root, meta) = (self.root, self.meta_dir);
crate::backup::with_database(root, |db| {
crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
Ok(crate::backup::create(root, meta, crate::backup::Kind::Database, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id)
})
})
}
fn validate(&self) -> Result<()> {
use crate::process::{observe, ServiceState};
// The check start is the first start of the new build: give the module configs the settings the update added
// (as a normal start does), or the server logs a "missing property" line for every one of them.
match crate::registry::MetaDir::open(self.meta_dir) {
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
let _ = crate::config::materialize_module_configs(self.root);
}
// An imported server gets the files it lacks (nothing it has is changed).
_ => {
let _ = crate::config::create_missing_module_configs(self.root);
}
}
let started = crate::driver::run(self.root, crate::driver::Verb::StartAll)?;
let ports = crate::layout::read_ports(self.root);
let healthy = started.ok && {
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
loop {
let o = observe(self.root, &ports);
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running {
break true;
}
if std::time::Instant::now() > deadline {
break false;
}
std::thread::sleep(std::time::Duration::from_secs(2));
}
};
if healthy {
return Ok(());
}
let cause = started.human.map(|h| h.title.to_string()).or_else(|| crate::health::diagnose_installation(self.root).map(|c| c.human().title.to_string())).unwrap_or_else(|| "the server did not become ready".into());
// Leave the files unlocked so that a rollback can replace them.
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
Err(Error::Invalid(cause))
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::package::{build, BuildOptions};
use crate::registry::{InstallKind, InstallMeta};
use base64::Engine;
use ed25519_dalek::{Signer, SigningKey};
use std::cell::{Cell, RefCell};
struct Fake {
stopped: Cell<bool>,
healthy: Cell<bool>,
snapshot_ok: Cell<bool>,
calls: RefCell<Vec<&'static str>>,
migrate_fail: Cell<bool>,
}
impl Fake {
fn ok() -> Fake {
Fake { stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false) }
}
}
impl Env for Fake {
fn ensure_stopped(&self) -> Result<()> {
self.calls.borrow_mut().push("stop");
if self.stopped.get() { Ok(()) } else { Err(Error::Invalid("The server is running.".into())) }
}
fn snapshot(&self) -> Result<String> {
self.calls.borrow_mut().push("snapshot");
if self.snapshot_ok.get() { Ok("rp-1".into()) } else { Err(Error::Invalid("disk full".into())) }
}
fn migrate(&self, _m: &Manifest, _d: &Path) -> Result<ApplyReport> {
self.calls.borrow_mut().push("migrate");
Ok(ApplyReport { applied: vec![], failed: self.migrate_fail.get().then(|| ("m1".to_string(), "syntax".to_string())), snapshot: None })
}
fn validate(&self) -> Result<()> {
self.calls.borrow_mut().push("validate");
if self.healthy.get() { Ok(()) } else { Err(Error::Invalid("worldserver exited".into())) }
}
}
struct World {
_d: tempfile::TempDir,
root: PathBuf,
meta: PathBuf,
pkg: PathBuf,
key: String,
}
fn write(root: &Path, rel: &str, content: &[u8]) {
let p = root.join(rel);
fs::create_dir_all(p.parent().unwrap()).unwrap();
fs::write(p, content).unwrap();
}
/// An installation at version 1 (files recorded as pristine) and a signed update package.
fn world(extra_update_files: &[(&str, &[u8])], migrations: bool) -> World {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
let meta_dir = d.path().join("srv.manager");
let pkg = d.path().join("pkg");
let src = d.path().join("upd");
write(&root, "Core/worldserver.exe", b"world-v1");
write(&root, "Core/authserver.exe", b"auth-v1");
write(&root, "Settings/worldserver.conf.template", b"[worldserver]\nRate.XP.Kill = 3\n");
write(&root, "user-notes.txt", b"mine");
fs::create_dir_all(&meta_dir).unwrap();
let mut meta = InstallMeta::new(InstallKind::New, &root);
meta.core.version = Some("1.0.0".into());
for f in ["Core/worldserver.exe", "Core/authserver.exe"] {
meta.original_hashes.insert(f.into(), fsx::sha256_file(&root.join(f)).unwrap());
}
for sub in ["manifests", "backups", "updates", "staging"] {
fs::create_dir_all(meta_dir.join(sub)).unwrap();
}
fsx::atomic_write_json(&meta_dir.join("install.json"), &meta).unwrap();
write(&src, "Core/worldserver.exe", b"world-v2");
write(&src, "Settings/worldserver.conf.template", b"[worldserver]\nRate.XP.Kill = 1\nNew.Setting = 5\n");
write(&src, "Core/newfile.dll", b"dll");
for (p, c) in extra_update_files {
write(&src, p, c);
}
if migrations {
write(&src, "_migrations/world/m1.sql", b"SELECT 1;");
}
let mut m = build(&src, &pkg, &BuildOptions { kind: Kind::Update, version: "2.0.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
// Settings/* are merge-config by the packager; make the migration entry visible to the runner
if migrations {
m.migrations.push(crate::manifest::Migration { id: "m1".into(), db: "world".into(), sha256: fsx::sha256_bytes(b"SELECT 1;"), destructive: false });
fs::write(pkg.join("manifest.json"), serde_json::to_vec_pretty(&m).unwrap()).unwrap();
}
let sk = SigningKey::generate(&mut rand_core::OsRng);
let bytes = fs::read(pkg.join("manifest.json")).unwrap();
fs::write(pkg.join("manifest.json.sig"), base64::engine::general_purpose::STANDARD.encode(sk.sign(&bytes).to_bytes())).unwrap();
World { _d: d, root, meta: meta_dir, pkg, key: base64::engine::general_purpose::STANDARD.encode(sk.verifying_key().to_bytes()) }
}
fn run(w: &World, env: &Fake, res: BTreeMap<String, Resolution>, fail_after: Option<usize>) -> Result<Outcome> {
apply(
&Params { root: &w.root, meta_dir: &w.meta, source: Source::Dir(w.pkg.clone()), trusted_key: &w.key, cancel: Cancel::default(), resolutions: res, env, fail_after_ops: fail_after },
&|_, _| {},
)
}
fn read(w: &World, rel: &str) -> Vec<u8> {
fs::read(w.root.join(rel)).unwrap()
}
#[test]
fn happy_path_replaces_creates_merges_and_records_ownership() {
let w = world(&[], false);
let env = Fake::ok();
let out = run(&w, &env, BTreeMap::new(), None).unwrap();
assert_eq!(out.txn.state, State::Committed);
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v2");
assert_eq!(read(&w, "Core/authserver.exe"), b"auth-v1", "files not in the update are untouched");
assert_eq!(read(&w, "Core/newfile.dll"), b"dll");
assert_eq!(read(&w, "user-notes.txt"), b"mine");
let tpl = String::from_utf8(read(&w, "Settings/worldserver.conf.template")).unwrap();
assert!(tpl.contains("Rate.XP.Kill = 3"), "the user's value survives the merge: {tpl}");
assert!(tpl.contains("New.Setting = 5"), "new keys are added");
let (_, meta) = MetaDir::open(&w.meta).unwrap();
assert_eq!(meta.core.version.as_deref(), Some("2.0.0"));
assert_eq!(meta.original_hashes["Core/worldserver.exe"], fsx::sha256_bytes(b"world-v2"));
assert_eq!(*env.calls.borrow(), ["stop", "snapshot", "validate"]);
assert!(!w.root.join("Core/worldserver.exe.coa-new").exists());
}
#[test]
fn a_file_modified_by_the_user_is_a_conflict_until_resolved() {
let w = world(&[], false);
write(&w.root, "Core/worldserver.exe", b"my-custom-build");
let env = Fake::ok();
let e = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(e.to_string().contains("need your decision"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"my-custom-build", "nothing changed");
assert!(env.calls.borrow().is_empty(), "the server was never touched or stopped");
let mut keep = BTreeMap::new();
keep.insert("Core/worldserver.exe".to_string(), Resolution::Keep);
run(&w, &env, keep, None).unwrap();
assert_eq!(read(&w, "Core/worldserver.exe"), b"my-custom-build");
assert_eq!(read(&w, "Core/newfile.dll"), b"dll", "the rest of the update still applied");
let w2 = world(&[], false);
write(&w2.root, "Core/worldserver.exe", b"my-custom-build");
let mut rep = BTreeMap::new();
rep.insert("Core/worldserver.exe".to_string(), Resolution::Replace);
run(&w2, &Fake::ok(), rep, None).unwrap();
assert_eq!(read(&w2, "Core/worldserver.exe"), b"world-v2");
let t = unfinished(&w2.meta);
assert!(t.is_none());
let saved = fs::read_dir(w2.meta.join("updates")).unwrap().flatten().next().unwrap().path().join("before/Core/worldserver.exe");
assert_eq!(fs::read(saved).unwrap(), b"my-custom-build", "the replaced custom build is kept for rollback");
}
#[test]
fn failure_in_the_middle_of_applying_restores_every_file_byte_for_byte() {
for fail_after in [0usize, 1, 2] {
let w = world(&[], false);
let snap: Vec<(String, Vec<u8>)> = ["Core/worldserver.exe", "Core/authserver.exe", "Settings/worldserver.conf.template", "user-notes.txt"].iter().map(|p| (p.to_string(), read(&w, p))).collect();
let e = run(&w, &Fake::ok(), BTreeMap::new(), Some(fail_after)).unwrap_err();
assert!(e.to_string().contains("simulated"));
for (p, b) in &snap {
assert_eq!(&read(&w, p), b, "{p} after failure at op {fail_after}");
}
assert!(!w.root.join("Core/newfile.dll").exists(), "files created by the update are removed again");
let (_, meta) = MetaDir::open(&w.meta).unwrap();
assert_eq!(meta.core.version.as_deref(), Some("1.0.0"), "version not bumped");
}
}
#[test]
fn unhealthy_new_build_is_kept_until_the_owner_rolls_back() {
let w = world(&[], false);
let env = Fake::ok();
env.healthy.set(false);
let out = run(&w, &env, BTreeMap::new(), None).unwrap();
assert_eq!(out.txn.state, State::NeedsDecision);
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v2", "not undone automatically");
assert_eq!(unfinished(&w.meta).unwrap().id, out.txn.id);
let (_, meta) = MetaDir::open(&w.meta).unwrap();
assert_eq!(meta.core.version.as_deref(), Some("1.0.0"), "not committed");
rollback(&w.root, &w.meta, &out.txn.id, &env).unwrap();
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(!w.root.join("Core/newfile.dll").exists());
assert!(unfinished(&w.meta).is_none());
assert!(rollback(&w.root, &w.meta, &out.txn.id, &env).is_err(), "already rolled back");
}
#[test]
fn crash_recovery_uses_the_journal() {
let w = world(&[], false);
// simulate a crash after two operations: run to failure, then reset the journal to a non-terminal state
run(&w, &Fake::ok(), BTreeMap::new(), Some(2)).unwrap_err();
let id = fs::read_dir(w.meta.join("updates")).unwrap().flatten().next().unwrap().file_name().to_string_lossy().into_owned();
// pretend the process died mid-apply: files are in the half-applied state again
write(&w.root, "Core/worldserver.exe", b"world-v2");
let mut t = load(&w.meta, &id).unwrap();
t.state = State::Applying;
for op in t.ops.iter_mut() {
op.started = op.path == "Core/worldserver.exe";
}
save(&w.meta, &t).unwrap();
assert_eq!(unfinished(&w.meta).unwrap().id, id);
rollback(&w.root, &w.meta, &id, &Fake::ok()).unwrap();
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn a_running_server_or_failed_backup_blocks_the_update_before_any_change() {
let w = world(&[], false);
let env = Fake::ok();
env.stopped.set(false);
assert!(run(&w, &env, BTreeMap::new(), None).is_err());
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
let env = Fake::ok();
env.snapshot_ok.set(false);
let e = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(e.to_string().contains("safety backup failed"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn a_failed_migration_undoes_the_files_and_reports_it() {
let w = world(&[], true);
let env = Fake::ok();
env.migrate_fail.set(true);
let e = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(e.to_string().contains("Database update m1 failed"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(!env.calls.borrow().contains(&"validate"), "the new build is never started after a failed migration");
let ok = Fake::ok();
let out = run(&w, &ok, BTreeMap::new(), None).unwrap();
assert_eq!(out.txn.state, State::Committed);
assert_eq!(*ok.calls.borrow(), ["stop", "snapshot", "migrate", "validate"]);
}
#[test]
fn bad_signature_and_wrong_package_kind_change_nothing() {
let w = world(&[], false);
let other = SigningKey::generate(&mut rand_core::OsRng);
let wrong_key = base64::engine::general_purpose::STANDARD.encode(other.verifying_key().to_bytes());
let env = Fake::ok();
let r = apply(&Params { root: &w.root, meta_dir: &w.meta, source: Source::Dir(w.pkg.clone()), trusted_key: &wrong_key, cancel: Cancel::default(), resolutions: BTreeMap::new(), env: &env, fail_after_ops: None }, &|_, _| {});
assert!(r.is_err());
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(env.calls.borrow().is_empty());
let (_, meta) = MetaDir::open(&w.meta).unwrap();
let p = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap();
assert_eq!(p.to_version, "2.0.0");
assert!(p.items.iter().any(|i| i.path == "Core/newfile.dll" && i.action == Action::Create));
}
}