Merge #115: Fix Clippy Pedantic Warnings and Structure Rename

0f075e4 refactor: src/api/resource(s) (Cameron Garnham)
01e71bf clippy: fix src/tracker/peer.rs (Cameron Garnham)
49a6acb ci: clippy warning as errors (Cameron Garnham)
32eb44b refactor: rename inside http (Cameron Garnham)
3645271 refactor: rename inside databases (Cameron Garnham)
ec21df9 rename: Key::Auth to auth::Key (Cameron Garnham)
0d162a1 refactor: correct naming of structs and enums (Cameron Garnham)
baba21b clippy: fix tests/udp.rs (Cameron Garnham)
6564c10 clippy: fix src/protocol/crypto.rs (Cameron Garnham)
436a0c1 clippy: fix src/udp/server.rs (Cameron Garnham)
aa30bb1 clippy: fix src/udp/request.rs (Cameron Garnham)
220f83a clippy: fix src/udp/handlers.rs (Cameron Garnham)
0a7d927 clippy: fix src/jobs/tracker_api.rs (Cameron Garnham)
6e2a342 clippy: fix src/databases/database.rs (Cameron Garnham)
4a34f68 clippy: fix src/udp/connection_cookie.rs (Cameron Garnham)
78221b6 clippy: fix src/tracker/mod.rs (Cameron Garnham)
81e72da clippy: fix src/tracker/torrent.rs (Cameron Garnham)
143a11e refactor: cleanup src/tracker/statistics.rs naming (Cameron Garnham)
3c22323 clippy: fix src/tracker/statistics.rs (Cameron Garnham)
0f281c3 clippy: fix src/tracker/peer.rs (Cameron Garnham)
363b21a clippy: fix src/tracker/mode.rs (Cameron Garnham)
58e5909 clippy: fix src/tracker/key.rs (Cameron Garnham)
efed1bc clippy: fix src/setup.rs (Cameron Garnham)
d03269a clippy: fix src/protocol/utils.rs (Cameron Garnham)
5ea7c0d clippy: fix src/protocol/clock/time_extent.rs (Cameron Garnham)
c78404f clippy: fix src/protocol/clock/mod.rs (Cameron Garnham)
9adbfd1 clippy: fix src/logging.rs (Cameron Garnham)
d092580 clippy: fix src/jobs/torrent_cleanup.rs (Cameron Garnham)
577ddb9 clippy: fix src/jobs/http_tracker.rs (Cameron Garnham)
208b10e clippy: fix src/http/server.rs (Cameron Garnham)
75bef77 clippy: fix src/http/handlers.rs (Cameron Garnham)
b5ce7e9 clippy: fix src/http/filters.rs (Cameron Garnham)
be6676a clippy: fix src/databases/sqlite.rs (Cameron Garnham)
38eabc4 clippy: fix src/databases/mysql.rs (Cameron Garnham)
87160bd clippy: fix src/databases/database.rs (Cameron Garnham)
8e3115f clippy: fix src/config.rs (Cameron Garnham)
2ba7489 clippy: fix src/protocol/common.rs (Cameron Garnham)
a433c82 clippy: fix src/api/server.rs (Cameron Garnham)
941e982 clippy: fix src/api/resources/auth_key_resource.rs (Cameron Garnham)
21b6e77 clippy: fix (ignore) src/config.rs (Cameron Garnham)
a9f760b clippy: fix src/http/request.rs (Cameron Garnham)
f74c933 clippy: fix src/http/response.rs (Cameron Garnham)
2b88ce5 clippy: auto fix (Cameron Garnham)
81c4129 vscode: clippy padantic warnings (Cameron Garnham)
7eb25a0 refactor: remove internal mod exports (Cameron Garnham)

Pull request description:

  Massive Rename of Structs and Fixing of Many Pedantic Clippy Warnings.

ACKs for top commit:
  da2ce7:
    ACK 0f075e4

Tree-SHA512: 6d1343d889cc5a15da9ab9950497566dd22e9f1cac7e30ee00ecbc8bce65133bc8ab47b9a183edafe3c3bdaf3c922f5d170b69c04644788466017f887a581fbf

