feat: improved rate limiter & added chrome to the lists of requirements

Author: mrepol742

README.md

@@ -4,12 +4,12 @@
 
 A scalable, modular WhatsApp chatbot built in TypeScript. It leverages modern best practices, lean architecture, Prisma ORM, Dockerization, and environment-based configuration to deliver a robust, flexible successor to Project Orion.
 
-> ⚠️ **Warning:**  
+> ⚠️ **Warning:**
 > This repository is for educational and entertainment purposes only.
 > Canis and Orion are not affiliated with Meta (WhatsApp/Facebook).
 > Use at your own risk, your WhatsApp account may be subject to suspension or bans.
 
-> ⚠️ **Warning:**  
+> ⚠️ **Warning:**
 > Spaghetting code ahead
 
 ## Supported AI Providers
@@ -31,6 +31,7 @@ Canis supports multiple AI providers out of the box:
 
 - Redis/Valkey
 - WhatsApp Account
+- Chrome browser
 
 ## Getting started
 

src/components/events/message.ts

@@ -69,7 +69,7 @@ export default async function (msg: Message) {
    * Block users from running commands.
    */
   const isBlockedUser = await isBlocked(
-    msg.author ? msg.author.split("@")[0] : senderId
+    msg.author ? msg.author.split("@")[0] : senderId,
   );
   if (isBlockedUser) {
     return;
@@ -80,8 +80,8 @@ export default async function (msg: Message) {
    */
   if (!msg.fromMe) {
     const rate = await rateLimiter(msg.from);
-    if (rate === null) return;
-    if (!rate) {
+    if (rate) return;
+    if (rate === null) {
       msg.reply("Please wait a minute or so.");
       return;
     }
@@ -103,7 +103,7 @@ export default async function (msg: Message) {
   msg.reply = async (
     content: MessageContent,
     chatId?: string,
-    options?: MessageSendOptions
+    options?: MessageSendOptions,
   ): Promise<Message> => {
     let messageBody = typeof content === "string" ? Font(content) : content;
 
@@ -115,13 +115,13 @@ export default async function (msg: Message) {
 
   if (
     /^(--?help|\bhelp\b|-h)$/i.test(
-      msg.body.trim().replace(handler.command, "").trim()
+      msg.body.trim().replace(handler.command, "").trim(),
     )
   ) {
     const response = `
     \`${handler.command}\`
     ${handler.description || "No description"}
-    
+
     *Usage:* ${handler.usage || "No usage"}
     *Example:* ${handler.example || "No example"}
     *Role:* ${handler.role || "user"}
@@ -191,10 +191,10 @@ export default async function (msg: Message) {
     log.error(
       key,
       "Unexpected error occurred while processing the request:",
-      error
+      error,
     );
     await msg.reply(
-      `An unexpected error occurred while processing your request for "${key}". Please try again later.`
+      `An unexpected error occurred while processing your request for "${key}". Please try again later.`,
     );
   }
 }

src/components/utils/rateLimiter.ts

@@ -3,65 +3,56 @@ import log from "./log";
 
 const LIMIT = 5;
 const BASE_WINDOW_MS = 30 * 1000;
-const PENALTY_INCREMENT_MS = 5 * 1000;
+const PENALTY_INCREMENT_MS = 10 * 1000;
 
 function getKey(number: string) {
   return `rate:${number}`;
 }
 
-export default async function (number: string): Promise<boolean | null> {
+export default async function rateLimiter(
+  number: string,
+): Promise<boolean | null> {
   const now = Date.now();
   const key = getKey(number);
 
-  // Get user entry from Redis
   const entryRaw = await redis.get(key);
   let entry = entryRaw
     ? JSON.parse(entryRaw)
     : {
-        timestamps: [],
-        notified: false,
+        timestamps: [] as number[],
         penaltyCount: 0,
         penaltyUntil: 0,
       };
 
-  // Penalty check
-  if (entry.penaltyUntil > now) {
-    log.info(
-      "RateLimiter",
-      `User ${number} is under penalty until ${new Date(
-        entry.penaltyUntil
-      ).toLocaleTimeString()}`
+  const isStillBlocked = entry.penaltyUntil > now;
+
+  if (!isStillBlocked) {
+    entry.timestamps = entry.timestamps.filter(
+      (ts: number) => now - ts < BASE_WINDOW_MS,
     );
-    if (!entry.notified) return null;
-    entry.notified = true;
-    await redis.set(key, JSON.stringify(entry));
-    return false;
   }
 
-  // Remove old timestamps
-  entry.timestamps = entry.timestamps.filter(
-    (ts: number) => now - ts < BASE_WINDOW_MS
-  );
-
-  if (entry.timestamps.length >= LIMIT) {
+  if (isStillBlocked || entry.timestamps.length >= LIMIT) {
     entry.penaltyCount += 1;
+
     entry.penaltyUntil =
-      now + BASE_WINDOW_MS + (entry.penaltyCount - 1) * PENALTY_INCREMENT_MS;
-    entry.notified = false;
+      Math.max(entry.penaltyUntil, now) +
+      entry.penaltyCount * PENALTY_INCREMENT_MS +
+      BASE_WINDOW_MS;
+
     entry.timestamps = [];
+
     log.warn(
       "RateLimiter",
-      `User ${number} exceeded limit. Penalty until ${new Date(
-        entry.penaltyUntil
-      ).toLocaleTimeString()}`
+      `User ${number} blocked until ${new Date(entry.penaltyUntil).toLocaleTimeString()}`,
     );
+
     await redis.set(key, JSON.stringify(entry));
-    return false;
+    if (entry.penaltyCount === 1) return null;
+    return true;
   }
 
-  // Allowed
   entry.timestamps.push(now);
-  entry.notified = false;
   await redis.set(key, JSON.stringify(entry));
-  return true;
+  return false;
 }