Break: make meta optional

.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,12 +12,14 @@ categories = ["parsing"]
 
 [features]
 default = []
+meta = ["dep:serde_json"]
 
 [dependencies]
 prost = "0.11.3"
 serde = { version = "1.0.148", features = ["derive"] }
 serde_bytes = "0.11.7"
 serde-pickle = "1.1.1"
+serde_json = { version = "1.0.96", optional = true }
 thiserror = "1.0.37"
 zip = { version = "0.6.3", default-features = false, features = ["deflate"] }
 

src/error.rs

@@ -2,18 +2,19 @@ use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum Error {
-    #[error("failed to open the ZIP-archive")]
+    #[error("failed to open the replay as a ZIP-archive")]
     OpenArchiveFailed(#[source] zip::result::ZipError),
 
-    #[error("failed to open the battle results entry in the replay archive")]
+    #[error("failed to open the entry in the replay archive")]
-    OpenBattleResultsFailed(#[source] zip::result::ZipError),
+    OpenEntryFailed(#[source] zip::result::ZipError),
 
-    #[error("failed to read the archive entry")]
+    #[error("failed to decode the Protocol Buffers encoded data")]
-    ReadEntryFailed(#[source] std::io::Error),
-
-    #[error("failed to decode")]
     DecodeFailed(#[source] prost::DecodeError),
 
     #[error("failed to un-pickle")]
     UnpickleFailed(#[source] serde_pickle::Error),
+
+    #[cfg(feature = "meta")]
+    #[error("failed to decode JSON")]
+    JsonDecodeFailed(#[source] serde_json::Error),
 }

src/lib.rs

@@ -17,6 +17,9 @@ pub mod prelude;
 mod replay;
 mod result;
 
+pub use self::error::Error;
+pub use self::result::Result;
+
 #[cfg(doctest)]
 mod test_readme {
     macro_rules! external_doc_test {

src/models.rs

@@ -1,5 +1,8 @@
 mod battle_results;
 mod battle_results_dat;
+mod meta;
 
 pub use self::battle_results::*;
 pub use self::battle_results_dat::*;
+#[cfg(feature = "meta")]
+pub use self::meta::*;

src/models/battle_results.rs

@@ -15,6 +15,8 @@ impl BattleResults {
 }
 
 /// Parsed battle results.
+///
+/// TODO: 150[0].21[0].8[0].801[0].unsigned is arena end time.
 #[derive(Message, Serialize)]
 pub struct BattleResults {
     /// Battle timestamp.

src/models/battle_results_dat.rs

@@ -10,31 +10,38 @@ use crate::result::Result;
 
 /// Represents un-pickled `battle_results.dat`.
 #[derive(Debug, Deserialize)]
-pub struct BattleResultsDat(
+#[serde(from = "(u64, ByteBuf)")]
-    /// No idea what this is.
+pub struct BattleResultsDat {
-    /// My best guess – some kind of checksum,
+    pub arena_unique_id: u64,
-    /// but none of MD5, SHA1, SHA224, SHA256, SHA384, SHA512, nor CRC64 over the buffer have matched.
+
-    pub u64,
     /// Protobuf-serialized battle results.
-    pub ByteBuf,
+    pub buffer: ByteBuf,
-);
+}
+
+impl From<(u64, ByteBuf)> for BattleResultsDat {
+    fn from((arena_unique_id, buffer): (u64, ByteBuf)) -> Self {
+        Self {
+            arena_unique_id,
+            buffer,
+        }
+    }
+}
 
 impl BattleResultsDat {
     /// Parses the pickled structure from the reader which contains `battle_results.dat`.
+    ///
+    /// 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)
     }
-
-    /// Decodes the battle results from the internal buffer.
-    pub fn decode_battle_results(&self) -> Result<BattleResults> {
-        BattleResults::decode(self.1.as_ref()).map_err(Error::DecodeFailed)
-    }
 }
 
 impl TryInto<BattleResults> for BattleResultsDat {
     type Error = Error;
 
+    /// Decodes the battle results from the internal buffer.
     fn try_into(self) -> Result<BattleResults> {
-        self.decode_battle_results()
+        BattleResults::decode(self.buffer.as_ref()).map_err(Error::DecodeFailed)
     }
 }

src/models/meta.rs

@@ -0,0 +1,30 @@
+#![cfg(feature = "meta")]
+
+use std::io::Read;
+
+use serde::Deserialize;
+
+use crate::error::Error;
+use crate::result::Result;
+
+/// The model for `meta.json`.
+#[derive(Deserialize)]
+pub struct Meta {
+    #[serde(rename = "playerName")]
+    pub player_name: String,
+
+    #[serde(rename = "arenaUniqueId")]
+    pub arena_unique_id: String,
+
+    #[serde(rename = "battleDuration")]
+    pub battle_duration_secs: f64,
+
+    #[serde(rename = "vehicleCompDescriptor")]
+    pub tank_id: u16,
+}
+
+impl Meta {
+    pub fn from_reader(reader: impl Read) -> Result<Self> {
+        serde_json::from_reader(reader).map_err(Error::JsonDecodeFailed)
+    }
+}

src/prelude.rs

@@ -1,4 +1,2 @@
-pub use crate::error::Error;
 pub use crate::models::*;
 pub use crate::replay::Replay;
-pub use crate::result::Result;

src/replay.rs

@@ -3,6 +3,8 @@ use std::io::{Read, Seek};
 use zip::ZipArchive;
 
 use crate::error::Error;
+#[cfg(feature = "meta")]
+use crate::models::Meta;
 use crate::models::{BattleResults, BattleResultsDat};
 use crate::result::Result;
 
@@ -19,7 +21,7 @@ impl<R: Read + Seek> Replay<R> {
 
     /// Reads and parses the battle results from the replay.
     pub fn read_battle_results(&mut self) -> Result<BattleResults> {
-        self.read_battle_results_dat()?.decode_battle_results()
+        self.read_battle_results_dat()?.try_into()
     }
 
     /// Reads and parses the included `battle_results.dat`.
@@ -27,7 +29,16 @@ impl<R: Read + Seek> Replay<R> {
         let pickled_battle_results = self
             .0
             .by_name("battle_results.dat")
-            .map_err(Error::OpenBattleResultsFailed)?;
+            .map_err(Error::OpenEntryFailed)?;
         BattleResultsDat::from_reader(pickled_battle_results)
     }
+
+    #[cfg(feature = "meta")]
+    pub fn read_meta(&mut self) -> Result<Meta> {
+        Meta::from_reader(
+            self.0
+                .by_name("meta.json")
+                .map_err(Error::OpenEntryFailed)?,
+        )
+    }
 }

tests/battle_results.rs

@@ -5,8 +5,10 @@ use wotbreplay_parser::prelude::*;
 
 #[test]
 fn player_results_ok() -> Result<()> {
-    let battle_results = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
+    let battle_results_dat = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
-        .read_battle_results()?;
+        .read_battle_results_dat()?;
+    assert_eq!(battle_results_dat.arena_unique_id, 1661909200500084);
+    let battle_results: BattleResults = battle_results_dat.try_into()?;
 
     let snak_the_ripper_info = &battle_results.player_results[3].info;
     assert_eq!(snak_the_ripper_info.base_xp, 929);

tests/meta.rs

@@ -0,0 +1,18 @@
+#![cfg(feature = "meta")]
+
+use std::fs::File;
+
+use anyhow::Result;
+use wotbreplay_parser::prelude::*;
+
+#[test]
+fn meta_ok() -> Result<()> {
+    let meta = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?.read_meta()?;
+
+    assert_eq!(meta.player_name, "zeekrab");
+    assert_eq!(meta.arena_unique_id, "1661909200500084");
+    assert_eq!(meta.battle_duration_secs, 164.08485);
+    assert_eq!(meta.tank_id, 26657);
+
+    Ok(())
+}