Rate-Limiter API

packages/rust/.vscode/launch.json

@@ -0,0 +1,102 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in library 'bubble'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--lib",
+                    "--package=bubble"
+                ],
+                "filter": {
+                    "name": "bubble",
+                    "kind": "lib"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug executable 'bubble'",
+            "cargo": {
+                "args": [
+                    "build",
+                    "--bin=bubble",
+                    "--package=bubble"
+                ],
+                "filter": {
+                    "name": "bubble",
+                    "kind": "bin"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in executable 'bubble'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--bin=bubble",
+                    "--package=bubble"
+                ],
+                "filter": {
+                    "name": "bubble",
+                    "kind": "bin"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug integration test 'user_test'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--test=user_test",
+                    "--package=bubble"
+                ],
+                "filter": {
+                    "name": "user_test",
+                    "kind": "test"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug integration test 'helper'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--test=helper",
+                    "--package=bubble"
+                ],
+                "filter": {
+                    "name": "helper",
+                    "kind": "test"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

packages/rust/server/Cargo.toml

@@ -21,6 +21,7 @@ base64 = "0.21.0"
 # SendGrid
 sendgrid = "0.19.0"
 
+# Token
 
 
 [dev-dependencies]

packages/rust/server/src/services/mod.rs

@@ -1,3 +1,4 @@
 pub mod email;
 pub mod password;
 pub mod session;
+pub mod token;

packages/rust/server/src/services/token.rs

@@ -0,0 +1,236 @@
+use std::collections::HashMap;
+
+use std::sync::{Arc, Mutex};
+
+use std::thread;
+
+use std::time::{Duration, Instant};
+
+pub struct LimiterConfig<'a> {
+    name: &'a str,
+    size: usize,
+    rate: f64,
+}
+
+#[non_exhaustive]
+struct Configs;
+
+impl Configs {
+    pub const MESSAGES: LimiterConfig<'_> = LimiterConfig {
+        name: "messages",
+        size: 60,
+        rate: 60.0 / 0.017,
+    };
+    pub const CLIENT_CREATE: LimiterConfig<'_> = LimiterConfig {
+        name: "messages",
+        size: 2,
+        rate: 1.0,
+    };
+    pub const CLIENT_UPDATE: LimiterConfig<'_> = LimiterConfig {
+        name: "messages",
+        size: 4,
+        rate: 2.0,
+    };
+    pub const CLIENT_DELETE: LimiterConfig<'_> = LimiterConfig {
+        name: "messages",
+        size: 2,
+        rate: 1.0,
+    };
+
+    pub const USER_REGISTRATION: LimiterConfig<'_> = LimiterConfig {
+        name: "registration",
+        size: 6,
+        rate: 12.0,
+    };
+    pub const USER_CONFIRM_REGISTRATION: LimiterConfig<'_> = LimiterConfig {
+        name: "confirm_registration",
+        size: 5,
+        rate: 10.0,
+    };
+    pub const USER_LOGIN_ATTEMPT: LimiterConfig<'_> = LimiterConfig {
+        name: "login",
+        size: 10,
+        rate: 10.0 / 144.0,
+    };
+    pub const USER_FORGOT_PASSWORD: LimiterConfig<'_> = LimiterConfig {
+        name: "forgot",
+        size: 10,
+        rate: 10.0 / 144.0,
+    };
+    pub const USER_CHANGE_EMAIL: LimiterConfig<'_> = LimiterConfig {
+        name: "change",
+        size: 6,
+        rate: 6.0 / 10.0,
+    };
+    pub const USER_DELETE_USER: LimiterConfig<'_> = LimiterConfig {
+        name: "delete_user",
+        size: 6,
+        rate: 6.0 / 10.0,
+    };
+}
+
+#[derive(Copy, Clone)]
+pub struct Bucket {
+    capacity: usize,
+    refill_rate: f64,
+    last_refill_time: Instant,
+    current_tokens: usize,
+}
+
+impl Bucket {
+    fn new(capacity: usize, refill_rate: f64) -> Bucket {
+        Bucket {
+            capacity,
+            refill_rate,
+            current_tokens: 0,
+            last_refill_time: Instant::now(),
+        }
+    }
+}
+
+
+pub struct TokenBucket {
+    buckets: Mutex<HashMap<String, Bucket>>,
+}
+
+impl TokenBucket {
+    fn new() -> TokenBucket {
+        TokenBucket {
+            buckets: Mutex::new(HashMap::new()),
+        }
+    }
+
+    fn add_bucket(&self, capacity: usize, refill_rate: f64, name: &str) {
+        self.buckets
+            .lock()
+            .unwrap()
+            .insert(name.to_string(), Bucket::new(capacity, refill_rate));
+    }
+
+    fn seed_buckets(&self, configs: &[LimiterConfig]) {
+        for config in configs {
+            self.add_bucket(config.size, config.rate, config.name);
+        }
+    }
+
+    fn update(&self, to_update: &str) {
+        let mut buckets = self.buckets.lock().unwrap();
+        let mut bucket = buckets.get_mut(to_update).unwrap();
+        let now = Instant::now();
+        let elapsed = now.duration_since(bucket.last_refill_time);
+
+        let tokens_to_add = (elapsed.as_secs_f64() * bucket.refill_rate) as usize;
+        if tokens_to_add > 0 {
+            bucket.current_tokens =
+                std::cmp::min(bucket.capacity, bucket.current_tokens + tokens_to_add);
+            bucket.last_refill_time = now;
+        }
+    }
+
+    fn handle(&self, num_tokens: usize, to_update: &str) -> bool {
+        let mut buckets = self.buckets.lock().unwrap();
+        let mut bucket = buckets.get_mut(to_update).unwrap();
+        self.update(to_update);
+
+        let tokens_in_bucket = bucket.current_tokens;
+        if tokens_in_bucket >= num_tokens {
+            bucket.current_tokens -= num_tokens;
+            true
+        } else {
+            false
+        }
+    }
+}
+
+#[derive(Clone)]
+struct Service {
+    name: String,
+    token_bucket: Arc<TokenBucket>,
+}
+
+impl Service {
+    fn new(name: String, token_bucket: Arc<TokenBucket>) -> Service {
+        Service { name, token_bucket }
+    }
+
+    fn handle_request(&self, num_tokens: usize, bucket_to_handle: &str) {
+        if self.token_bucket.handle(num_tokens, bucket_to_handle) {
+            println!(
+                "Request handled by service {} for configuration {}: {:?}",
+                self.name,
+                bucket_to_handle,
+                thread::current().id()
+            );
+        } else {
+            println!(
+                "Rate limit exceeded by service {} for configuration {}: {:?}",
+                self.name,
+                bucket_to_handle,
+                thread::current().id()
+            );
+        }
+    }
+}
+
+#[test]
+fn test_token_bucket() {
+    let token_bucket = Arc::new(TokenBucket::new());
+
+    // Seed the token bucket with predefined configurations
+    let configs = [
+        Configs::MESSAGES,
+        Configs::CLIENT_CREATE,
+        Configs::CLIENT_UPDATE,
+        Configs::CLIENT_DELETE,
+        Configs::USER_REGISTRATION,
+        Configs::USER_CONFIRM_REGISTRATION,
+        Configs::USER_LOGIN_ATTEMPT,
+        Configs::USER_FORGOT_PASSWORD,
+        Configs::USER_CHANGE_EMAIL,
+        Configs::USER_DELETE_USER,
+    ];
+    token_bucket.seed_buckets(&configs);
+
+    // Create service instances
+    let service_a = Service::new("A".to_string(), token_bucket.clone());
+    let service_b = Service::new("B".to_string(), token_bucket.clone());
+
+    // Perform requests to the services
+    for _ in 0..10 {
+        // Handle requests for the "messages" service
+        let service_a = service_a.clone();
+        thread::spawn(move || {
+            service_a.handle_request(1, Configs::MESSAGES.name);
+        });
+
+        // Handle requests for the "registration" service
+        let service_b = service_b.clone();
+        thread::spawn(move || {
+            service_b.handle_request(1, Configs::USER_REGISTRATION.name);
+        });
+
+        // Sleep for a short duration between requests
+        thread::sleep(Duration::from_millis(100));
+    }
+
+    // Sleep for a longer duration to allow token refilling
+    thread::sleep(Duration::from_secs(2));
+
+    // Perform more requests after token refilling
+    for _ in 0..5 {
+        // Handle requests for the "messages" service
+        let service_a = service_a.clone();
+        thread::spawn(move || {
+            service_a.handle_request(1, Configs::MESSAGES.name);
+        });
+
+        // Handle requests for the "registration" service
+        let service_b = service_b.clone();
+        thread::spawn(move || {
+            service_b.handle_request(1, Configs::USER_REGISTRATION.name);
+        });
+
+        // Sleep for a short duration between requests
+        thread::sleep(Duration::from_millis(100));
+    }
+}