Break: read replay packets

.github/workflows/check.yaml

@@ -20,37 +20,49 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
+      - name: 📥 Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
-      - name: Set up the toolchain
+      - name: ✨ Set up the toolchain
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           components: rustfmt, clippy
 
-      - name: Rust Cache
+      - name: ⚡️ Rust Cache
         uses: Swatinem/rust-cache@v1
         with:
           cache-on-failure: true
 
-      - name: Test
+      - name: 🧪 Test without optional features
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --doc
+          args: --all-targets
 
-      - name: Clippy
+      - name: 🧪 Test all features
+        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
+
+      - name: 🪄 Clippy
         uses: actions-rs/clippy-check@v1
         continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-targets --all-features --tests -- -D warnings
 
-      - name: Publish the crates (dry run)
+      - name: 📤 Publish the crates (dry run)
         run: |
           cargo publish --allow-dirty --dry-run
         env:

.github/workflows/publish.yaml

@@ -15,12 +15,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout the repository
+      - name: 📥 Checkout the repository
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Set the versions
+      - name: 🪄 Set the versions
         run: |
           sed -i -e 's/version = "0\.0\.0"/version = "${{ github.ref_name }}"/g' Cargo.toml
       - name: Rustup
@@ -29,13 +29,13 @@ jobs:
           profile: minimal
           toolchain: stable
 
-      - name: Build the changelog
+      - name: 📝 Build the changelog
         id: changelog
         uses: Bullrich/generate-release-changelog@master
         env:
           REPO: ${{ github.repository }}
 
-      - name: Update the release
+      - name: 🪄 Update the release
         uses: tubone24/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -43,7 +43,7 @@ jobs:
           release_name: ${{ github.ref_name }}
           body: ${{ steps.changelog.outputs.changelog }}
 
-      - name: Publish the crates
+      - name: 📤 Publish the crates
         run: |
           cargo publish --allow-dirty
         env:

Cargo.toml

@@ -12,13 +12,17 @@ categories = ["parsing"]
 
 [features]
 default = []
+meta = ["dep:serde_json"]
 
 [dependencies]
+bytes = "1.4.0"
+byteorder = "1.4.3"
 prost = "0.11.3"
 serde = { version = "1.0.148", features = ["derive"] }
 serde_bytes = "0.11.7"
 serde-pickle = "1.1.1"
-serde_json = "1.0.96"
+serde_json = { version = "1.0.96", optional = true }
+serde_with = { version = "2.3.3", features = ["hex"] }
 thiserror = "1.0.37"
 zip = { version = "0.6.3", default-features = false, features = ["deflate"] }
 

src/error.rs

