Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed cors error in the collabsection #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ayushhunt
Copy link
Contributor

@ayushhunt ayushhunt commented Dec 4, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced CORS configuration to allow dynamic origin checking for improved security.
    • Added support for "Content-Type" and "Authorization" headers in requests.

Copy link

vercel bot commented Dec 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plura-status ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 4, 2024 6:43am

Copy link

vercel bot commented Dec 4, 2024

@ayushhunt is attempting to deploy a commit to the BlueFinZ Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Dec 4, 2024

Walkthrough

The changes in this pull request involve updates to the CORS configuration in the Hono application. The origin property of the CORS middleware has been modified to utilize a function that dynamically checks if the incoming origin is part of an allowedOrigins array. Additionally, the allowHeaders property has been introduced to permit specific headers in requests. The overall structure and routing of the application remain unchanged.

Changes

File Path Change Summary
apps/api/app/api/[[...route]]/route.ts Updated CORS configuration: changed origin to a function for dynamic checking and added allowHeaders for permitted headers.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant CORS Middleware
    participant Server

    Client->>CORS Middleware: Request with Origin
    CORS Middleware->>CORS Middleware: Check if Origin in allowedOrigins
    alt Origin Allowed
        CORS Middleware-->>Client: Allow Request
    else Origin Not Allowed
        CORS Middleware-->>Client: Deny Request
    end
    Client->>Server: Send Request with Allowed Headers
Loading

🐰 "In the land of code where the rabbits play,
CORS now checks origins in a smarter way!
With headers allowed, our requests can flow,
Hono's new magic makes APIs glow!
So hop along, dear friends, let's celebrate,
For changes like these make our code first-rate!" 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
apps/api/app/api/[[...route]]/route.ts (1)

Line range hint 19-23: Consider environment-based CORS configuration

Hard-coding allowed origins might cause issues across different environments (development, staging, production).

Consider moving the origins to environment variables:

-const allowedOrigins = [
-  "http://localhost:3003",
-  "https://www.plura.pro",
-  "https://app.plura.pro",
-];
+const allowedOrigins = (process.env.ALLOWED_ORIGINS || "")
+  .split(",")
+  .map(origin => origin.trim())
+  .filter(Boolean);

This would:

  1. Make the configuration more flexible across environments
  2. Support additional environments (staging, preview)
  3. Allow easy updates without code changes
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8262f0d and 691bfdb.

📒 Files selected for processing (1)
  • apps/api/app/api/[[...route]]/route.ts (1 hunks)
🔇 Additional comments (1)
apps/api/app/api/[[...route]]/route.ts (1)

39-39: Consider additional security headers and HTTP methods

The current configuration covers basic functionality but could be enhanced for better security and API compatibility.

Consider these additions:

     allowMethods: ["GET", "POST", "OPTIONS"],
-    allowHeaders:["Content-Type","Authorization"]
+    allowHeaders: [
+      "Content-Type",
+      "Authorization",
+      "X-Requested-With",
+      "Accept",
+      "Origin"
+    ],
+    // Add security headers
+    exposeHeaders: ["Content-Length", "X-Content-Type-Options"],
+    // Add credentials support if needed
+    credentials: true,

Also, verify if PATCH and DELETE methods are needed since they're exported but not included in allowMethods.

✅ Verification successful

CORS configuration is appropriate for current API usage

The current CORS configuration with GET, POST, and OPTIONS methods aligns with the actual API usage, as verified through codebase analysis showing no evidence of PATCH or DELETE endpoints. While the suggested security headers would enhance the configuration, the current setup provides the essential headers needed for basic functionality.

  • The current allowHeaders configuration covers the critical headers needed for authentication and content negotiation
  • The allowMethods list accurately reflects the implemented HTTP methods
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for PATCH/DELETE usage in API routes
echo "Checking for PATCH/DELETE method usage..."
rg -l "app\.(patch|delete)\(" apps/api/

Length of output: 134


Script:

#!/bin/bash
# Let's try a different approach to find HTTP method handlers
# Search for route handlers with PATCH or DELETE methods
rg -i "(patch|delete).*=.*async" apps/api/

# Also check for Next.js route handlers
rg -i "export async function (patch|delete)" apps/api/

# And check for any mentions of these methods in route configurations
rg -i "method.*['\"]?(patch|delete)['\"]?" apps/api/

Length of output: 160

Comment on lines +32 to +37
origin: (origin)=> {
if(allowedOrigins.includes(origin)){
return origin
}
return null;
}, // Allow requests from your frontend origin
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance CORS origin validation robustness

While the basic origin validation is good, the implementation could be more secure and robust.

Consider this enhanced implementation:

-    origin: (origin)=> {
-      if(allowedOrigins.includes(origin)){
-        return origin
-      }
-      return null;
-    },
+    origin: (origin) => {
+      // Handle cases where origin is undefined (e.g., same-origin requests)
+      if (!origin) return null;
+      
+      // Normalize the origin by trimming and converting to lowercase
+      const normalizedOrigin = origin.trim().toLowerCase();
+      
+      // Check against normalized allowed origins
+      if (allowedOrigins.map(o => o.toLowerCase()).includes(normalizedOrigin)) {
+        return origin;
+      }
+      
+      return null;
+    },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
origin: (origin)=> {
if(allowedOrigins.includes(origin)){
return origin
}
return null;
}, // Allow requests from your frontend origin
origin: (origin) => {
// Handle cases where origin is undefined (e.g., same-origin requests)
if (!origin) return null;
// Normalize the origin by trimming and converting to lowercase
const normalizedOrigin = origin.trim().toLowerCase();
// Check against normalized allowed origins
if (allowedOrigins.map(o => o.toLowerCase()).includes(normalizedOrigin)) {
return origin;
}
return null;
}, // Allow requests from your frontend origin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant