mod.rs

// Code for searching battle logs.

use crate::directory::LogParser;

// Adapted from https://github.com/AnnikaCodes/battlesearch/blob/main/src/search.rs
use crate::{id::to_id, BattleToolsError};
use std::path::Path;

pub struct BattleSearcher {
    pub user_id: String,
    pub wins_only: bool,
    pub forfeits_only: bool,
}

impl BattleSearcher {
    pub fn new(username: &str, wins_only: bool, forfeits_only: bool) -> Self {
        Self {
            user_id: to_id(username),
            wins_only,
            forfeits_only,
        }
    }
}

impl LogParser<()> for BattleSearcher {
    fn fast_handle_log_file(&self, path: &Path) -> Option<()> {
        use std::io::Read;
        // We expect the p1, p2 fields to be very early in the file and to almost never match
        // self.user_id. So, we can do a very cheap pass to reject most cases.
        // We turn errors into None to avoid duplicating error handling, and it's fine perf-wise
        // because these errors won't be common.
        let mut buf = [0u8; 256];
        let mut f = std::fs::File::open(path).ok()?;
        f.read_exact(&mut buf).ok()?;
        // bump ptr back until ascii
        let end_idx = buf.iter().rposition(|b| b.is_ascii())?;
        let file_snippet = std::str::from_utf8(&buf[..end_idx]).ok()?;
        // Assumes minified JSON, and p1team appearing after p1, p2
        let last_field_sep = file_snippet.rfind(",\"p1team\"")?;
        buf[last_field_sep] = b'}';
        let raw_json = std::str::from_utf8(&buf[..last_field_sep + 1]).ok()?;
        // now we have valid JSON that probably contains p1, p2.
        // Let's check 'em!
        let p1id = to_id(gjson::get(raw_json, "p1").str());
        let p2id = to_id(gjson::get(raw_json, "p2").str());
        if p1id != self.user_id && p2id != self.user_id {
            // Searched user is not a player in the battle.
            return Some(());
        }
        None
    }

    fn handle_log_file(&self, raw_json: String, path: &Path) -> Result<(), BattleToolsError> {
        let date = match path.parent() {
            Some(p) => p
                .file_name()
                .ok_or_else(|| {
                    BattleToolsError::PathConversion(format!(
                        "Can't get parent file name for {:?}",
                        path
                    ))
                })?
                .to_str()
                .ok_or_else(|| {
                    BattleToolsError::PathConversion(format!(
                        "Can't stringify parent for {:?}",
                        path
                    ))
                })?,
            None => "unknown date",
        };

        // parse players
        let p1id = to_id(gjson::get(&raw_json, "p1").str());
        let p2id = to_id(gjson::get(&raw_json, "p2").str());
        if p1id != self.user_id && p2id != self.user_id {
            // Searched user is not a player in the battle.
            return Ok(());
        }

        // parse winner
        let winner_id = to_id(gjson::get(&raw_json, "winner").str());
        if self.wins_only && winner_id != self.user_id {
            return Ok(());
        }

        // parse endType
        let is_forfeit = gjson::get(&raw_json, "endType").str() == "forfeit";
        if !is_forfeit && self.forfeits_only {
            return Ok(());
        }

        // formatting
        let win_type_str = if is_forfeit { "by forfeit" } else { "normally" };
        let win_str = if winner_id.is_empty() {
            String::from("there was no winner")
        } else {
            format!("{} won {}", winner_id, win_type_str)
        };

        let room = path
            .file_name()
            .ok_or_else(|| {
                BattleToolsError::PathConversion(format!("Can't get file name of {:?}", path))
            })?
            .to_str()
            .ok_or_else(|| {
                BattleToolsError::PathConversion(format!(
                    "Can't convert file name to &str for {:?}",
                    path
                ))
            })?
            .replace(".log.json", "");

        println!(
            "({}) <<{}>> {} vs. {} ({})",
            date, room, p1id, p2id, win_str
        );

        Ok(())
    }

    fn handle_results(&mut self, _results: Vec<()>) -> Result<(), BattleToolsError> {
        Ok(())
    }
}

#[cfg(test)]
mod unit_tests {
    extern crate test;
    use super::*;
    use crate::directory::ParallelDirectoryParser;
    use lazy_static::lazy_static;
    use test::Bencher;
    use tests::*;

