Break: restructure the code

.github/workflows/check.yaml

@@ -43,17 +43,11 @@ jobs:
           command: test
           args: --all-targets
 
-      - name: 🧪 Test all features
+      - name: 🧪 Test
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --all-targets --all-features
-
-      - name: 🧪 Test docs
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --doc --all-features
+          args: --all-features
 
       - name: 🪄 Clippy
         uses: actions-rs/clippy-check@v1

README.md

@@ -18,20 +18,20 @@ use wotbreplay_parser::models::battle_results::TeamNumber;
 use wotbreplay_parser::replay::Replay;
 
 fn main() -> Result<()> {
-    let battle_results = Replay::open(File::open("tests/replays/battle_results.wotbreplay")?)?
+    let battle_results = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
         .read_battle_results()?;
 
-    assert_eq!(battle_results.timestamp, 1670018359);
+    assert_eq!(battle_results.timestamp, 1670083956);
     assert_eq!(battle_results.players.len(), 14);
 
-    assert_eq!(battle_results.players[0].account_id, 520886428);
-    assert_eq!(battle_results.players[0].info.nickname, "77mmmr");
-    assert_eq!(battle_results.players[0].info.team(), TeamNumber::Two);
-    assert_eq!(battle_results.players[0].info.platoon_id, None);
+    assert_eq!(battle_results.players[0].account_id, 595693744);
+    assert_eq!(battle_results.players[0].info.nickname, "yuranhik_hustriy26");
+    assert_eq!(battle_results.players[0].info.team(), TeamNumber::One);
+    assert_eq!(battle_results.players[0].info.platoon_id, Some(545104609));
 
     assert_eq!(battle_results.players[1].info.nickname, "SNAK_THE_RIPPER");
-    assert_eq!(battle_results.players[1].info.team(), TeamNumber::One);
-    assert_eq!(battle_results.players[1].info.platoon_id, Some(547466834));
+    assert_eq!(battle_results.players[1].info.team(), TeamNumber::Two);
+    assert_eq!(battle_results.players[1].info.platoon_id, Some(273692628));
 
     Ok(())
 }

rustfmt.toml

@@ -8,3 +8,4 @@ reorder_impl_items = true
 unstable_features = true
 use_field_init_shorthand = true
 version = "Two"
+struct_lit_width = 35

src/error.rs

