feat: use legacy mod order on stable data (#1041)

MaxOhn · web-flow · commit df36be221046 · 2025-05-29T10:38:36.000+02:00
* refactor: remove redundant type

* feat: use legacy mod order on stable data
diff --git a/bathbot-util/src/mods_fmt.rs b/bathbot-util/src/mods_fmt.rs
@@ -11,20 +11,15 @@ use rosu_v2::model::mods::{
 
 pub struct ModsFormatter<'a> {
     mods: &'a GameMods,
+    legacy_order: bool,
 }
 
 impl<'a> ModsFormatter<'a> {
-    pub fn new(mods: &'a GameMods) -> Self {
-        Self { mods }
+    pub fn new(mods: &'a GameMods, legacy_order: bool) -> Self {
+        Self { mods, legacy_order }
     }
-}
-
-impl Display for ModsFormatter<'_> {
-    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
-        if self.mods.is_empty() {
-            return f.write_str("NM");
-        }
 
+    fn format_mods(&self, f: &mut Formatter<'_>) -> FmtResult {
         for gamemod in self.mods.iter() {
             f.write_str(gamemod.acronym().as_str())?;
 
@@ -49,16 +44,35 @@ impl Display for ModsFormatter<'_> {
                         write!(f, "({}x)", (*speed_change * 100.0).round() / 100.0)?
                     }
                 }
-
-                GameMod::DifficultyAdjustOsu(_)
-                | GameMod::DifficultyAdjustTaiko(_)
-                | GameMod::DifficultyAdjustCatch(_)
-                | GameMod::DifficultyAdjustMania(_) => {} // TODO: print something?
-
                 _ => {}
             }
         }
 
         Ok(())
     }
+
+    fn legacacy_format_mods(&self, f: &mut Formatter<'_>) -> FmtResult {
+        let mut mods: Vec<_> = self.mods.iter().collect();
+        mods.sort_unstable_by_key(|m| m.bits());
+
+        for m in mods {
+            f.write_str(m.acronym().as_str())?
+        }
+
+        Ok(())
+    }
+}
+
+impl Display for ModsFormatter<'_> {
+    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
+        if self.mods.is_empty() {
+            return f.write_str("NM");
+        }
+
+        if self.legacy_order {
+            self.legacacy_format_mods(f)
+        } else {
+            self.format_mods(f)
+        }
+    }
 }
diff --git a/bathbot/src/active/impls/compare/scores.rs b/bathbot/src/active/impls/compare/scores.rs
@@ -189,7 +189,7 @@ fn write_compact_entry(
             Some(entry.score.score_id),
             entry.score.is_legacy()
         ),
-        mods = ModsFormatter::new(&entry.score.mods),
+        mods = ModsFormatter::new(&entry.score.mods, entry.score.is_legacy),
         stars = entry.stars,
         pp_format = if pp_idx == Some(i) { "**" } else { "~~" },
         pp = entry.score.pp,