Author: da2ce7

.github/workflows/test_build_release.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets
+          args: --all-targets -- -D clippy::pedantic
       - uses: taiki-e/install-action@cargo-llvm-cov
       - uses: taiki-e/install-action@nextest
       - name: Run Tests

.vscode/settings.json

@@ -3,4 +3,6 @@
         "editor.formatOnSave": true
     },
     "rust-analyzer.checkOnSave.command": "clippy",
+    "rust-analyzer.checkOnSave.allTargets": true,
+    "rust-analyzer.checkOnSave.extraArgs": ["--","-W","clippy::pedantic"],
 }

cSpell.json

@@ -7,6 +7,7 @@
         "bencode",
         "binascii",
         "Bitflu",
+        "bools",
         "bufs",
         "byteorder",
         "canonicalize",

src/api/mod.rs

@@ -1,2 +1,2 @@
-pub mod resources;
+pub mod resource;
 pub mod server;

src/api/resources/auth_key_resource.rs renamed to src/api/resource/auth_key.rs

@@ -2,18 +2,18 @@ use std::convert::From;
 
 use serde::{Deserialize, Serialize};
 
-use crate::key::AuthKey;
 use crate::protocol::clock::DurationSinceUnixEpoch;
+use crate::tracker::auth;
 
-#[derive(Serialize, Deserialize, Debug, PartialEq)]
-pub struct AuthKeyResource {
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct AuthKey {
     pub key: String,
     pub valid_until: Option<u64>,
 }
 
-impl From<AuthKeyResource> for AuthKey {
-    fn from(auth_key_resource: AuthKeyResource) -> Self {
-        AuthKey {
+impl From<AuthKey> for auth::Key {
+    fn from(auth_key_resource: AuthKey) -> Self {
+        auth::Key {
             key: auth_key_resource.key,
             valid_until: auth_key_resource
                 .valid_until
@@ -22,9 +22,9 @@ impl From<AuthKeyResource> for AuthKey {
     }
 }
 
-impl From<AuthKey> for AuthKeyResource {
-    fn from(auth_key: AuthKey) -> Self {
-        AuthKeyResource {
+impl From<auth::Key> for AuthKey {
+    fn from(auth_key: auth::Key) -> Self {
+        AuthKey {
             key: auth_key.key,
             valid_until: auth_key.valid_until.map(|valid_until| valid_until.as_secs()),
         }
@@ -35,50 +35,50 @@ impl From<AuthKey> for AuthKeyResource {
 mod tests {
     use std::time::Duration;
 
-    use super::AuthKeyResource;
-    use crate::key::AuthKey;
-    use crate::protocol::clock::{DefaultClock, TimeNow};
+    use super::AuthKey;
+    use crate::protocol::clock::{Current, TimeNow};
+    use crate::tracker::auth;
 
     #[test]
     fn it_should_be_convertible_into_an_auth_key() {
         let duration_in_secs = 60;
 
-        let auth_key_resource = AuthKeyResource {
+        let auth_key_resource = AuthKey {
             key: "IaWDneuFNZi8IB4MPA3qW1CD0M30EZSM".to_string(), // cspell:disable-line
             valid_until: Some(duration_in_secs),
         };
 
         assert_eq!(
-            AuthKey::from(auth_key_resource),
-            AuthKey {
+            auth::Key::from(auth_key_resource),
+            auth::Key {
                 key: "IaWDneuFNZi8IB4MPA3qW1CD0M30EZSM".to_string(), // cspell:disable-line
-                valid_until: Some(DefaultClock::add(&Duration::new(duration_in_secs, 0)).unwrap())
+                valid_until: Some(Current::add(&Duration::new(duration_in_secs, 0)).unwrap())
             }
-        )
+        );
     }
 
     #[test]
     fn it_should_be_convertible_from_an_auth_key() {
         let duration_in_secs = 60;
 
-        let auth_key = AuthKey {
+        let auth_key = auth::Key {
             key: "IaWDneuFNZi8IB4MPA3qW1CD0M30EZSM".to_string(), // cspell:disable-line
-            valid_until: Some(DefaultClock::add(&Duration::new(duration_in_secs, 0)).unwrap()),
+            valid_until: Some(Current::add(&Duration::new(duration_in_secs, 0)).unwrap()),
         };
 
         assert_eq!(
-            AuthKeyResource::from(auth_key),
-            AuthKeyResource {
+            AuthKey::from(auth_key),
+            AuthKey {
                 key: "IaWDneuFNZi8IB4MPA3qW1CD0M30EZSM".to_string(), // cspell:disable-line
                 valid_until: Some(duration_in_secs)
             }
-        )
+        );
     }
 
     #[test]
     fn it_should_be_convertible_into_json() {
         assert_eq!(
-            serde_json::to_string(&AuthKeyResource {
+            serde_json::to_string(&AuthKey {
                 key: "IaWDneuFNZi8IB4MPA3qW1CD0M30EZSM".to_string(), // cspell:disable-line
                 valid_until: Some(60)
             })

src/api/resource/mod.rs

@@ -0,0 +1,13 @@
+//! These are the Rest API resources.
+//!
+//! WIP. Not all endpoints have their resource structs.
+//!
+//! - [x] `AuthKeys`
+//! - [ ] `Torrent`, `ListItem`, `Peer`, `PeerId`
+//! - [ ] `StatsResource`
+//! - [ ] ...
+
+pub mod auth_key;
+pub mod peer;
+pub mod stats;
+pub mod torrent;

src/api/resource/peer.rs

@@ -0,0 +1,47 @@
+use serde::{Deserialize, Serialize};
+
+use crate::tracker;
+
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct Peer {
+    pub peer_id: Id,
+    pub peer_addr: String,
+    #[deprecated(since = "2.0.0", note = "please use `updated_milliseconds_ago` instead")]
+    pub updated: u128,
+    pub updated_milliseconds_ago: u128,
+    pub uploaded: i64,
+    pub downloaded: i64,
+    pub left: i64,
+    pub event: String,
+}
+
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct Id {
+    pub id: Option<String>,
+    pub client: Option<String>,
+}
+
+impl From<tracker::peer::Id> for Id {
+    fn from(peer_id: tracker::peer::Id) -> Self {
+        Id {
+            id: peer_id.get_id(),
+            client: peer_id.get_client_name().map(std::string::ToString::to_string),
+        }
+    }
+}
+
+impl From<tracker::peer::Peer> for Peer {
+    #[allow(deprecated)]
+    fn from(peer: tracker::peer::Peer) -> Self {
+        Peer {
+            peer_id: Id::from(peer.peer_id),
+            peer_addr: peer.peer_addr.to_string(),
+            updated: peer.updated.as_millis(),
+            updated_milliseconds_ago: peer.updated.as_millis(),
+            uploaded: peer.uploaded.0,
+            downloaded: peer.downloaded.0,
+            left: peer.left.0,
+            event: format!("{:?}", peer.event),
+        }
+    }
+}

src/api/resources/stats_resource.rs renamed to src/api/resource/stats.rs

@@ -1,7 +1,7 @@
 use serde::{Deserialize, Serialize};
 
-#[derive(Serialize, Deserialize, Debug, PartialEq)]
-pub struct StatsResource {
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct Stats {
     pub torrents: u32,
     pub seeders: u32,
     pub completed: u32,

src/api/resource/torrent.rs

@@ -0,0 +1,21 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct Torrent {
+    pub info_hash: String,
+    pub seeders: u32,
+    pub completed: u32,
+    pub leechers: u32,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub peers: Option<Vec<super::peer::Peer>>,
+}
+
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub struct ListItem {
+    pub info_hash: String,
+    pub seeders: u32,
+    pub completed: u32,
+    pub leechers: u32,
+    // todo: this is always None. Remove field from endpoint?
+    pub peers: Option<Vec<super::peer::Peer>>,
+}