feat: Refactor MD5 hashing and update save game codec for compatibility with new payload format

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
This commit is contained in:
2026-03-23 16:03:12 +01:00
parent f05a861998
commit c4c8e4149a
9 changed files with 394 additions and 29 deletions
@@ -0,0 +1,21 @@
import 'package:test/test.dart';
import 'package:wolf_3d_dart/wolf_3d_data_types.dart';
void main() {
group('DataVersion.fromChecksum', () {
test('resolves all known checksum constants', () {
for (final version in DataVersion.values.where(
(version) => version != DataVersion.unknown,
)) {
expect(DataVersion.fromChecksum(version.checksum), version);
}
});
test('returns unknown for unrecognized checksum', () {
expect(
DataVersion.fromChecksum('ffffffffffffffffffffffffffffffff'),
DataVersion.unknown,
);
});
});
}
@@ -0,0 +1,34 @@
import 'dart:convert';
import 'package:test/test.dart';
import 'package:wolf_3d_dart/src/data/md5_hash.dart';
void main() {
group('md5HexLower', () {
test('matches canonical RFC vectors', () {
expect(md5HexLower(const <int>[]), 'd41d8cd98f00b204e9800998ecf8427e');
expect(
md5HexLower(utf8.encode('abc')),
'900150983cd24fb0d6963f7d28e17f72',
);
expect(
md5HexLower(utf8.encode('The quick brown fox jumps over the lazy dog')),
'9e107d9d372bb6826bd81d3542a419d6',
);
expect(
md5HexLower(
utf8.encode(
'12345678901234567890123456789012345678901234567890123456789012345678901234567890',
),
),
'57edf4a22be3c955ac49da2e2107b67a',
);
});
test('returns lowercase 32-character hex output', () {
final digest = md5HexLower(utf8.encode('Wolf3D'));
expect(digest, hasLength(32));
expect(digest, matches(RegExp(r'^[0-9a-f]{32}$')));
});
});
}
@@ -183,9 +183,10 @@ void main() {
final Uint8List encoded = codec.encode(file);
final SaveGameFile decoded = codec.decode(encoded);
expect(decoded.slot, 0);
expect(decoded.slot, 2);
expect(decoded.description, 'Compatible Block Save');
expect(decoded.createdAtMs, 0);
expect(decoded.createdAtMs, 1234);
expect(decoded.dataVersionName, file.dataVersionName);
expect(
decoded.snapshot.currentEpisodeIndex,
file.snapshot.currentEpisodeIndex,
@@ -193,6 +194,45 @@ void main() {
expect(decoded.snapshot.currentLevelIndex, file.snapshot.currentLevelIndex);
});
test('CompatibleSaveGameCodec preserves entity state fidelity', () {
final WolfEngine engine = _buildEngine();
engine.init();
final Guard guard =
EntityRegistry.spawn(
MapObject.guardStart,
8.5,
7.5,
Difficulty.medium,
engine.data.sprites.length,
registry: engine.data.registry,
)!
as Guard
..health = 5
..state = EntityState.dead;
engine.entities = <Entity>[guard];
final CompatibleSaveGameCodec codec = CompatibleSaveGameCodec();
final SaveGameFile decoded = codec.decode(
codec.encode(
SaveGameFile(
slot: 0,
gameVersion: engine.data.version,
dataVersionName: engine.data.dataVersion.name,
description: 'Entity Fidelity',
createdAtMs: 1,
snapshot: engine.captureSaveState(),
checksum: 0,
),
),
);
expect(decoded.snapshot.entities, hasLength(1));
expect(decoded.snapshot.entities.first.kind, 'Guard');
expect(decoded.snapshot.entities.first.state, EntityState.dead);
expect(decoded.snapshot.entities.first.extraData['health'], 5);
});
test('CompatibleSaveGameCodec decodes old envelope payload format', () {
final WolfEngine engine = _buildEngine();
engine.init();