diff --git a/bathbot/src/active/impls/higherlower/score_pp.rs b/bathbot/src/active/impls/higherlower/score_pp.rs
@@ -187,7 +187,7 @@ impl ScorePp {
         format!(
             "**{map} +{mods}**\n{grade} {score} • **{acc}%** • **{combo}x**{max_combo} {miss}• **{pp}pp**",
             map = self.map_string,
-            mods = ModsFormatter::new(&self.mods),
+            mods = ModsFormatter::new(&self.mods, false),
             // No `GradeFormatter` here because we don't want to hyperlink to
             // the score for obvious reasons.
             grade = grade_emote(self.grade),
diff --git a/bathbot/src/active/impls/leaderboard.rs b/bathbot/src/active/impls/leaderboard.rs
@@ -247,7 +247,7 @@ impl Display for ScoreFormatter<'_> {
             ),
             score = WithComma::new(score),
             combo = self.combo,
-            mods = ModsFormatter::new(&self.score.mods),
+            mods = ModsFormatter::new(&self.score.mods, self.score_data.is_legacy()),
             pp = self.pp,
             acc = self.score.accuracy,
             miss = MissFormat(self.score.statistics.miss),
diff --git a/bathbot/src/active/impls/nochoke.rs b/bathbot/src/active/impls/nochoke.rs
@@ -82,7 +82,7 @@ impl IActiveMessage for NoChokePagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 id = map.map_id(),
-                mods = ModsFormatter::new(&original_score.mods),
+                mods = ModsFormatter::new(&original_score.mods, original_score.is_legacy),
                 grade = GradeFormatter::new(
                     entry.unchoked_grade(),
                     Some(entry.original_score.score_id),
diff --git a/bathbot/src/active/impls/osustats/best.rs b/bathbot/src/active/impls/osustats/best.rs
@@ -96,7 +96,7 @@ impl IActiveMessage for OsuStatsBestPagination {
                 title = score.map.title,
                 version = score.map.version,
                 map_id = score.map.map_id,
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, true),
                 user = score.user.username,
                 user_id = score.user.user_id,
                 grade = config.grade(score.grade),
diff --git a/bathbot/src/active/impls/osustats/scores.rs b/bathbot/src/active/impls/osustats/scores.rs
@@ -176,7 +176,7 @@ impl IActiveMessage for OsuStatsScoresPagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 map_id = map.map_id(),
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, true),
                 pp = PpFormatter::new(Some(score.pp), Some(*max_pp)),
                 acc = round(score.accuracy),
                 score = WithComma::new(score.score),
diff --git a/bathbot/src/active/impls/relax/top.rs b/bathbot/src/active/impls/relax/top.rs
@@ -122,7 +122,7 @@ impl IActiveMessage for RelaxTopPagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 map_id = score.beatmap_id,
-                mods = ModsFormatter::new(mods),
+                mods = ModsFormatter::new(mods, false),
                 pp = PpFormatter::new(score_pp, Some(max_pp)),
                 acc = round(score.accuracy),
                 score = WithComma::new(score.total_score),
diff --git a/bathbot/src/active/impls/simulate/mod.rs b/bathbot/src/active/impls/simulate/mod.rs
@@ -244,6 +244,10 @@ impl IActiveMessage for SimulateComponents {
                 n_objects,
                 self.map.mode(),
                 n_objects,
+                // Could use `self.data.set_on_lazer` but using the legacy
+                // formatting of mods does not show custom rates & co so it's
+                // probably best to always use the new formatting
+                false,
             );
 
             fields![fields { "Grade", grade.to_string(), true; }];
diff --git a/bathbot/src/active/impls/single_score.rs b/bathbot/src/active/impls/single_score.rs
@@ -635,7 +635,11 @@ fn apply_settings(
                     writer.push_str("__");
                 }
 
-                let _ = write!(writer, "+{}", ModsFormatter::new(&data.score.mods));
+                let _ = write!(
+                    writer,
+                    "+{}",
+                    ModsFormatter::new(&data.score.mods, data.score.is_legacy)
+                );
 
                 if mark_idx == MarkIndex::Some(i) {
                     writer.push_str("__");
@@ -864,7 +868,11 @@ fn apply_settings(
                         writer.push_str("__");
                     }
 
-                    let _ = write!(writer, "+{}", ModsFormatter::new(&data.score.mods));
+                    let _ = write!(
+                        writer,
+                        "+{}",
+                        ModsFormatter::new(&data.score.mods, data.score.is_legacy)
+                    );
 
                     if mark_idx == MarkIndex::Some(last_idx) {
                         writer.push_str("__");
@@ -1012,7 +1020,11 @@ fn write_value(
             }
         }
         Value::Mods => {
-            let _ = write!(writer, "+{}", ModsFormatter::new(&data.score.mods));
+            let _ = write!(
+                writer,
+                "+{}",
+                ModsFormatter::new(&data.score.mods, data.score.is_legacy)
+            );
         }
         Value::Score => {
             let _ = write!(writer, "{}", ScoreFormatter::new(&data.score, score_data));
diff --git a/bathbot/src/active/impls/snipe/difference.rs b/bathbot/src/active/impls/snipe/difference.rs
@@ -7,7 +7,7 @@ use std::{
 use bathbot_macros::PaginationBuilder;
 use bathbot_model::SnipeRecent;
 use bathbot_util::{
-    CowUtils, EmbedBuilder, FooterBuilder, IntHasher, constants::OSU_BASE,
+    CowUtils, EmbedBuilder, FooterBuilder, IntHasher, ModsFormatter, constants::OSU_BASE,
     datetime::HowLongAgoDynamic, numbers::round,
 };
 use eyre::{Result, WrapErr};
@@ -25,7 +25,6 @@ use crate::{
     },
     commands::osu::Difference,
     core::Context,
-    embeds::ModsFormatter,
     manager::redis::osu::CachedUser,
     util::{
         CachedUserExt,
@@ -89,7 +88,7 @@ impl IActiveMessage for SnipeDifferencePagination {
                 title = score.title.cow_escape_markdown(),
                 version = score.version.cow_escape_markdown(),
                 id = score.map_id,
-                mods = ModsFormatter::new(mods.as_ref()),
+                mods = ModsFormatter::new(mods.as_ref(), true),
                 acc = round(score.accuracy),
             );
 
diff --git a/bathbot/src/active/impls/snipe/player_list.rs b/bathbot/src/active/impls/snipe/player_list.rs
@@ -143,7 +143,7 @@ impl IActiveMessage for SnipePlayerListPagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 map_id = score.map_id,
-                mods = ModsFormatter::new(&mods),
+                mods = ModsFormatter::new(&mods, true),
                 pp = PpFormatter::new(score.pp, Some(max_pp)),
                 stars = score.stars,
                 acc = round(score.accuracy),
diff --git a/bathbot/src/active/impls/top.rs b/bathbot/src/active/impls/top.rs
@@ -89,6 +89,7 @@ impl TopPagination {
 
     fn condensed_description(&self, entries: &[ScoreEmbedDataWrap]) -> String {
         let mut description = String::with_capacity(1024);
+        let legacy_mods_order = self.score_data.is_legacy();
 
         for entry in entries {
             let entry = entry.get_half();
@@ -123,7 +124,7 @@ impl TopPagination {
                 },
                 combo = score.max_combo,
                 miss = MissFormat(score.statistics.miss),
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, legacy_mods_order),
                 appendix = OrderAppendix::new(
                     self.sort_by,
                     entry,
@@ -139,6 +140,7 @@ impl TopPagination {
 
     fn condensed_description_mania(&self, entries: &[ScoreEmbedDataWrap]) -> String {
         let mut description = String::with_capacity(1024);
+        let legacy_mods_order = self.score_data.is_legacy();
 
         for entry in entries {
             let entry = entry.get_half();
@@ -177,7 +179,7 @@ impl TopPagination {
                 n320 = stats.perfect,
                 n300 = stats.great,
                 miss = stats.miss,
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, legacy_mods_order),
                 appendix = OrderAppendix::new(
                     self.sort_by,
                     entry,
@@ -195,6 +197,7 @@ impl TopPagination {
         let pages = &self.pages;
         let end_idx = self.entries.len().min(pages.index() + pages.per_page());
         let scores = &self.entries[pages.index()..end_idx];
+        let legacy_mods_order = self.score_data.is_legacy();
 
         let mut description = String::with_capacity(512);
 
@@ -223,7 +226,7 @@ impl TopPagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 id = map.map_id(),
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, legacy_mods_order),
                 grade = GradeFormatter::new(score.grade, Some(score.score_id), score.is_legacy()),
                 pp = PpFormatter::new(Some(score.pp), Some(*max_pp)),
                 acc = if self.sort_by == TopScoreOrder::Acc {
diff --git a/bathbot/src/active/impls/top_if.rs b/bathbot/src/active/impls/top_if.rs
@@ -70,7 +70,7 @@ impl IActiveMessage for TopIfPagination {
                 title = map.title().cow_escape_markdown(),
                 version = map.version().cow_escape_markdown(),
                 id = map.map_id(),
-                mods = ModsFormatter::new(&score.mods),
+                mods = ModsFormatter::new(&score.mods, score.is_legacy),
                 grade =
                     GradeFormatter::new(score.grade, Some(score.score_id), entry.score.is_legacy()),
                 pp = PpFormatter::new(Some(score.pp), Some(*max_pp)),
diff --git a/bathbot/src/embeds/osu/mod.rs b/bathbot/src/embeds/osu/mod.rs
@@ -26,27 +26,6 @@ pub use self::{
     sniped::*, whatif::*,
 };
 
-pub struct ModsFormatter<'m> {
-    mods: &'m GameMods,
-}
-
-impl<'m> ModsFormatter<'m> {
-    pub fn new(mods: &'m GameMods) -> Self {
-        Self { mods }
-    }
-}
-
-impl Display for ModsFormatter<'_> {
-    #[inline]
-    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
-        if self.mods.is_empty() {
-            Ok(())
-        } else {
-            write!(f, "+{}", self.mods)
-        }
-    }
-}
-
 pub struct ComboFormatter {
     score: u32,
     max: Option<u32>,
diff --git a/bathbot/src/util/osu.rs b/bathbot/src/util/osu.rs
@@ -51,6 +51,7 @@ pub struct GradeCompletionFormatter<'a> {
     mode: GameMode,
     n_objects: u32,
     score_id: Option<u64>,
+    legacy_mods_order: bool,
 }
 
 impl<'a> GradeCompletionFormatter<'a> {
@@ -62,6 +63,7 @@ impl<'a> GradeCompletionFormatter<'a> {
             mode,
             n_objects,
             score_id: score.score_id().filter(|_| !score.is_legacy()),
+            legacy_mods_order: score.is_legacy(),
         }
     }
 
@@ -75,6 +77,7 @@ impl<'a> GradeCompletionFormatter<'a> {
         score_hits: u32,
         mode: GameMode,
         n_objects: u32,
+        legacy_mods_order: bool,
     ) -> Self {
         Self {
             mods,
@@ -83,6 +86,7 @@ impl<'a> GradeCompletionFormatter<'a> {
             mode,
             n_objects,
             score_id: None,
+            legacy_mods_order,
         }
     }
 }
@@ -102,7 +106,7 @@ impl Display for GradeCompletionFormatter<'_> {
             score_id: self.score_id,
         };
 
-        let mods_fmt = ModsFormatter::new(self.mods);
+        let mods_fmt = ModsFormatter::new(self.mods, self.legacy_mods_order);
 
         // The completion is very hard to calculate for `Catch` because
         // `n_objects` is not correct due to juicestreams so we won't
