feat: implements auto cleanup fix #3

Author: rrd108

README.md

@@ -82,6 +82,21 @@ You can use any storage you want, but you have to use **shield** as the name of
 }
 ```
 
+### 4. Add `shield:clean` to `nuxt.config.ts`
+
+```json
+{
+  "nitro": {
+    "experimental": {
+      "tasks": true
+    },
+    "scheduledTasks": {
+      "*/15 * * * *": ["shield:clean"] // clean the shield storage every 15 minutes
+    }
+  }
+}
+```
+
 ## Development
 
 ```bash

playground/nuxt.config.ts

@@ -4,7 +4,7 @@ export default defineNuxtConfig({
     limit: {
       max: 12,
       duration: 10,
-      ban: 3600,
+      ban: 30,
     },
   },
   nitro: {
@@ -15,6 +15,12 @@ export default defineNuxtConfig({
         base: ".shield",
       },
     },
+    experimental: {
+      tasks: true,
+    },
+    scheduledTasks: {
+      "* * * * *": ["shield:clean"],
+    },
   },
   devtools: { enabled: true },
 });

playground/server/tasks/shield/clean.ts

@@ -0,0 +1,19 @@
+import isBanExpired from "../../../../src/runtime/server/utils/isBanExpired";
+
+export default defineTask({
+  meta: {
+    description: "Clean expired bans",
+  },
+  async run() {
+    const shieldStorage = useStorage("shield");
+
+    const keys = await shieldStorage.getKeys();
+    keys.forEach(async (key) => {
+      const rateLimit = await shieldStorage.getItem(key);
+      if (isBanExpired(rateLimit)) {
+        await shieldStorage.removeItem(key);
+      }
+    });
+    return { result: keys };
+  },
+});

src/runtime/server/middleware/shield.ts

@@ -1,10 +1,7 @@
-import { defineEventHandler, getRequestIP } from "h3";
-import { createError, useRuntimeConfig, useStorage } from "#imports";
-
-interface RateLimit {
-  count: number;
-  time: number;
-}
+import { createError, defineEventHandler, getRequestIP } from "h3";
+import { useRuntimeConfig, useStorage } from "#imports";
+import type { RateLimit } from "../types/RateLimit";
+import isBanExpired from "../utils/isBanExpired";
 
 export default defineEventHandler(async (event) => {
   if (!event.node.req.url?.startsWith("/api/")) {
@@ -58,11 +55,6 @@ const isNotRateLimited = (req: RateLimit) => {
   );
 };
 
-const isBanExpired = (req: RateLimit) => {
-  const options = useRuntimeConfig().public.nuxtApiShield;
-  return (Date.now() - req.time) / 1000 > options.limit.ban;
-};
-
 const banDelay = async (req: RateLimit) => {
   const options = useRuntimeConfig().public.nuxtApiShield;
 

src/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}

src/runtime/server/types/RateLimit.ts

@@ -0,0 +1,4 @@
+export type RateLimit = {
+  count: number;
+  time: number;
+};

src/runtime/server/utils/isBanExpired.ts

@@ -0,0 +1,8 @@
+import type { RateLimit } from "../types/RateLimit";
+
+const isBanExpired = (req: RateLimit) => {
+  const options = useRuntimeConfig().public.nuxtApiShield;
+  return (Date.now() - req.time) / 1000 > options.limit.ban;
+};
+
+export default isBanExpired;