    lazy_static! {
        static ref SAMPLE_JSON: String = String::from(
            r#"{"winner":"Annika","seed":[1,1,1,1],"turns":2,"p1":"Annika","p2":"Rust Haters","p1team":[{"name":"Rotom","species":"Rotom-Fan","gender":"N","shiny":false,"gigantamax":false,"level":84,"moves":["airslash","voltswitch","willowisp","thunderbolt"],"ability":"Levitate","evs":{"hp":85,"atk":0,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":0,"def":31,"spa":31,"spd":31,"spe":31},"item":"Heavy-Duty Boots"},{"name":"Regirock","species":"Regirock","gender":"N","shiny":false,"gigantamax":false,"level":85,"moves":["curse","rockslide","rest","bodypress"],"ability":"Sturdy","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Chesto Berry"},{"name":"Conkeldurr","species":"Conkeldurr","gender":"","shiny":false,"gigantamax":false,"level":80,"moves":["facade","knockoff","machpunch","drainpunch"],"ability":"Guts","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Flame Orb"},{"name":"Reuniclus","species":"Reuniclus","gender":"","shiny":false,"gigantamax":false,"level":84,"moves":["trickroom","focusblast","psychic","shadowball"],"ability":"Magic Guard","evs":{"hp":85,"atk":0,"def":85,"spa":85,"spd":85,"spe":0},"ivs":{"hp":31,"atk":0,"def":31,"spa":31,"spd":31,"spe":0},"item":"Life Orb"},{"name":"Incineroar","species":"Incineroar","gender":"","shiny":false,"gigantamax":false,"level":80,"moves":["knockoff","uturn","earthquake","flareblitz"],"ability":"Intimidate","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Choice Scarf"},{"name":"Miltank","species":"Miltank","gender":"F","shiny":false,"gigantamax":false,"level":84,"moves":["healbell","bodyslam","earthquake","milkdrink"],"ability":"Sap Sipper","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Leftovers"}],"p2team":[{"name":"Drednaw","species":"Drednaw","gender":"","shiny":false,"gigantamax":false,"level":84,"moves":["stoneedge","swordsdance","superpower","liquidation"],"ability":"Swift Swim","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Life Orb"},{"name":"Pinsir","species":"Pinsir","gender":"","shiny":false,"gigantamax":false,"level":84,"moves":["closecombat","stoneedge","xscissor","knockoff"],"ability":"Moxie","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Choice Scarf"},{"name":"Pikachu","species":"Pikachu-Sinnoh","gender":"","shiny":false,"gigantamax":false,"level":92,"moves":["knockoff","volttackle","voltswitch","irontail"],"ability":"Lightning Rod","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Light Ball"},{"name":"Latios","species":"Latios","gender":"M","shiny":false,"gigantamax":false,"level":78,"moves":["dracometeor","calmmind","psyshock","roost"],"ability":"Levitate","evs":{"hp":85,"atk":0,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":0,"def":31,"spa":31,"spd":31,"spe":31},"item":"Soul Dew"},{"name":"Entei","species":"Entei","gender":"N","shiny":false,"gigantamax":false,"level":78,"moves":["flareblitz","stoneedge","extremespeed","sacredfire"],"ability":"Inner Focus","evs":{"hp":85,"atk":85,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":31,"def":31,"spa":31,"spd":31,"spe":31},"item":"Choice Band"},{"name":"Exeggutor","species":"Exeggutor-Alola","gender":"","shiny":false,"gigantamax":false,"level":86,"moves":["gigadrain","flamethrower","dracometeor","leafstorm"],"ability":"Frisk","evs":{"hp":85,"atk":0,"def":85,"spa":85,"spd":85,"spe":85},"ivs":{"hp":31,"atk":0,"def":31,"spa":31,"spd":31,"spe":31},"item":"Choice Specs"}],"score":[0,2],"inputLog":[">lol you thought i'd leak someone's real input log"],"log":["|j|☆Annika","|j|☆Rust Hater","|player|p1|Annika|cynthia|1400","|player|p2|Rust Hater|cynthia|1100","|teamsize|p1|6","|teamsize|p2|6","|gametype|singles","|gen|8","|tier|[Gen 8] Random Battle","|rated|"],"p1rating":{"entryid":"75790599","userid":"annika","w":"4","l":4,"t":"0","gxe":46.8,"r":1516.9377700433,"rd":121.36211247153,"rptime":1632906000,"rpr":1474.7452159936,"rprd":115.09180605287,"elo":1400.4859871929,"col1":8,"oldelo":"1057.7590112468"},"p2rating":{"entryid":"75790599","userid":"rusthater","w":"4","l":5,"t":"0","gxe":41.8,"r":"1516.9377700433","rd":"121.36211247153","rptime":"1632906000","rpr":1434.9434039083,"rprd":109.84367373045,"elo":1130.7522733629,"col1":9,"oldelo":"1040.4859871929"},"endType":"normal","timestamp":"Wed Nov 1 1970 00:00:01 GMT-0400 (Eastern Daylight Time)","roomid":"battle-gen8randombattle-1","format":"gen8randombattle", "comment": "if you're curious - this is my own rating info & teams from my battles - no violation of privacy here!"}"#
        );
        static ref PATH: &'static std::path::Path = std::path::Path::new("lol/lmao");
    }

    #[bench]
    pub fn bench_parse_wins_only(b: &mut Bencher) {
        let searcher = BattleSearcher::new("Rusthaters", true, false);
        b.iter(|| {
            searcher
                .handle_log_file(SAMPLE_JSON.clone(), &PATH)
                .unwrap()
        });
    }

    #[bench]
    pub fn bench_parse_forfeits_only(b: &mut Bencher) {
        let searcher = BattleSearcher::new("Rusthaters", false, true);
        b.iter(|| {
            searcher
                .handle_log_file(SAMPLE_JSON.clone(), &PATH)
                .unwrap()
        });
    }

    #[bench]
    pub fn bench_parse_forfeit_wins_only(b: &mut Bencher) {
        let searcher = BattleSearcher::new("Rusthaters", true, true);
        b.iter(|| {
            searcher
                .handle_log_file(SAMPLE_JSON.clone(), &PATH)
                .unwrap()
        });
    }

    #[bench]
    pub fn bench_parse(b: &mut Bencher) {
        let searcher = BattleSearcher::new("Rusthaters", false, false);
        b.iter(|| {
            searcher
                .handle_log_file(SAMPLE_JSON.clone(), &PATH)
                .unwrap()
        });
    }

    #[bench]
    fn bench_handle_directory_1k(b: &mut Bencher) {
        build_test_dir(1_000).unwrap();

        let mut searcher = BattleSearcher::new("Rusthaters", false, false);
        b.iter(|| {
            searcher
                .handle_directories(vec![TEST_ROOT_DIR.clone()], None)
                .unwrap()
        });
    }

    #[bench]
    fn bench_handle_directory_1k_absent(b: &mut Bencher) {
        build_test_dir(1_000).unwrap();

        let mut searcher = BattleSearcher::new("Nobody", false, false);
        b.iter(|| {
            searcher
                .handle_directories(vec![TEST_ROOT_DIR.clone()], None)
                .unwrap()
        });
    }
}