rename PublishRateLimit to RateLimiter

Author: pietroalbini

src/config/server.rs

@@ -2,7 +2,7 @@ use anyhow::{anyhow, Context};
 use ipnetwork::IpNetwork;
 use oauth2::{ClientId, ClientSecret};
 
-use crate::publish_rate_limit::PublishRateLimit;
+use crate::rate_limiter::RateLimiter;
 use crate::{env, env_optional, Env};
 
 use super::base::Base;
@@ -30,7 +30,7 @@ pub struct Server {
     pub gh_client_secret: ClientSecret,
     pub max_upload_size: u64,
     pub max_unpack_size: u64,
-    pub publish_rate_limit: PublishRateLimit,
+    pub rate_limiter: RateLimiter,
     pub new_version_rate_limit: Option<u32>,
     pub blocked_traffic: Vec<(String, Vec<String>)>,
     pub max_allowed_page_offset: u32,
@@ -153,7 +153,7 @@ impl Default for Server {
             gh_client_secret: ClientSecret::new(env("GH_CLIENT_SECRET")),
             max_upload_size: 10 * 1024 * 1024, // 10 MB default file upload size limit
             max_unpack_size: 512 * 1024 * 1024, // 512 MB max when decompressed
-            publish_rate_limit: Default::default(),
+            rate_limiter: Default::default(),
             new_version_rate_limit: env_optional("MAX_NEW_VERSIONS_DAILY"),
             blocked_traffic: blocked_traffic(),
             max_allowed_page_offset: env_optional("WEB_MAX_ALLOWED_PAGE_OFFSET").unwrap_or(200),

src/controllers/krate/publish.rs

@@ -137,8 +137,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
             };
 
             let license_file = new_crate.license_file.as_deref();
-            let krate =
-                persist.create_or_update(conn, user.id, Some(&app.config.publish_rate_limit))?;
+            let krate = persist.create_or_update(conn, user.id, Some(&app.config.rate_limiter))?;
 
             let owners = krate.owners(conn)?;
             if user.rights(&app, &owners)? < Rights::Publish {

src/lib.rs

@@ -46,7 +46,7 @@ pub mod github;
 pub mod headers;
 pub mod metrics;
 pub mod middleware;
-mod publish_rate_limit;
+mod rate_limiter;
 pub mod schema;
 pub mod sql;
 pub mod ssh;

src/models/krate.rs

@@ -17,7 +17,7 @@ use crate::models::{
 use crate::util::errors::{cargo_err, AppResult};
 
 use crate::models::helpers::with_count::*;
-use crate::publish_rate_limit::PublishRateLimit;
+use crate::rate_limiter::RateLimiter;
 use crate::schema::*;
 use crate::sql::canon_crate_name;
 
@@ -107,7 +107,7 @@ impl<'a> NewCrate<'a> {
         self,
         conn: &mut PgConnection,
         uploader: i32,
-        rate_limit: Option<&PublishRateLimit>,
+        rate_limit: Option<&RateLimiter>,
     ) -> AppResult<Crate> {
         use diesel::update;
 

src/publish_rate_limit.rs renamed to src/rate_limiter.rs

@@ -15,12 +15,12 @@ crate::pg_enum! {
 }
 
 #[derive(Debug, Clone, Copy)]
-pub struct PublishRateLimit {
+pub struct RateLimiter {
     pub rate: Duration,
     pub burst: i32,
 }
 
-impl Default for PublishRateLimit {
+impl Default for RateLimiter {
     fn default() -> Self {
         let minutes = dotenvy::var("WEB_NEW_PKG_RATE_LIMIT_RATE_MINUTES")
             .unwrap_or_default()
@@ -39,7 +39,7 @@ impl Default for PublishRateLimit {
     }
 }
 
-impl PublishRateLimit {
+impl RateLimiter {
     pub fn check_rate_limit(&self, uploader: i32, conn: &mut PgConnection) -> AppResult<()> {
         let bucket = self.take_token(uploader, Utc::now().naive_utc(), conn)?;
         if bucket.tokens >= 1 {
@@ -126,7 +126,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -139,7 +139,7 @@ mod tests {
         };
         assert_eq!(expected, bucket);
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_millis(50),
             burst: 20,
         };
@@ -159,7 +159,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -180,7 +180,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -206,7 +206,7 @@ mod tests {
             NaiveDateTime::parse_from_str("2019-03-19T21:11:24.620401", "%Y-%m-%dT%H:%M:%S%.f")
                 .unwrap();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_millis(100),
             burst: 10,
         };
@@ -228,7 +228,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_millis(100),
             burst: 10,
         };
@@ -250,7 +250,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -274,7 +274,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -297,7 +297,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -320,7 +320,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };
@@ -347,7 +347,7 @@ mod tests {
         let conn = &mut pg_connection();
         let now = now();
 
-        let rate = PublishRateLimit {
+        let rate = RateLimiter {
             rate: Duration::from_secs(1),
             burst: 10,
         };

src/tests/util/test_app.rs

@@ -331,8 +331,8 @@ impl TestAppBuilder {
 
     pub fn with_publish_rate_limit(self, rate: Duration, burst: i32) -> Self {
         self.with_config(|config| {
-            config.publish_rate_limit.rate = rate;
-            config.publish_rate_limit.burst = burst;
+            config.rate_limiter.rate = rate;
+            config.rate_limiter.burst = burst;
         })
     }
 
@@ -396,7 +396,7 @@ fn simple_config() -> config::Server {
         gh_client_secret: ClientSecret::new(dotenvy::var("GH_CLIENT_SECRET").unwrap_or_default()),
         max_upload_size: 3000,
         max_unpack_size: 2000,
-        publish_rate_limit: Default::default(),
+        rate_limiter: Default::default(),
         new_version_rate_limit: Some(10),
         blocked_traffic: Default::default(),
         max_allowed_page_offset: 200,