@@ -2,18 +2,28 @@ use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum Error {
-    #[error("failed to open the replay as a ZIP-archive")]
+    #[error("ZIP error")]
-    OpenArchiveFailed(#[source] zip::result::ZipError),
+    ZipError(#[from] zip::result::ZipError),
 
-    #[error("failed to open the entry in the replay archive")]
+    #[error("Protocol Buffers error")]
-    OpenEntryFailed(#[source] zip::result::ZipError),
+    DecodeFailed(#[from] prost::DecodeError),
 
-    #[error("failed to decode the Protocol Buffers encoded data")]
+    #[error("Pickle error")]
-    DecodeFailed(#[source] prost::DecodeError),
+    UnpickleFailed(#[from] serde_pickle::Error),
 
-    #[error("failed to un-pickle")]
+    #[error("I/O error")]
-    UnpickleFailed(#[source] serde_pickle::Error),
+    IoError(#[from] std::io::Error),
 
-    #[error("failed to decode JSON")]
+    #[error("UTF-8 error")]
-    JsonDecodeFailed(#[source] serde_json::Error),
+    StringDecodeError(#[from] std::string::FromUtf8Error),
+
+    #[cfg(feature = "meta")]
+    #[error("JSON error")]
+    JsonDecodeFailed(#[from] serde_json::Error),
+
+    #[error("invalid magic: {0:#X}, expected: {1:#X}")]
+    InvalidMagic(u32, u32),
+
+    #[error("failed to read a packet length, got {0} bytes")]
+    PacketLengthError(usize),
 }

src/lib.rs

@@ -12,9 +12,8 @@
 )]
 
 mod error;
-mod models;
+pub mod models;
-pub mod prelude;
+pub mod replay;
-mod replay;
 mod result;
 
 pub use self::error::Error;

src/models.rs

@@ -1,7 +1,4 @@
-mod battle_results;
+pub mod battle_results;
-mod battle_results_dat;
+pub mod battle_results_dat;
-mod meta;
+pub mod data;
-
+pub mod meta;
-pub use self::battle_results::*;
-pub use self::battle_results_dat::*;
-pub use self::meta::*;

src/models/battle_results.rs

@@ -2,7 +2,6 @@ use prost::bytes::Buf;
 use prost::Message;
 use serde::Serialize;
 
-use crate::error::Error;
 use crate::result::Result;
 
 impl BattleResults {
@@ -10,7 +9,7 @@ impl BattleResults {
     ///
     /// Note, that this does NOT parse `battle_results.dat` itself, but the un-pickled tuple element.
     pub fn from_buffer(buffer: impl Buf) -> Result<Self> {
-        Self::decode(buffer).map_err(Error::DecodeFailed)
+        Ok(Self::decode(buffer)?)
     }
 }
 
@@ -24,7 +23,7 @@ pub struct BattleResults {
     pub timestamp: i64,
 
     #[prost(enumeration = "TeamNumber", tag = "3")]
-    pub winning_team: i32,
+    pub winner_team_number: i32,
 
     /// Replay's author results.
     #[prost(message, required, tag = "8")]

src/models/battle_results_dat.rs

@@ -5,7 +5,7 @@ use serde::Deserialize;
 use serde_bytes::ByteBuf;
 
 use crate::error::Error;
-use crate::models::BattleResults;
+use crate::models::battle_results::BattleResults;
 use crate::result::Result;
 
 /// Represents un-pickled `battle_results.dat`.
@@ -33,7 +33,7 @@ impl BattleResultsDat {
     /// It can be used either on the `battle_results.dat` for a replay archive,
     /// or directly on `**/DAVAProject/battle_results/*/*_full.dat`.
     pub fn from_reader(reader: impl Read) -> Result<Self> {
-        serde_pickle::from_reader(reader, Default::default()).map_err(Error::UnpickleFailed)
+        Ok(serde_pickle::from_reader(reader, Default::default())?)
     }
 }
 
@@ -42,6 +42,6 @@ impl TryInto<BattleResults> for BattleResultsDat {
 
     /// Decodes the battle results from the internal buffer.
     fn try_into(self) -> Result<BattleResults> {
-        BattleResults::decode(self.buffer.as_ref()).map_err(Error::DecodeFailed)
+        Ok(BattleResults::decode(self.buffer.as_ref())?)
     }
 }

src/models/data.rs

@@ -0,0 +1,104 @@
+//! `data.wotreplay` models.
+
+pub mod entity_method;
+pub mod packet;
+pub mod payload;
+pub mod replay_header;
+pub mod summary;
+
+use std::io::Read;
+
+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;
+
+/// `data.wotreplay` root structure.
+#[derive(Debug, Serialize)]
+pub struct Data {
+    /// For example: `9.8.5_apple`.
+    pub client_version: String,
+
+    pub replay_header: Option<ReplayHeader>,
+
+    pub other_packets: Vec<Packet>,
+}
+
+impl Data {
+    pub fn from_reader(mut reader: impl Read) -> Result<Self> {
+        assert_magic(reader.read_u32::<LittleEndian>()?, 0x12345678)?;
+
+        // No idea what it is:
+        reader.read_u64::<LittleEndian>()?;
+
+        // Some sort of client hash, e.g.: `6CF2A9EFA5C52D6F6CE43A6D4A699C05`:
+        read_bytes(&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);
+                }
+            }
+        }
+
+        Ok(this)
+    }
+
+    pub const fn new(client_version: String) -> Self {
+        Self {
+            client_version,
+            replay_header: None,
+            other_packets: Vec::new(),
+        }
+    }
+}
+
+#[inline]
+fn assert_magic<T: Into<u32> + PartialEq>(actual: T, expected: T) -> Result {
+    if actual == expected {
+        Ok(())
+    } else {
+        Err(Error::InvalidMagic(actual.into(), expected.into()))
+    }
+}
+
+#[inline]
+fn read_bytes(reader: &mut impl Read) -> Result<Vec<u8>> {
+    let length = reader.read_u8()? as usize;
+    let mut buffer = Vec::new();
+    buffer.resize(length, 0);
+    reader.read_exact(&mut buffer)?;
+    Ok(buffer)
+}
+
+#[inline]
+fn read_string(reader: &mut impl Read) -> Result<String> {
+    Ok(String::from_utf8(read_bytes(reader)?)?)
+}
+
+#[inline]
+fn read_pickled<T: DeserializeOwned>(reader: &mut impl Read, length: usize) -> Result<T> {
+    let mut buffer = Vec::new();
+    buffer.resize(length, 0);
+    reader.read_exact(&mut buffer)?;
+    Ok(serde_pickle::from_slice(&buffer, Default::default())?)
+}

src/models/data/entity_method.rs

@@ -0,0 +1,28 @@
+use byteorder::{LittleEndian, ReadBytesExt};
+use serde::Serialize;
+
+use crate::result::Result;
+
+#[derive(Debug, Serialize)]
+pub enum EntityMethod {
+    /// TODO: team composition.
+    Subtype2F,
+
+    /// Default variant when subtype is not known.
+    Unknown { sub_type: u32, payload: Vec<u8> },
+}
+
+impl EntityMethod {
+    pub fn new(payload: Vec<u8>) -> Result<Self> {
+        let mut reader = payload.as_slice();
+
+        reader.read_u32::<LittleEndian>()?;
+        let sub_type = reader.read_u32::<LittleEndian>()?;
+
+        let this = match sub_type {
+            0x2F => Self::Subtype2F,
+            _ => Self::Unknown { sub_type, payload },
+        };
+        Ok(this)
+    }
+}

src/models/data/packet.rs

@@ -0,0 +1,32 @@
+use std::io::Read;
+
+use byteorder::{LittleEndian, ReadBytesExt};
+use serde::Serialize;
+
+use crate::models::data::payload::Payload;
+use crate::result::Result;
+
+#[derive(Debug, Serialize)]
+pub struct Packet {
+    pub clock: f32,
+    pub payload: Payload,
+}
+
+impl Packet {
+    pub fn from_reader(reader: &mut impl Read) -> Result<Option<Self>> {
+        let Ok(length) = reader.read_u32::<LittleEndian>() else { return Ok(None) };
+        let type_ = reader.read_u32::<LittleEndian>()?;
+        let clock = reader.read_f32::<LittleEndian>()?;
+        let payload = Self::read_payload(reader, length as usize)?;
+        let payload = Payload::new(type_, payload)?;
+        let this = Self { clock, payload };
+        Ok(Some(this))
+    }
+
+    fn read_payload(reader: &mut impl Read, length: usize) -> Result<Vec<u8>> {
+        let mut buffer = Vec::new();
+        buffer.resize(length, 0);
+        reader.read_exact(&mut buffer)?;
+        Ok(buffer)
+    }
+}

src/models/data/payload.rs

@@ -0,0 +1,51 @@
+use std::io::Read;
+
+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::result::Result;
+
+#[serde_as]
+#[derive(Debug, Serialize)]
+pub enum Payload {
+    ReplayHeader(ReplayHeader),
+    EntityMethod(EntityMethod),
+
+    /// Default payload when type is not known.
+    Unknown(#[serde_as(as = "serde_with::hex::Hex")] Vec<u8>),
+}
+
+impl Payload {
+    pub fn new(type_: u32, payload: Vec<u8>) -> Result<Self> {
+        let this = match type_ {
+            0 => {
+                let mut reader = payload.as_slice();
+                reader.read_exact(&mut [0; 10])?;
+
+                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)?
+                };
+                Self::ReplayHeader(ReplayHeader {
+                    summary,
+                    author_nickname,
+                    arena_unique_id,
+                    arena_type_id,
+                })
+            }
+
+            8 => Self::EntityMethod(EntityMethod::new(payload)?),
+
+            _ => Self::Unknown(payload),
+        };
+        Ok(this)
+    }
+}

src/models/data/replay_header.rs

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,27 @@
+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,8 +1,9 @@
+#![cfg(feature = "meta")]
+
 use std::io::Read;
 
 use serde::Deserialize;
 
-use crate::error::Error;
 use crate::result::Result;
 
 /// The model for `meta.json`.
@@ -23,6 +24,6 @@ pub struct Meta {
 
 impl Meta {
     pub fn from_reader(reader: impl Read) -> Result<Self> {
-        serde_json::from_reader(reader).map_err(Error::JsonDecodeFailed)
+        Ok(serde_json::from_reader(reader)?)
     }
 }

src/prelude.rs

@@ -1,2 +0,0 @@
-pub use crate::models::*;
-pub use crate::replay::Replay;

src/replay.rs

@@ -2,8 +2,11 @@ use std::io::{Read, Seek};
 
 use zip::ZipArchive;
 
-use crate::error::Error;
+use crate::models::battle_results::BattleResults;
-use crate::models::{BattleResults, BattleResultsDat, Meta};
+use crate::models::battle_results_dat::BattleResultsDat;
+use crate::models::data::Data;
+#[cfg(feature = "meta")]
+use crate::models::meta::Meta;
 use crate::result::Result;
 
 /// Opened (but not yet parsed) replay.
@@ -12,9 +15,7 @@ pub struct Replay<R>(pub(crate) ZipArchive<R>);
 impl<R: Read + Seek> Replay<R> {
     /// Opens a replay from the reader which contains a `*.wotbreplay`.
     pub fn open(reader: R) -> Result<Self> {
-        ZipArchive::new(reader)
+        Ok(Self(ZipArchive::new(reader)?))
-            .map_err(Error::OpenArchiveFailed)
-            .map(Self)
     }
 
     /// Reads and parses the battle results from the replay.
@@ -24,18 +25,16 @@ impl<R: Read + Seek> Replay<R> {
 
     /// Reads and parses the included `battle_results.dat`.
     pub fn read_battle_results_dat(&mut self) -> Result<BattleResultsDat> {
-        let pickled_battle_results = self
+        let pickled_battle_results = self.0.by_name("battle_results.dat")?;
-            .0
-            .by_name("battle_results.dat")
-            .map_err(Error::OpenEntryFailed)?;
         BattleResultsDat::from_reader(pickled_battle_results)
     }
 
+    #[cfg(feature = "meta")]
     pub fn read_meta(&mut self) -> Result<Meta> {
-        Meta::from_reader(
+        Meta::from_reader(self.0.by_name("meta.json")?)
-            self.0
+    }
-                .by_name("meta.json")
+
-                .map_err(Error::OpenEntryFailed)?,
+    pub fn read_data(&mut self) -> Result<Data> {
-        )
+        Data::from_reader(self.0.by_name("data.wotreplay")?)
     }
 }

tests/battle_results.rs

@@ -1,7 +1,8 @@
 use std::fs::File;
 
 use anyhow::Result;
-use wotbreplay_parser::prelude::*;
+use wotbreplay_parser::models::battle_results::BattleResults;
+use wotbreplay_parser::replay::Replay;
 
 #[test]
 fn player_results_ok() -> Result<()> {
@@ -10,6 +11,9 @@ 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.author.team_number, 2);
+
     let snak_the_ripper_info = &battle_results.player_results[3].info;
     assert_eq!(snak_the_ripper_info.base_xp, 929);
     assert_eq!(snak_the_ripper_info.damage_dealt, 2584);
@@ -108,16 +112,6 @@ fn victory_points_ok() -> Result<()> {
     Ok(())
 }
 
-#[test]
-fn winning_team_ok() -> Result<()> {
-    let battle_results = Replay::open(File::open("tests/replays/winning_team.wotbreplay")?)?
-        .read_battle_results()?;
-
-    assert_eq!(battle_results.winning_team(), TeamNumber::One);
-
-    Ok(())
-}
-
 #[test]
 fn author_results_ok() -> Result<()> {
     let battle_results = Replay::open(File::open("tests/replays/author_results.wotbreplay")?)?

tests/data.rs

@@ -0,0 +1,26 @@
+use std::fs::File;
+
+use anyhow::Result;
+use wotbreplay_parser::replay::Replay;
+
+#[test]
+fn data_ok() -> Result<()> {
+    let mut replay = Replay::open(File::open("tests/replays/player_results.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]);
+
+    Ok(())
+}

tests/meta.rs

@@ -1,7 +1,9 @@
+#![cfg(feature = "meta")]
+
 use std::fs::File;
 
 use anyhow::Result;
-use wotbreplay_parser::prelude::*;
+use wotbreplay_parser::replay::Replay;
 
 #[test]
 fn meta_ok() -> Result<()> {