feat: make redis optional (#333)

Co-authored-by: Ahmed Elsakaan <ahmedtarek3214@gmail.com>

.env.example

@@ -14,6 +14,6 @@ NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
 NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/app
 NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/app
 
-# Redis (Upstash)
+# Redis (Upstash) (optional)
 UPSTASH_REDIS_REST_URL=
 UPSTASH_REDIS_REST_TOKEN=

CONTRIBUTING.md

@@ -169,7 +169,7 @@ Clerk is our choice of authentication service for Noodle, it's true that it is a
 
 And now you got Auth!
 
-#### Configuring Upstash
+#### Configuring Upstash (optional)
 
 1. Create your account through [Upstash's dashboard](https://console.upstash.com)
 2. Click on "Create database"
@@ -179,6 +179,7 @@ And now you got Auth!
 6. In the "Connect to your database" section, select "@upstash/redis"
 7. Copy the url into your `.env` file as `REDIS_URL` key
 8. Copy the token into your `.env` file as `REDIS_TOKEN` key
+9. Upstash is only used for ratelimiting, if left empty then ratelimiting will be disabled
 
 And that's all for the redis part!
 

src/env.mjs

@@ -9,8 +9,8 @@ export const env = createEnv({
     NODE_ENV: z
       .enum(["development", "test", "production"])
       .default("development"),
-    UPSTASH_REDIS_REST_URL: z.string().min(1),
-    UPSTASH_REDIS_REST_TOKEN: z.string().min(1),
+    UPSTASH_REDIS_REST_URL: z.string().min(1).optional(),
+    UPSTASH_REDIS_REST_TOKEN: z.string().min(0).optional(),
     CLERK_SECRET_KEY: z.string().min(1),
     OPENWEATHER_API_KEY: z.string().min(1),
   },

src/middleware.ts

@@ -1,18 +1,23 @@
 import { authMiddleware } from "@clerk/nextjs";
 import { Ratelimit } from "@upstash/ratelimit";
 import { Redis } from "@upstash/redis";
-import { type NextRequest, NextResponse } from "next/server";
+import { NextResponse, type NextRequest } from "next/server";
 import { env } from "./env.mjs";
 
-const redis = new Redis({
-  url: env.UPSTASH_REDIS_REST_URL,
-  token: env.UPSTASH_REDIS_REST_TOKEN,
-});
+let redis: Redis;
+let ratelimit: Ratelimit;
 
-const ratelimit = new Ratelimit({
-  redis: redis,
-  limiter: Ratelimit.slidingWindow(20, "3 s"),
-});
+if (env.UPSTASH_REDIS_REST_URL) {
+  redis = new Redis({
+    url: env.UPSTASH_REDIS_REST_URL ?? "",
+    token: env.UPSTASH_REDIS_REST_TOKEN ?? "",
+  });
+
+  ratelimit = new Ratelimit({
+    redis: redis,
+    limiter: Ratelimit.slidingWindow(20, "3 s"),
+  });
+}
 
 async function rateLimitMiddleware(
   request: NextRequest,
@@ -28,7 +33,10 @@ const publicRoutesThatShouldRedirectAfterAuth = ["/", "/waitlist"];
 
 export default authMiddleware({
   beforeAuth: (req) => {
-    return rateLimitMiddleware(req);
+    if (env.UPSTASH_REDIS_REST_URL) {
+      return rateLimitMiddleware(req);
+    }
+    return NextResponse.next();
   },
   afterAuth: (auth, req) => {
     if (