♻️ Introduce TankId new-type

Author: eigenein

.idea/runConfigurations/Check.xml

@@ -7,10 +7,7 @@ use mongodb::{
 };
 use uuid::Uuid;
 
-use crate::{
-    models::{AccountId, User},
-    prelude::*,
-};
+use crate::{models::User, prelude::*};
 
 /// Wrapper around the tree to manage client-side sessions.
 #[derive(Clone)]
@@ -43,6 +40,8 @@ impl Sessions {
     pub async fn insert_test_session(&self) -> Result<Uuid> {
         use chrono::Duration;
 
+        use crate::models::AccountId;
+
         let session_id = Uuid::new_v4();
         self.insert(&User {
             session_id,
@@ -73,7 +72,7 @@ mod tests {
     use chrono::Duration;
 
     use super::*;
-    use crate::db::Db;
+    use crate::{db::Db, models::AccountId};
 
     #[tokio::test]
     #[ignore]

src/db/sessions.rs

@@ -7,7 +7,7 @@ use mongodb::{
 };
 
 use crate::{
-    models::{AccountId, Vote, VoteId},
+    models::{AccountId, TankId, Vote, VoteId},
     prelude::*,
     tankopedia::vendored::TANKOPEDIA,
 };
@@ -22,7 +22,7 @@ impl Votes {
         Ok(Self(collection))
     }
 
-    #[instrument(skip_all, fields(account_id = %vote.id.account_id, tank_id = vote.id.tank_id))]
+    #[instrument(skip_all, fields(account_id = %vote.id.account_id, tank_id = %vote.id.tank_id))]
     pub async fn insert(&self, vote: &Vote) -> Result {
         let options = UpdateOptions::builder().upsert(true).build();
         self.0
@@ -38,8 +38,8 @@ impl Votes {
         Ok(())
     }
 
-    #[instrument(skip_all, fields(account_id = %account_id, tank_id = tank_id))]
-    pub async fn delete(&self, account_id: AccountId, tank_id: u16) -> Result {
+    #[instrument(skip_all, fields(account_id = %account_id, tank_id = %tank_id))]
+    pub async fn delete(&self, account_id: AccountId, tank_id: TankId) -> Result {
         let vote_id = VoteId { account_id, tank_id };
         self.0
             .delete_one(doc! { "_id": to_document(&vote_id)? }, None)
@@ -81,7 +81,7 @@ mod tests {
     #[ignore]
     async fn get_all_by_account_id_ok() -> Result {
         let manager = Db::open_unittests().await?.votes().await?;
-        let mut vote = Vote::new(1, 42, Rating::Like);
+        let mut vote = Vote::new(1, TankId(42), Rating::Like);
         vote.timestamp = vote.timestamp.duration_round(Duration::seconds(1))?;
         manager.insert(&vote).await?;
 
@@ -117,9 +117,9 @@ mod tests {
     #[ignore]
     async fn delete_vote_ok() -> Result {
         let manager = Db::open_unittests().await?.votes().await?;
-        let vote = Vote::new(1, 42, Rating::Like);
+        let vote = Vote::new(1, TankId(42), Rating::Like);
         manager.insert(&vote).await?;
-        manager.delete(vote.id.account_id, 42).await?;
+        manager.delete(vote.id.account_id, vote.id.tank_id).await?;
         assert!(
             manager
                 .iter_by_account_id(vote.id.account_id)

src/db/votes.rs

@@ -1,6 +1,7 @@
 mod account_id;
 mod rated_tank_id;
 mod rating;
+mod tank_id;
 mod user;
 mod vehicle;
 mod vote;
@@ -9,6 +10,7 @@ pub use self::{
     account_id::AccountId,
     rated_tank_id::RatedTankId,
     rating::Rating,
+    tank_id::TankId,
     user::{Anonymous, User},
     vehicle::{Vehicle, VehicleAvailability, VehicleType},
     vote::{Vote, VoteId},

src/models.rs

@@ -2,14 +2,16 @@ use std::cmp::Ordering;
 
 use serde::{Deserialize, Serialize};
 
+use crate::models::TankId;
+
 /// Pair of tank ID and its rating.
 ///
 /// # Notes
 ///
 /// - Natural sorting order is of decreasing rating.
 /// - I also use it for tank ID & similarity pair.
 #[derive(Serialize, Deserialize)]
-pub struct RatedTankId(pub u16, pub f64);
+pub struct RatedTankId(pub TankId, pub f64);
 
 impl Eq for RatedTankId {}
 

src/models/rated_tank_id.rs

@@ -0,0 +1,26 @@
+use mongodb::bson::Bson;
+
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Eq,
+    Hash,
+    Ord,
+    PartialEq,
+    PartialOrd,
+    derive_more::Display,
+    derive_more::From,
+    derive_more::FromStr,
+    derive_more::Into,
+    serde::Deserialize,
+    serde::Serialize,
+)]
+pub struct TankId(pub u16); // FIXME
+
+impl From<TankId> for Bson {
+    #[inline]
+    fn from(tank_id: TankId) -> Self {
+        Bson::from(tank_id.0 as i32)
+    }
+}

src/models/tank_id.rs

@@ -1,5 +1,7 @@
+use crate::models::TankId;
+
 pub struct Vehicle {
-    pub tank_id: u16,
+    pub tank_id: TankId,
     pub name: &'static str,
     pub tier: u8,
     pub type_: VehicleType,

src/models/vehicle.rs

@@ -3,7 +3,7 @@ use mongodb::bson::serde_helpers;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    models::{rating::Rating, AccountId},
+    models::{rating::Rating, AccountId, TankId},
     prelude::*,
 };
 
@@ -13,7 +13,7 @@ pub struct VoteId {
     pub account_id: AccountId,
 
     #[serde(rename = "tid")]
-    pub tank_id: u16,
+    pub tank_id: TankId,
 }
 
 #[derive(Serialize, Deserialize, Debug, Eq, PartialEq)]
@@ -36,7 +36,7 @@ pub struct Vote {
 }
 
 impl Vote {
-    pub fn new(account_id: impl Into<AccountId>, tank_id: u16, rating: Rating) -> Self {
+    pub fn new(account_id: impl Into<AccountId>, tank_id: TankId, rating: Rating) -> Self {
         Self {
             id: VoteId {
                 account_id: account_id.into(),

src/models/vote.rs

@@ -87,7 +87,7 @@ impl BundleTankopedia {
         writeln!(&mut module)?;
         writeln!(
             &mut module,
-            "use crate::models::{{Vehicle, VehicleAvailability::*, VehicleType::*}};"
+            "use crate::models::{{TankId, Vehicle, VehicleAvailability::*, VehicleType::*}};"
         )?;
         writeln!(&mut module)?;
         writeln!(&mut module, "pub static TANKOPEDIA: Map<u16, Vehicle> = phf_map! {{")?;
@@ -103,7 +103,7 @@ impl BundleTankopedia {
                 .unwrap_or(&json_details.user_string);
 
             writeln!(&mut module, "    {}_u16 => Vehicle {{", json_details.tank_id)?;
-            writeln!(&mut module, "        tank_id: {:?},", json_details.tank_id)?;
+            writeln!(&mut module, "        tank_id: TankId({:?}),", json_details.tank_id)?;
             writeln!(&mut module, "        name: {:?},", name)?;
             writeln!(&mut module, "        tier: {:?},", json_details.tier)?;
             writeln!(&mut module, "        type_: {:?},", json_details.type_)?;