Reopening a world no longer duplicates its entities (#374)
Save and Quit to Title kept boats, minecarts, armor stands, item frames, paintings and other non-mob entities in memory. Opening the world again loaded them from disk a second time and the next save wrote both copies, so each reopen doubled them until the game crawled. Closing and opening a world now let go of every entity of the level (MinecraftServer.stopServer unloads them with the level). tools/test_world_reopen_parity.py reopens a world three times and checks its minecarts stay the same. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -6145,7 +6145,6 @@ impl Game<'_> {
|
||||
horizon_client::save::migrate_legacy(&save_root)?;
|
||||
self.session_lock = None;
|
||||
self.session_lock = Some(horizon_client::save::SessionLock::acquire(&save_root)?);
|
||||
self.persist = Default::default();
|
||||
self.score = Default::default();
|
||||
self.fns = Default::default();
|
||||
self.bosses = Default::default();
|
||||
@@ -6279,8 +6278,7 @@ impl Game<'_> {
|
||||
self.block_ticks = Ticks::new(self.level.seed as i32);
|
||||
self.install_live_features();
|
||||
self.tick_chunks.clear();
|
||||
self.falling.clear();
|
||||
self.tnts.clear();
|
||||
self.clear_entities();
|
||||
self.travelling = None;
|
||||
self.player = None;
|
||||
self.spawn = None;
|
||||
@@ -6299,14 +6297,8 @@ impl Game<'_> {
|
||||
self.spawn_origin = None;
|
||||
self.spawn_spiral = Default::default();
|
||||
self.player_spawn = None;
|
||||
self.mobs.clear();
|
||||
self.creatures.reset_trader();
|
||||
self.portals = Default::default();
|
||||
self.creatures.projectiles.clear();
|
||||
self.dropped.clear();
|
||||
self.particles.clear();
|
||||
self.pickups.clear();
|
||||
self.orbs.clear();
|
||||
self.experience = Experience {
|
||||
level: self.level.xp_level,
|
||||
progress: self.level.xp_progress,
|
||||
@@ -6629,11 +6621,7 @@ impl Game<'_> {
|
||||
self.streaming.paused = true;
|
||||
self.world = World::new(self.res.facts.air, 0);
|
||||
self.player = None;
|
||||
self.mobs.clear();
|
||||
self.creatures.projectiles.clear();
|
||||
self.dropped.clear();
|
||||
self.particles.clear();
|
||||
self.pickups.clear();
|
||||
self.clear_entities();
|
||||
self.screen = Screen::Playing;
|
||||
if let Some(r) = self.renderer.as_mut() {
|
||||
r.clear_sections();
|
||||
@@ -6645,6 +6633,33 @@ impl Game<'_> {
|
||||
self.capture(false);
|
||||
Ok(())
|
||||
}
|
||||
/// Let go of every entity of the level (saved first): the next world
|
||||
/// opened must not inherit them, nor save them as its own.
|
||||
fn clear_entities(&mut self) {
|
||||
self.mobs.clear();
|
||||
self.dropped.clear();
|
||||
self.orbs.clear();
|
||||
self.creatures.projectiles.clear();
|
||||
self.falling.clear();
|
||||
self.tnts.clear();
|
||||
self.boats.clear();
|
||||
self.carts.clear();
|
||||
self.armor_stands.clear();
|
||||
self.item_frames.clear();
|
||||
self.paintings.clear();
|
||||
self.others.clear();
|
||||
self.dragon = None;
|
||||
self.crystals.clear();
|
||||
self.dragon_fireballs.clear();
|
||||
self.breath_clouds.clear();
|
||||
self.tridents.clear();
|
||||
self.rockets.clear();
|
||||
self.bolts.clear();
|
||||
self.particles.clear();
|
||||
self.pickups.clear();
|
||||
self.riding = None;
|
||||
self.persist = Default::default();
|
||||
}
|
||||
/// Equipment attribute modifiers (LivingEntity.collectEquipmentChanges).
|
||||
fn apply_equipment(&mut self) {
|
||||
let Some(player) = self.player.as_mut() else {
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Leaving a world and opening it again keeps its entities as they were (#374).
|
||||
|
||||
Vanilla's integrated server unloads every entity with the level when the player saves
|
||||
and quits (`MinecraftServer.stopServer`), so a world reopened in the same session holds
|
||||
each entity once. Horizon kept non-mob entities (minecarts, boats, armor stands...) in
|
||||
memory after Save and Quit to Title; opening the world loaded them again from disk and
|
||||
the next save wrote both copies, doubling them each time, until the game crawled.
|
||||
|
||||
The game runs offscreen (macOS) or on the virtual screen (Linux) with a control socket:
|
||||
a minecart is summoned beside the player (seed 7 also has mineshaft chest minecarts in
|
||||
view), then the world is closed through the pause menu and reopened from the title three
|
||||
times. The minecarts must be the same ones each time, each once.
|
||||
|
||||
test_world_reopen_parity.py [--bin-dir DIR] [--keep]
|
||||
"""
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
RESOURCES = ROOT / '.local' / 'horizon-client' / '26.3'
|
||||
RUN = ROOT / '.local' / 'world-reopen'
|
||||
CYCLES = 3
|
||||
|
||||
|
||||
def game_env():
|
||||
"""macOS renders offscreen; Linux uses the virtual screen (as test_save_roundtrip_parity)."""
|
||||
env = dict(os.environ, HORIZON_NO_AUDIO='1')
|
||||
if sys.platform == 'darwin':
|
||||
return env, ['--offscreen']
|
||||
subprocess.run(['vscreen', 'up'], check=False, capture_output=True)
|
||||
text = subprocess.run(['vscreen', 'env'], capture_output=True, text=True, check=True).stdout
|
||||
env.pop('DISPLAY', None)
|
||||
for match in re.finditer(r'(\w+)=(\S+)', text.split('unset')[0]):
|
||||
env[match.group(1)] = match.group(2)
|
||||
return env, []
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||
parser.add_argument('--bin-dir', help='prebuilt horizon-client and horizon-ctl (default: build them with the fast profile)')
|
||||
parser.add_argument('--keep', action='store_true', help='keep the run folder')
|
||||
args = parser.parse_args()
|
||||
bin_dir = Path(args.bin_dir).resolve() if args.bin_dir else None
|
||||
if bin_dir is None:
|
||||
subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', '--bins'], cwd=ROOT, check=True)
|
||||
bin_dir = ROOT / os.environ.get('CARGO_TARGET_DIR', 'target') / 'fast'
|
||||
shutil.rmtree(RUN, ignore_errors=True)
|
||||
RUN.mkdir(parents=True)
|
||||
socket = Path(tempfile.mkdtemp(prefix='hzro')) / 'control.sock' # sockets need short paths
|
||||
env, extra = game_env()
|
||||
|
||||
def ctl(*words, check=True):
|
||||
result = subprocess.run([str(bin_dir / 'horizon-ctl'), '--socket', str(socket), '--timeout', '600', *words],
|
||||
cwd=RUN, env=env, capture_output=True, text=True)
|
||||
if check and result.returncode:
|
||||
sys.exit(f'horizon-ctl {" ".join(words)} failed: {result.stdout}{result.stderr}')
|
||||
return json.loads(result.stdout) if result.stdout.strip().startswith('{') else result.stdout
|
||||
|
||||
def carts():
|
||||
found = ctl('status')['carts']
|
||||
return sorted((c['kind'], *(round(v, 1) for v in c['position'])) for c in found)
|
||||
|
||||
ctl('launch', '--resources', str(RESOURCES), '--world', 'reopen', '--seed', '7', '--creative',
|
||||
'--render-distance', '4', *extra)
|
||||
failures = 0
|
||||
try:
|
||||
ctl('wait-ready', '300')
|
||||
ctl('command', 'summon minecraft:minecart ~2 ~ ~2')
|
||||
ctl('wait', '20')
|
||||
expected = carts()
|
||||
print('minecarts:', len(expected))
|
||||
if not any(kind == 'minecraft:minecart' for kind, *_ in expected):
|
||||
sys.exit(f'the summoned minecart is not there: {expected}')
|
||||
for cycle in range(1, CYCLES + 1):
|
||||
ctl('pause')
|
||||
ctl('click-button', 'Save and Quit to Title')
|
||||
ctl('wait-for', 'screen', 'title', '--timeout', '120')
|
||||
ctl('open', 'reopen')
|
||||
ctl('wait-for', 'loaded', '--timeout', '300')
|
||||
ctl('wait', '20')
|
||||
got = carts()
|
||||
ok = got == expected
|
||||
failures += not ok
|
||||
print(f'reopen {cycle}: {len(got)} minecarts', 'ok' if ok else f'FAIL (expected {len(expected)})')
|
||||
finally:
|
||||
ctl('quit', check=False)
|
||||
if not args.keep and not failures:
|
||||
shutil.rmtree(RUN, ignore_errors=True)
|
||||
print('world reopen:', 'PASS' if not failures else f'{failures} FAILED')
|
||||
sys.exit(1 if failures else 0)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user