refactor: [#1541] rename methods

Author: josecelano

packages/tracker-core/src/announce_handler.rs

@@ -169,7 +169,7 @@ impl AnnounceHandler {
         // downloads across all torrents. The in-memory metric will count only
         // the number of downloads during the current tracker uptime.
         let opt_persistent_torrent = if self.config.tracker_policy.persistent_torrent_completed_stat {
-            self.db_downloads_metric_repository.load(info_hash)?
+            self.db_downloads_metric_repository.load_torrent_downloads(info_hash)?
         } else {
             None
         };

packages/tracker-core/src/databases/driver/mod.rs

@@ -169,9 +169,9 @@ pub(crate) mod tests {
 
             let number_of_downloads = 1;
 
-            driver.save_persistent_torrent(&infohash, number_of_downloads).unwrap();
+            driver.save_torrent_downloads(&infohash, number_of_downloads).unwrap();
 
-            let number_of_downloads = driver.load_persistent_torrent(&infohash).unwrap().unwrap();
+            let number_of_downloads = driver.load_torrent_downloads(&infohash).unwrap().unwrap();
 
             assert_eq!(number_of_downloads, 1);
         }
@@ -181,9 +181,9 @@ pub(crate) mod tests {
 
             let number_of_downloads = 1;
 
-            driver.save_persistent_torrent(&infohash, number_of_downloads).unwrap();
+            driver.save_torrent_downloads(&infohash, number_of_downloads).unwrap();
 
-            let torrents = driver.load_persistent_torrents().unwrap();
+            let torrents = driver.load_all_torrents_downloads().unwrap();
 
             assert_eq!(torrents.len(), 1);
             assert_eq!(torrents.get(&infohash), Some(number_of_downloads).as_ref());
@@ -194,11 +194,11 @@ pub(crate) mod tests {
 
             let number_of_downloads = 1;
 
-            driver.save_persistent_torrent(&infohash, number_of_downloads).unwrap();
+            driver.save_torrent_downloads(&infohash, number_of_downloads).unwrap();
 
-            driver.increase_number_of_downloads(&infohash).unwrap();
+            driver.increase_downloads_for_torrent(&infohash).unwrap();
 
-            let number_of_downloads = driver.load_persistent_torrent(&infohash).unwrap().unwrap();
+            let number_of_downloads = driver.load_torrent_downloads(&infohash).unwrap().unwrap();
 
             assert_eq!(number_of_downloads, 2);
         }
@@ -208,31 +208,31 @@ pub(crate) mod tests {
         pub fn it_should_save_and_load_the_global_number_of_downloads(driver: &Arc<Box<dyn Database>>) {
             let number_of_downloads = 1;
 
-            driver.save_global_number_of_downloads(number_of_downloads).unwrap();
+            driver.save_global_downloads(number_of_downloads).unwrap();
 
-            let number_of_downloads = driver.load_global_number_of_downloads().unwrap().unwrap();
+            let number_of_downloads = driver.load_global_downloads().unwrap().unwrap();
 
             assert_eq!(number_of_downloads, 1);
         }
 
         pub fn it_should_load_the_global_number_of_downloads(driver: &Arc<Box<dyn Database>>) {
             let number_of_downloads = 1;
 
-            driver.save_global_number_of_downloads(number_of_downloads).unwrap();
+            driver.save_global_downloads(number_of_downloads).unwrap();
 
-            let number_of_downloads = driver.load_global_number_of_downloads().unwrap().unwrap();
+            let number_of_downloads = driver.load_global_downloads().unwrap().unwrap();
 
             assert_eq!(number_of_downloads, 1);
         }
 
         pub fn it_should_increase_the_global_number_of_downloads(driver: &Arc<Box<dyn Database>>) {
             let number_of_downloads = 1;
 
-            driver.save_global_number_of_downloads(number_of_downloads).unwrap();
+            driver.save_global_downloads(number_of_downloads).unwrap();
 
-            driver.increase_global_number_of_downloads().unwrap();
+            driver.increase_global_downloads().unwrap();
 
-            let number_of_downloads = driver.load_global_number_of_downloads().unwrap().unwrap();
+            let number_of_downloads = driver.load_global_downloads().unwrap().unwrap();
 
             assert_eq!(number_of_downloads, 2);
         }

packages/tracker-core/src/databases/driver/mysql.rs

@@ -146,7 +146,7 @@ impl Database for Mysql {
     }
 
     /// Refer to [`databases::Database::load_persistent_torrents`](crate::core::databases::Database::load_persistent_torrents).
-    fn load_persistent_torrents(&self) -> Result<PersistentTorrents, Error> {
+    fn load_all_torrents_downloads(&self) -> Result<PersistentTorrents, Error> {
         let mut conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let torrents = conn.query_map(
@@ -161,7 +161,7 @@ impl Database for Mysql {
     }
 
     /// Refer to [`databases::Database::load_persistent_torrent`](crate::core::databases::Database::load_persistent_torrent).
-    fn load_persistent_torrent(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
+    fn load_torrent_downloads(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
         let mut conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let query = conn.exec_first::<u32, _, _>(
@@ -175,7 +175,7 @@ impl Database for Mysql {
     }
 
     /// Refer to [`databases::Database::save_persistent_torrent`](crate::core::databases::Database::save_persistent_torrent).
-    fn save_persistent_torrent(&self, info_hash: &InfoHash, completed: u32) -> Result<(), Error> {
+    fn save_torrent_downloads(&self, info_hash: &InfoHash, completed: u32) -> Result<(), Error> {
         const COMMAND : &str = "INSERT INTO torrents (info_hash, completed) VALUES (:info_hash_str, :completed) ON DUPLICATE KEY UPDATE completed = VALUES(completed)";
 
         let mut conn = self.pool.get().map_err(|e| (e, DRIVER))?;
@@ -186,7 +186,7 @@ impl Database for Mysql {
     }
 
     /// Refer to [`databases::Database::increase_number_of_downloads`](crate::core::databases::Database::increase_number_of_downloads).
-    fn increase_number_of_downloads(&self, info_hash: &InfoHash) -> Result<(), Error> {
+    fn increase_downloads_for_torrent(&self, info_hash: &InfoHash) -> Result<(), Error> {
         let mut conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let info_hash_str = info_hash.to_string();
@@ -200,17 +200,17 @@ impl Database for Mysql {
     }
 
     /// Refer to [`databases::Database::load_global_number_of_downloads`](crate::core::databases::Database::load_global_number_of_downloads).
-    fn load_global_number_of_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
+    fn load_global_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
         self.load_torrent_aggregate_metric(TORRENTS_DOWNLOADS_TOTAL)
     }
 
     /// Refer to [`databases::Database::save_global_number_of_downloads`](crate::core::databases::Database::save_global_number_of_downloads).
-    fn save_global_number_of_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error> {
+    fn save_global_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error> {
         self.save_torrent_aggregate_metric(TORRENTS_DOWNLOADS_TOTAL, downloaded)
     }
 
     /// Refer to [`databases::Database::increase_global_number_of_downloads`](crate::core::databases::Database::increase_global_number_of_downloads).
-    fn increase_global_number_of_downloads(&self) -> Result<(), Error> {
+    fn increase_global_downloads(&self) -> Result<(), Error> {
         let mut conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let metric_name = TORRENTS_DOWNLOADS_TOTAL;

packages/tracker-core/src/databases/driver/sqlite.rs

@@ -152,7 +152,7 @@ impl Database for Sqlite {
     }
 
     /// Refer to [`databases::Database::load_persistent_torrents`](crate::core::databases::Database::load_persistent_torrents).
-    fn load_persistent_torrents(&self) -> Result<PersistentTorrents, Error> {
+    fn load_all_torrents_downloads(&self) -> Result<PersistentTorrents, Error> {
         let conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let mut stmt = conn.prepare("SELECT info_hash, completed FROM torrents")?;
@@ -168,7 +168,7 @@ impl Database for Sqlite {
     }
 
     /// Refer to [`databases::Database::load_persistent_torrent`](crate::core::databases::Database::load_persistent_torrent).
-    fn load_persistent_torrent(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
+    fn load_torrent_downloads(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
         let conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let mut stmt = conn.prepare("SELECT completed FROM torrents WHERE info_hash = ?")?;
@@ -184,7 +184,7 @@ impl Database for Sqlite {
     }
 
     /// Refer to [`databases::Database::save_persistent_torrent`](crate::core::databases::Database::save_persistent_torrent).
-    fn save_persistent_torrent(&self, info_hash: &InfoHash, completed: u32) -> Result<(), Error> {
+    fn save_torrent_downloads(&self, info_hash: &InfoHash, completed: u32) -> Result<(), Error> {
         let conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let insert = conn.execute(
@@ -203,7 +203,7 @@ impl Database for Sqlite {
     }
 
     /// Refer to [`databases::Database::increase_number_of_downloads`](crate::core::databases::Database::increase_number_of_downloads).
-    fn increase_number_of_downloads(&self, info_hash: &InfoHash) -> Result<(), Error> {
+    fn increase_downloads_for_torrent(&self, info_hash: &InfoHash) -> Result<(), Error> {
         let conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let _ = conn.execute(
@@ -215,17 +215,17 @@ impl Database for Sqlite {
     }
 
     /// Refer to [`databases::Database::load_global_number_of_downloads`](crate::core::databases::Database::load_global_number_of_downloads).
-    fn load_global_number_of_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
+    fn load_global_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
         self.load_torrent_aggregate_metric(TORRENTS_DOWNLOADS_TOTAL)
     }
 
     /// Refer to [`databases::Database::save_global_number_of_downloads`](crate::core::databases::Database::save_global_number_of_downloads).
-    fn save_global_number_of_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error> {
+    fn save_global_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error> {
         self.save_torrent_aggregate_metric(TORRENTS_DOWNLOADS_TOTAL, downloaded)
     }
 
     /// Refer to [`databases::Database::increase_global_number_of_downloads`](crate::core::databases::Database::increase_global_number_of_downloads).
-    fn increase_global_number_of_downloads(&self) -> Result<(), Error> {
+    fn increase_global_downloads(&self) -> Result<(), Error> {
         let conn = self.pool.get().map_err(|e| (e, DRIVER))?;
 
         let metric_name = TORRENTS_DOWNLOADS_TOTAL;

packages/tracker-core/src/databases/mod.rs

@@ -101,7 +101,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the metrics cannot be loaded.
-    fn load_persistent_torrents(&self) -> Result<PersistentTorrents, Error>;
+    fn load_all_torrents_downloads(&self) -> Result<PersistentTorrents, Error>;
 
     /// Loads torrent metrics data from the database for one torrent.
     ///
@@ -110,7 +110,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the metrics cannot be loaded.
-    fn load_persistent_torrent(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error>;
+    fn load_torrent_downloads(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error>;
 
     /// Saves torrent metrics data into the database.
     ///
@@ -124,7 +124,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the metrics cannot be saved.
-    fn save_persistent_torrent(&self, info_hash: &InfoHash, downloaded: u32) -> Result<(), Error>;
+    fn save_torrent_downloads(&self, info_hash: &InfoHash, downloaded: u32) -> Result<(), Error>;
 
     /// Increases the number of downloads for a given torrent.
     ///
@@ -140,7 +140,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the query failed.
-    fn increase_number_of_downloads(&self, info_hash: &InfoHash) -> Result<(), Error>;
+    fn increase_downloads_for_torrent(&self, info_hash: &InfoHash) -> Result<(), Error>;
 
     /// Loads the total number of downloads for all torrents from the database.
     ///
@@ -149,7 +149,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the total downloads cannot be loaded.
-    fn load_global_number_of_downloads(&self) -> Result<Option<PersistentTorrent>, Error>;
+    fn load_global_downloads(&self) -> Result<Option<PersistentTorrent>, Error>;
 
     /// Saves the total number of downloads for all torrents into the database.
     ///
@@ -163,7 +163,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the total downloads cannot be saved.
-    fn save_global_number_of_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error>;
+    fn save_global_downloads(&self, downloaded: PersistentTorrent) -> Result<(), Error>;
 
     /// Increases the total number of downloads for all torrents.
     ///
@@ -172,7 +172,7 @@ pub trait Database: Sync + Send {
     /// # Errors
     ///
     /// Returns an [`Error`] if the query failed.
-    fn increase_global_number_of_downloads(&self) -> Result<(), Error>;
+    fn increase_global_downloads(&self) -> Result<(), Error>;
 
     // Whitelist
 

packages/tracker-core/src/statistics/event/handler.rs

@@ -53,7 +53,7 @@ pub async fn handle_event(
 
             if persistent_torrent_completed_stat {
                 // Increment the number of downloads for the torrent in the database
-                match db_downloads_metric_repository.increase_number_of_downloads(&info_hash) {
+                match db_downloads_metric_repository.increase_downloads_for_torrent(&info_hash) {
                     Ok(()) => {
                         tracing::debug!(info_hash = ?info_hash, "Number of torrent downloads increased");
                     }
@@ -63,7 +63,7 @@ pub async fn handle_event(
                 }
 
                 // Increment the global number of downloads (for all torrents) in the database
-                match db_downloads_metric_repository.increase_global_number_of_downloads() {
+                match db_downloads_metric_repository.increase_global_downloads() {
                     Ok(()) => {
                         tracing::debug!("Global number of downloads increased");
                     }

packages/tracker-core/src/statistics/persisted/downloads.rs

@@ -60,12 +60,12 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the database operation fails.
-    pub(crate) fn increase_number_of_downloads(&self, info_hash: &InfoHash) -> Result<(), Error> {
-        let torrent = self.load(info_hash)?;
+    pub(crate) fn increase_downloads_for_torrent(&self, info_hash: &InfoHash) -> Result<(), Error> {
+        let torrent = self.load_torrent_downloads(info_hash)?;
 
         match torrent {
-            Some(_number_of_downloads) => self.database.increase_number_of_downloads(info_hash),
-            None => self.save(info_hash, 1),
+            Some(_number_of_downloads) => self.database.increase_downloads_for_torrent(info_hash),
+            None => self.save_torrent_downloads(info_hash, 1),
         }
     }
 
@@ -77,8 +77,8 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the underlying database query fails.
-    pub(crate) fn load_all(&self) -> Result<PersistentTorrents, Error> {
-        self.database.load_persistent_torrents()
+    pub(crate) fn load_all_torrents_downloads(&self) -> Result<PersistentTorrents, Error> {
+        self.database.load_all_torrents_downloads()
     }
 
     /// Loads one persistent torrent metrics from the database.
@@ -89,8 +89,8 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the underlying database query fails.
-    pub(crate) fn load(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
-        self.database.load_persistent_torrent(info_hash)
+    pub(crate) fn load_torrent_downloads(&self, info_hash: &InfoHash) -> Result<Option<PersistentTorrent>, Error> {
+        self.database.load_torrent_downloads(info_hash)
     }
 
     /// Saves the persistent torrent metric into the database.
@@ -106,8 +106,8 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the database operation fails.
-    pub(crate) fn save(&self, info_hash: &InfoHash, downloaded: u32) -> Result<(), Error> {
-        self.database.save_persistent_torrent(info_hash, downloaded)
+    pub(crate) fn save_torrent_downloads(&self, info_hash: &InfoHash, downloaded: u32) -> Result<(), Error> {
+        self.database.save_torrent_downloads(info_hash, downloaded)
     }
 
     // Aggregate Metrics
@@ -119,12 +119,12 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the database operation fails.
-    pub(crate) fn increase_global_number_of_downloads(&self) -> Result<(), Error> {
-        let torrent = self.database.load_global_number_of_downloads()?;
+    pub(crate) fn increase_global_downloads(&self) -> Result<(), Error> {
+        let torrent = self.database.load_global_downloads()?;
 
         match torrent {
-            Some(_number_of_downloads) => self.database.increase_global_number_of_downloads(),
-            None => self.database.save_global_number_of_downloads(1),
+            Some(_number_of_downloads) => self.database.increase_global_downloads(),
+            None => self.database.save_global_downloads(1),
         }
     }
 
@@ -133,8 +133,8 @@ impl DatabaseDownloadsMetricRepository {
     /// # Errors
     ///
     /// Returns an [`Error`] if the underlying database query fails.
-    pub(crate) fn load_global_number_of_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
-        self.database.load_global_number_of_downloads()
+    pub(crate) fn load_global_downloads(&self) -> Result<Option<PersistentTorrent>, Error> {
+        self.database.load_global_downloads()
     }
 }
 
@@ -159,9 +159,9 @@ mod tests {
 
         let infohash = sample_info_hash();
 
-        repository.save(&infohash, 1).unwrap();
+        repository.save_torrent_downloads(&infohash, 1).unwrap();
 
-        let torrents = repository.load_all().unwrap();
+        let torrents = repository.load_all_torrents_downloads().unwrap();
 
         assert_eq!(torrents.get(&infohash), Some(1).as_ref());
     }
@@ -172,9 +172,9 @@ mod tests {
 
         let infohash = sample_info_hash();
 
-        repository.increase_number_of_downloads(&infohash).unwrap();
+        repository.increase_downloads_for_torrent(&infohash).unwrap();
 
-        let torrents = repository.load_all().unwrap();
+        let torrents = repository.load_all_torrents_downloads().unwrap();
 
         assert_eq!(torrents.get(&infohash), Some(1).as_ref());
     }
@@ -186,10 +186,10 @@ mod tests {
         let infohash_one = sample_info_hash_one();
         let infohash_two = sample_info_hash_two();
 
-        repository.save(&infohash_one, 1).unwrap();
-        repository.save(&infohash_two, 2).unwrap();
+        repository.save_torrent_downloads(&infohash_one, 1).unwrap();
+        repository.save_torrent_downloads(&infohash_two, 2).unwrap();
 
-        let torrents = repository.load_all().unwrap();
+        let torrents = repository.load_all_torrents_downloads().unwrap();
 
         let mut expected_torrents = PersistentTorrents::new();
         expected_torrents.insert(infohash_one, 1);