From e78d4fce7a07b03cee2446dd055e8bbf593a0e4b Mon Sep 17 00:00:00 2001
From: Aslam <iupin5212@gmail.com>
Date: Sun, 8 Sep 2024 03:55:57 +0700
Subject: [PATCH] chore: refactor clerk middleware and add readme for route
 protection (#147)

---
 web/middleware.ts | 41 +++++++++++++++++++++++++----------------
 web/readme.md     | 40 +++++++++++++++++++++++++++++++++++++++-
 2 files changed, 64 insertions(+), 17 deletions(-)

diff --git a/web/middleware.ts b/web/middleware.ts
index 92bdc125..90c011b9 100644
--- a/web/middleware.ts
+++ b/web/middleware.ts
@@ -1,23 +1,32 @@
-import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server'
+import { clerkMiddleware, createRouteMatcher } from "@clerk/nextjs/server"
 
-const isPublicRoute = createRouteMatcher([
-  '/sign-in(.*)',
-  '/sign-up(.*)',
-  '/',
-  '/:topicName(.*)'
-])
+const ROUTE_PATTERNS = {
+	public: ["/sign-in(.*)", "/sign-up(.*)", "/", "/:topicName(.*)"],
+	protected: [
+		"/edit-profile(.*)",
+		"/links(.*)",
+		"/pages(.*)",
+		"/profile(.*)",
+		"/search(.*)",
+		"/settings(.*)",
+		"/tauri(.*)"
+	]
+}
+
+const isPublicRoute = createRouteMatcher(ROUTE_PATTERNS.public)
+const isProtectedRoute = createRouteMatcher(ROUTE_PATTERNS.protected)
 
 export default clerkMiddleware((auth, request) => {
-  if (!isPublicRoute(request)) {
-    auth().protect()
-  }
+	if (isProtectedRoute(request) || !isPublicRoute(request)) {
+		auth().protect()
+	}
 })
 
 export const config = {
-  matcher: [
-    // Skip Next.js internals and all static files, unless found in search params
-    '/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)',
-    // Always run for API routes
-    '/(api|trpc)(.*)'
-  ]
+	matcher: [
+		// Skip Next.js internals and all static files, unless found in search params
+		"/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)",
+		// Always run for API routes
+		"/(api|trpc)(.*)"
+	]
 }
diff --git a/web/readme.md b/web/readme.md
index 8f4fcc61..44e0516b 100644
--- a/web/readme.md
+++ b/web/readme.md
@@ -1,5 +1,43 @@
-### LA Editor
+## LA Editor
 
 This folder should not contain any changes. It is a copy of the original LA Editor component from the [LA Editor](https://github.com/learn-anything/la-editor) repository.
 
 > This component is a temporary solution until the original repository publish the component to npm.
+
+## Clerk Middleware for Route Protection
+
+This middleware manages authentication and protects routes in our Next.js application using Clerk.
+
+## Key Concepts
+
+- **Public Routes**: Accessible to all users
+- **Protected Routes**: Require authentication
+
+## Important: Route Registration
+
+The middleware uses a catch-all public route `"/:topicName(.*)"`. This means:
+
+1. New routes are public by default
+2. Protected routes MUST be explicitly registered
+
+## How to Register Routes
+
+Update the `ROUTE_PATTERNS` object in the middleware file:
+
+```typescript
+const ROUTE_PATTERNS = {
+	public: ["/sign-in(.*)", "/sign-up(.*)", "/", "/:topicName(.*)"],
+	protected: [
+		"/edit-profile(.*)",
+		"/links(.*)",
+		// Add new protected routes here
+		"/new-protected-feature(.*)"
+	]
+}
+```
+
+## Best Practices
+
+1. Always add new protected routes to `ROUTE_PATTERNS.protected`
+2. Regularly review routes to ensure proper protection
+3. Be cautious when modifying the `"/:topicName(.*)"` catch-all route