@@ -6,10 +6,10 @@ pub enum Error {
     ZipError(#[from] zip::result::ZipError),
 
     #[error("Protocol Buffers error")]
-    DecodeFailed(#[from] prost::DecodeError),
+    ProtobufError(#[from] prost::DecodeError),
 
     #[error("Pickle error")]
-    UnpickleFailed(#[from] serde_pickle::Error),
+    PickleError(#[from] serde_pickle::Error),
 
     #[error("I/O error")]
     IoError(#[from] std::io::Error),
@@ -19,7 +19,7 @@ pub enum Error {
 
     #[cfg(feature = "meta")]
     #[error("JSON error")]
-    JsonDecodeFailed(#[from] serde_json::Error),
+    JsonError(#[from] serde_json::Error),
 
     #[error("invalid magic: {0:#X}, expected: {1:#X}")]
     InvalidMagic(u32, u32),

src/models/battle_results.rs

@@ -1,5 +1,5 @@
 use prost::bytes::Buf;
-use prost::Message;
+use prost::{Enumeration, Message};
 use serde::Serialize;
 
 use crate::result::Result;
@@ -22,8 +22,8 @@ pub struct BattleResults {
     #[prost(int64, tag = "2")]
     pub timestamp: i64,
 
-    #[prost(enumeration = "TeamNumber", tag = "3")]
-    pub winner_team_number: i32,
+    #[prost(enumeration = "TeamNumber", optional, tag = "3")]
+    pub winner_team_number: Option<i32>,
 
     /// Replay's author results.
     #[prost(message, required, tag = "8")]
@@ -78,9 +78,7 @@ pub struct PlayerInfo {
     pub avatar: Avatar,
 }
 
-#[derive(
-    Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration, Serialize,
-)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Enumeration, Serialize)]
 #[repr(i32)]
 pub enum TeamNumber {
     One = 1,

src/models/data.rs

@@ -1,10 +1,9 @@
-//! `data.wotreplay` models.
+//! Models for `data.wotreplay` contents.
 
+pub mod base_player_create;
 pub mod entity_method;
 pub mod packet;
 pub mod payload;
-pub mod replay_header;
-pub mod summary;
 
 use std::io::Read;
 
@@ -12,11 +11,7 @@ use byteorder::{LittleEndian, ReadBytesExt};
 use serde::de::DeserializeOwned;
 use serde::Serialize;
 
-pub use self::entity_method::*;
-pub use self::summary::*;
 use crate::models::data::packet::Packet;
-use crate::models::data::payload::Payload;
-use crate::models::data::replay_header::ReplayHeader;
 use crate::result::Result;
 use crate::Error;
 
@@ -26,9 +21,7 @@ pub struct Data {
     /// For example: `9.8.5_apple`.
     pub client_version: String,
 
-    pub replay_header: Option<ReplayHeader>,
-
-    pub other_packets: Vec<Packet>,
+    pub packets: Vec<Packet>,
 }
 
 impl Data {
@@ -39,36 +32,19 @@ impl Data {
         reader.read_u64::<LittleEndian>()?;
 
         // Some sort of client hash, e.g.: `6CF2A9EFA5C52D6F6CE43A6D4A699C05`:
-        read_bytes(&mut reader)?;
+        read_length_delimited(&mut reader)?;
 
         let client_version = read_string(&mut reader)?;
 
         // Some extra byte, no idea:
         reader.read_u8()?;
 
-        let mut this = Self::new(client_version);
-
-        loop {
-            let Some(packet) = Packet::from_reader(&mut reader)? else { break };
-            match packet.payload {
-                Payload::ReplayHeader(header) => {
-                    this.replay_header = Some(header);
-                }
-                _ => {
-                    this.other_packets.push(packet);
-                }
-            }
+        let mut packets = Vec::new();
+        while let Some(packet) = Packet::from_reader(&mut reader)? {
+            packets.push(packet);
         }
 
-        Ok(this)
-    }
-
-    pub const fn new(client_version: String) -> Self {
-        Self {
-            client_version,
-            replay_header: None,
-            other_packets: Vec::new(),
-        }
+        Ok(Self { client_version, packets })
     }
 }
 
@@ -82,7 +58,7 @@ fn assert_magic<T: Into<u32> + PartialEq>(actual: T, expected: T) -> Result {
 }
 
 #[inline]
-fn read_bytes(reader: &mut impl Read) -> Result<Vec<u8>> {
+fn read_length_delimited(reader: &mut impl Read) -> Result<Vec<u8>> {
     let length = reader.read_u8()? as usize;
     let mut buffer = Vec::new();
     buffer.resize(length, 0);
@@ -92,7 +68,7 @@ fn read_bytes(reader: &mut impl Read) -> Result<Vec<u8>> {
 
 #[inline]
 fn read_string(reader: &mut impl Read) -> Result<String> {
-    Ok(String::from_utf8(read_bytes(reader)?)?)
+    Ok(String::from_utf8(read_length_delimited(reader)?)?)
 }
 
 #[inline]
@@ -102,3 +78,19 @@ fn read_pickled<T: DeserializeOwned>(reader: &mut impl Read, length: usize) -> R
     reader.read_exact(&mut buffer)?;
     Ok(serde_pickle::from_slice(&buffer, Default::default())?)
 }
+
+/// Read 2-byte length surrounded by the magical `0xFF` and `0x00`,
+/// unless it's a simple 1-byte length.
+///
+/// P.S. Okay, Wargaming, I've no idea what you smoke, but I want some!
+#[inline]
+fn read_quirky_length(reader: &mut impl Read) -> Result<usize> {
+    match reader.read_u8()? {
+        0xFF => {
+            let length = reader.read_u16::<LittleEndian>()?;
+            assert_magic(reader.read_u8()?, 0x00)?;
+            Ok(length as usize)
+        }
+        length => Ok(length as usize),
+    }
+}

src/models/data/base_player_create.rs

@@ -0,0 +1,72 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct BasePlayerCreate {
+    #[serde(rename(deserialize = "playersBattleCategoriesIds"))]
+    pub players_battle_categories_ids: HashMap<u32, (u8, u32)>,
+
+    #[serde(rename(deserialize = "battleLevel"))]
+    pub battle_level: u8,
+
+    #[serde(rename(deserialize = "battleCategoryId"))]
+    pub battle_category_id: u8,
+
+    #[serde(rename(deserialize = "mouseEnabled"))]
+    pub is_mouse_enabled: bool,
+
+    #[serde(rename(deserialize = "mmType"))]
+    pub matchmaker_type: u8,
+
+    #[serde(rename(deserialize = "camouflageSlot"))]
+    pub camouflage_slot: u8,
+
+    #[serde(rename(deserialize = "avgMmr"))]
+    pub average_mmr: Vec<Option<f64>>,
+
+    #[serde(rename(deserialize = "playerWaitTimes"))]
+    pub player_wait_times: HashMap<u32, f64>,
+
+    #[serde(rename(deserialize = "accountDatabaseIds"))]
+    pub account_database_ids: Vec<u32>,
+
+    #[serde(rename(deserialize = "turboBattlesStats"))]
+    pub turbo_battles_statistics: TurboBattlesStatistics,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct TurboBattlesStatistics {
+    #[serde(rename(deserialize = "turboBattleChance"))]
+    pub battle_chance: f64,
+
+    #[serde(rename(deserialize = "turboLeaveChance"))]
+    pub leave_chance: f64,
+
+    #[serde(rename(deserialize = "possibleTurboBattlesNotForSkip"))]
+    pub possible_battles_not_for_skip: u32,
+
+    #[serde(rename(deserialize = "possibleTurboBattlesForSkip"))]
+    pub possible_battles_for_skip: u32,
+
+    #[serde(rename(deserialize = "turboBattlesForSkip"))]
+    pub battles_for_skip: u32,
+
+    #[serde(rename(deserialize = "turboBattlesNotForSkip"))]
+    pub battles_not_for_skip: u32,
+
+    #[serde(rename(deserialize = "abSkip"))]
+    pub ab_skip: i32,
+
+    #[serde(rename(deserialize = "beta"))]
+    pub beta: f64,
+
+    #[serde(rename(deserialize = "premiumVehDiff"))]
+    pub premium_vehicle_difference: i32,
+
+    #[serde(rename(deserialize = "htDiff"))]
+    pub ht_difference: i32,
+
+    #[serde(rename(deserialize = "alpha"))]
+    pub alpha: f64,
+}

src/models/data/entity_method.rs

@@ -1,16 +1,29 @@
 use byteorder::{LittleEndian, ReadBytesExt};
+use prost::encoding::decode_varint;
+use prost::Message;
 use serde::Serialize;
 use serde_with::serde_as;
 
+use self::update_arena::UpdateArena;
+use crate::models::data::read_quirky_length;
 use crate::result::Result;
 
+pub mod update_arena;
+
 #[serde_as]
 #[derive(Debug, Serialize)]
 pub enum EntityMethod {
-    /// TODO: team composition.
-    Subtype2F,
+    /// Subtype `0x2F`.
+    UpdateArena {
+        field_number: u64,
+        arguments: UpdateArena,
 
-    /// Default variant when subtype is not known.
+        /// Original payload for investigation.
+        #[serde_as(as = "serde_with::hex::Hex")]
+        payload: Vec<u8>,
+    },
+
+    /// Default variant when subtype is not known by the parser.
     Unknown {
         sub_type: u32,
 
@@ -21,6 +34,7 @@ pub enum EntityMethod {
 }
 
 impl EntityMethod {
+    /// Parse the entity method payload.
     pub fn new(payload: Vec<u8>) -> Result<Self> {
         let mut reader = payload.as_slice();
 
@@ -28,7 +42,18 @@ impl EntityMethod {
         let sub_type = reader.read_u32::<LittleEndian>()?;
 
         let this = match sub_type {
-            0x2F => Self::Subtype2F,
+            0x2F => {
+                let _inner_length = reader.read_u32::<LittleEndian>()?;
+
+                let field_number = decode_varint(&mut reader)?;
+                let message_length = read_quirky_length(&mut reader)?;
+                Self::UpdateArena {
+                    field_number,
+                    arguments: UpdateArena::decode(&reader[..message_length])?,
+                    payload,
+                }
+            }
+
             _ => Self::Unknown { sub_type, payload },
         };
         Ok(this)

src/models/data/entity_method/update_arena.rs

@@ -0,0 +1,32 @@
+use prost::Message;
+use serde::Serialize;
+
+#[derive(Message, Serialize)]
+pub struct UpdateArena {
+    #[prost(message, tag = "1")]
+    pub players: Option<Players>,
+}
+
+#[derive(Message, Serialize)]
+pub struct Players {
+    #[prost(message, repeated, tag = "1")]
+    pub players: Vec<Player>,
+}
+
+#[derive(Message, Serialize)]
+pub struct Player {
+    #[prost(string, required, tag = "3")]
+    pub nickname: String,
+
+    #[prost(uint32, required, tag = "4")]
+    pub team_number: u32,
+
+    #[prost(uint32, required, tag = "7")]
+    pub account_id: u32,
+
+    #[prost(string, optional, tag = "8")]
+    pub clan_tag: Option<String>,
+
+    #[prost(uint32, optional, tag = "11")]
+    pub platoon_number: Option<u32>,
+}

src/models/data/payload.rs

@@ -4,17 +4,26 @@ use byteorder::{LittleEndian, ReadBytesExt};
 use serde::Serialize;
 use serde_with::serde_as;
 
-use crate::models::data::replay_header::ReplayHeader;
-use crate::models::data::{assert_magic, read_pickled, read_string, EntityMethod};
+use crate::models::data::base_player_create::BasePlayerCreate;
+use crate::models::data::entity_method::EntityMethod;
+use crate::models::data::{read_pickled, read_quirky_length, read_string};
 use crate::result::Result;
 
 #[serde_as]
 #[derive(Debug, Serialize)]
 pub enum Payload {
-    ReplayHeader(ReplayHeader),
+    /// Type 0.
+    BasePlayerCreate {
+        author_nickname: String,
+        arena_unique_id: u64,
+        arena_type_id: u32,
+        arguments: Box<BasePlayerCreate>,
+    },
+
+    /// Type 8.
     EntityMethod(EntityMethod),
 
-    /// Default payload when type is not known.
+    /// Default payload when type is not known by the parser.
     Unknown {
         type_: u32,
 
@@ -34,26 +43,21 @@ impl Payload {
                 let author_nickname = read_string(&mut reader)?;
                 let arena_unique_id = reader.read_u64::<LittleEndian>()?;
                 let arena_type_id = reader.read_u32::<LittleEndian>()?;
-                let summary = {
-                    assert_magic(reader.read_u8()?, 0xFF)?;
-                    let pickled_length = reader.read_u16::<LittleEndian>()?;
-                    assert_magic(reader.read_u8()?, 0x00)?;
-                    read_pickled(&mut reader, pickled_length as usize)?
+                let type_0 = {
+                    let pickled_length = read_quirky_length(&mut reader)?;
+                    read_pickled(&mut reader, pickled_length)?
                 };
-                Self::ReplayHeader(ReplayHeader {
-                    summary,
+                Self::BasePlayerCreate {
+                    arguments: type_0,
                     author_nickname,
                     arena_unique_id,
                     arena_type_id,
-                })
+                }
             }
 
             8 => Self::EntityMethod(EntityMethod::new(payload)?),
 
-            _ => Self::Unknown {
-                raw: payload,
-                type_,
-            },
+            _ => Self::Unknown { raw: payload, type_ },
         };
         Ok(this)
     }

src/models/data/replay_header.rs

@@ -1,11 +0,0 @@
-use serde::Serialize;
-
-use crate::models::data::Summary;
-
-#[derive(Debug, Serialize)]
-pub struct ReplayHeader {
-    pub summary: Summary,
-    pub author_nickname: String,
-    pub arena_unique_id: u64,
-    pub arena_type_id: u32,
-}

src/models/data/summary.rs

@@ -1,27 +0,0 @@
-use std::collections::HashMap;
-
-use serde::{Deserialize, Serialize};
-
-#[derive(Debug, Serialize, Deserialize)]
-pub struct Summary {
-    #[serde(rename = "playersBattleCategoriesIds")]
-    pub players_battle_categories_ids: HashMap<u32, (u8, u32)>,
-
-    #[serde(rename = "battleLevel")]
-    pub battle_level: u8,
-
-    #[serde(rename = "battleCategoryId")]
-    pub battle_category_id: u8,
-
-    #[serde(rename = "mouseEnabled")]
-    pub is_mouse_enabled: bool,
-
-    #[serde(rename = "mmType")]
-    pub matchmaker_type: u8,
-
-    #[serde(rename = "camouflageSlot")]
-    pub camouflage_slot: u8,
-
-    #[serde(rename = "avgMmr")]
-    pub average_mmr: Vec<f64>,
-}

src/models/meta.rs

@@ -1,3 +1,4 @@
+//! Models for `meta.json` contents.
 #![cfg(feature = "meta")]
 
 use std::io::Read;

tests/battle_results.rs

@@ -11,8 +11,14 @@ fn player_results_ok() -> Result<()> {
     assert_eq!(battle_results_dat.arena_unique_id, 1661909200500084);
     let battle_results: BattleResults = battle_results_dat.try_into()?;
 
-    assert_eq!(battle_results.winner_team_number, 2);
+    assert_eq!(battle_results.winner_team_number, Some(2));
+
     assert_eq!(battle_results.author.team_number, 2);
+    assert_eq!(battle_results.author.credits_earned, 59518);
+    assert_eq!(battle_results.author.combat_xp, 5255);
+    assert_eq!(battle_results.author.damage_dealt, 1438);
+    assert_eq!(battle_results.author.account_id, 594778041);
+    assert_eq!(battle_results.free_xp, 260);
 
     let snak_the_ripper_info = &battle_results.player_results[3].info;
     assert_eq!(snak_the_ripper_info.base_xp, 929);
@@ -113,15 +119,9 @@ fn victory_points_ok() -> Result<()> {
 }
 
 #[test]
-fn author_results_ok() -> Result<()> {
-    let battle_results = Replay::open(File::open("tests/replays/author_results.wotbreplay")?)?
+fn draw_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/20230503_0027__helaas_pindakaas_A140_ASTRON_REX_105_2319058483532631656.wotbreplay")?)?
         .read_battle_results()?;
-
-    assert_eq!(battle_results.author.credits_earned, 53623);
-    assert_eq!(battle_results.author.combat_xp, 2370);
-    assert_eq!(battle_results.author.damage_dealt, 1738);
-    assert_eq!(battle_results.author.account_id, 594778041);
-    assert_eq!(battle_results.free_xp, 116);
-
+    assert_eq!(battle_results.winner_team_number, None);
     Ok(())
 }

tests/data.rs

@@ -1,26 +1,93 @@
 use std::fs::File;
 
 use anyhow::Result;
+use wotbreplay_parser::models::data::entity_method::EntityMethod;
+use wotbreplay_parser::models::data::payload::Payload;
 use wotbreplay_parser::replay::Replay;
 
 #[test]
-fn data_ok() -> Result<()> {
-    let mut replay = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?;
+fn parse_ok() -> Result<()> {
+    let mut replay = Replay::open(File::open(
+        "tests/replays/20230429_0126__helaas_pindakaas_A140_ASTRON_REX_105_16114615898101270.wotbreplay",
+    )?)?;
     let data = replay.read_data()?;
 
-    assert_eq!(data.client_version, "9.4.0_apple");
-    assert_eq!(data.other_packets.len(), 44720);
-
-    let header = data.replay_header.unwrap();
-    assert_eq!(header.author_nickname, "zeekrab");
-    assert_eq!(header.arena_unique_id, 1661909200500084);
-    assert_eq!(header.arena_type_id, 65567);
-    assert_eq!(header.summary.battle_level, 8);
-    assert_eq!(header.summary.battle_category_id, 13);
-    assert!(header.summary.is_mouse_enabled);
-    assert_eq!(header.summary.matchmaker_type, 2);
-    assert_eq!(header.summary.camouflage_slot, 1);
-    assert_eq!(header.summary.average_mmr, [-25.396859946846963, 77.58806455880404]);
+    assert_eq!(data.client_version, "9.8.5_apple");
+    assert_eq!(data.packets.len(), 60139);
+
+    Ok(())
+}
+
+#[test]
+fn type0_ok() -> Result<()> {
+    let mut replay = Replay::open(File::open(
+        "tests/replays/20230429_0126__helaas_pindakaas_A140_ASTRON_REX_105_16114615898101270.wotbreplay",
+    )?)?;
+    let data = replay.read_data()?;
+
+    let (author_nickname, arena_unique_id, arena_type_id, type_0) = data
+        .packets
+        .iter()
+        .filter_map(|packet| {
+            if let Payload::BasePlayerCreate {
+                author_nickname,
+                arena_unique_id,
+                arena_type_id,
+                arguments: type_0,
+            } = &packet.payload
+            {
+                Some((author_nickname, arena_unique_id, arena_type_id, type_0))
+            } else {
+                None
+            }
+        })
+        .next()
+        .unwrap();
+    assert_eq!(author_nickname, "helaas_pindakaas");
+    assert_eq!(*arena_unique_id, 16114615898101270);
+    assert_eq!(*arena_type_id, 43);
+    assert_eq!(type_0.battle_level, 9);
+    assert_eq!(type_0.battle_category_id, 13);
+    assert!(type_0.is_mouse_enabled);
+    assert_eq!(type_0.matchmaker_type, 2);
+    assert_eq!(type_0.camouflage_slot, 1);
+    assert_eq!(type_0.average_mmr, [Some(59.29457753400008), Some(99.34182121604681)]);
+    assert_eq!(
+        type_0.account_database_ids,
+        [
+            517033644, 537867068, 597583401, 601893865, 576810156, 531053956, 599580824, 558025185,
+            526927603, 594778041, 505587490, 597422303, 531923111, 587617355
+        ]
+    );
+
+    Ok(())
+}
+
+#[test]
+fn subtype_2f_players_ok() -> Result<()> {
+    let mut replay = Replay::open(File::open(
+        "tests/replays/20230429_0126__helaas_pindakaas_A140_ASTRON_REX_105_16114615898101270.wotbreplay",
+    )?)?;
+    let data = replay.read_data()?;
+
+    let players = data
+        .packets
+        .iter()
+        .filter_map(|packet| match &packet.payload {
+            Payload::EntityMethod(EntityMethod::UpdateArena { arguments: sub_type_2f, .. }) => {
+                sub_type_2f.players.as_ref()
+            }
+            _ => None,
+        })
+        .next()
+        .unwrap();
+
+    assert_eq!(players.players.len(), 14);
+    assert_eq!(players.players[1].team_number, 1);
+    assert_eq!(players.players[1].nickname, "Igrok_WoT_blitz");
+    assert_eq!(players.players[1].account_id, 597583401);
+    assert_eq!(players.players[1].platoon_number, None);
+    assert_eq!(players.players[1].clan_tag, Some("F_ANG".to_string()));
 
     Ok(())
 }