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

Compatible for getting auth token from client #5904

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

Conversation

timqi
Copy link

@timqi timqi commented Dec 6, 2024

💻 变更类型 | Change Type

  • feat
  • fix
  • refactor
  • perf
  • style
  • test
  • docs
  • ci
  • chore
  • build

🔀 变更说明 | Description of Change

注意到一些客户端尤其是 anthropic 相关的,使用 x-api-key 头来传递服务的 auth token,所以做此修改用来兼容这一种情况

Summary by CodeRabbit

  • New Features

    • Enhanced authentication flexibility by allowing API key retrieval from both "Authorization" and "x-api-key" headers.
  • Bug Fixes

    • Improved error handling in the request processing to ensure robust logging and graceful handling of issues.
  • Documentation

    • Clarified error conditions and logging for better insights during the authentication process.

Copy link

vercel bot commented Dec 6, 2024

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

Name Status Preview Comments Updated (UTC)
nextchat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 8:43am

Copy link

vercel bot commented Dec 6, 2024

@timqi is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes in this pull request involve updates to the handle and request functions in app/api/anthropic.ts, enhancing authentication and error handling mechanisms. The auth function in app/api/auth.ts has also been modified to allow retrieval of the authToken from both the "Authorization" and "x-api-key" headers. These modifications aim to improve the robustness and flexibility of the API's authentication and request handling processes.

Changes

File Change Summary
app/api/anthropic.ts - Updated request function to enhance authValue retrieval and error handling for model availability.
- Improved error logging and maintained timeout mechanism in handle function.
app/api/auth.ts - Enhanced auth function to retrieve authToken from both "Authorization" and "x-api-key" headers.
- Clarified error handling conditions and retained system API key injection logic.

Possibly related PRs

Suggested reviewers

  • lloydzhou
  • Dogtiti

🐇 In the code we hop and play,
With tokens and keys, we pave the way.
Errors caught, no more dismay,
A robust API, hip-hip-hooray!
Let's code and cheer, come what may! 🎉


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
Contributor

@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: 2

🧹 Outside diff range and nitpick comments (3)
app/api/anthropic.ts (3)

63-63: Move header name to constants

The 'x-api-key' header name is hardcoded. Consider moving it to the Anthropic constants for better maintainability and consistency.

+ // In app/constant.ts
+ export const Anthropic = {
+   // ... existing constants
+   AuthHeader: "x-api-key" as const,
+ };

- let authHeaderName = "x-api-key";
+ let authHeaderName = Anthropic.AuthHeader;

Line range hint 107-108: Consider using consistent header name in request headers

The code uses the dynamic authHeaderName for setting the header but hardcodes 'anthropic-version' in the next line. Consider using constants for all Anthropic-specific headers.

+ // In app/constant.ts
+ export const Anthropic = {
+   // ... existing constants
+   VersionHeader: "anthropic-version" as const,
+ };

- [authHeaderName]: authValue,
- "anthropic-version":
+ [Anthropic.AuthHeader]: authValue,
+ [Anthropic.VersionHeader]:

Line range hint 121-149: Improve error handling for model validation

The model validation code has several issues:

  1. It swallows all parsing errors silently
  2. The cloned request body is used even when parsing fails
  3. The type assertion for ServiceProvider could be made safer
   if (serverConfig.customModels && req.body) {
+    let parsedBody: { model?: string } | null = null;
     try {
       const clonedBody = await req.text();
-      fetchOptions.body = clonedBody;
-
-      const jsonBody = JSON.parse(clonedBody) as { model?: string };
+      parsedBody = JSON.parse(clonedBody);
+      fetchOptions.body = clonedBody;
     } catch (e) {
-      console.error(`[Anthropic] filter`, e);
+      console.error(`[Anthropic] Failed to parse request body:`, e);
+      return NextResponse.json(
+        { error: true, message: 'Invalid request body' },
+        { status: 400 }
+      );
     }

-    // not undefined and is false
-    if (
+    if (parsedBody && 
       isModelAvailableInServer(
         serverConfig.customModels,
-        jsonBody?.model as string,
-        ServiceProvider.Anthropic as string,
+        parsedBody.model ?? '',
+        ServiceProvider.Anthropic,
       )
     ) {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 83cea3a and c6f022f.

📒 Files selected for processing (2)
  • app/api/anthropic.ts (1 hunks)
  • app/api/auth.ts (1 hunks)

Comment on lines +28 to +29
const authToken =
req.headers.get("Authorization") ?? req.headers.get("x-api-key") ?? "";
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Consider reversing the header precedence order

The current implementation prioritizes the 'Authorization' header over 'x-api-key'. While this maintains backward compatibility, it could potentially allow an attacker to bypass intended 'x-api-key' authentication by providing an 'Authorization' header. Consider reversing the order if 'x-api-key' should take precedence for certain clients (e.g., Anthropic services).

-  const authToken =
-    req.headers.get("Authorization") ?? req.headers.get("x-api-key") ?? "";
+  const authToken =
+    req.headers.get("x-api-key") ?? req.headers.get("Authorization") ?? "";
📝 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
const authToken =
req.headers.get("Authorization") ?? req.headers.get("x-api-key") ?? "";
const authToken =
req.headers.get("x-api-key") ?? req.headers.get("Authorization") ?? "";

Comment on lines 64 to 67
let authValue =
req.headers.get(authHeaderName) ||
req.headers.get("Authorization")?.replaceAll("Bearer ", "").trim() ||
req.headers.get(authHeaderName) ||
serverConfig.anthropicApiKey ||
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Align authentication header precedence with auth.ts

The authentication header precedence here differs from auth.ts, which could lead to inconsistent behavior. Additionally, the Bearer token stripping is only applied to the 'Authorization' header, not to 'x-api-key'.

- let authValue =
-   req.headers.get("Authorization")?.replaceAll("Bearer ", "").trim() ||
-   req.headers.get(authHeaderName) ||
-   serverConfig.anthropicApiKey ||
-   "";
+ const stripBearer = (token: string | null) => 
+   token?.replaceAll("Bearer ", "").trim() ?? null;
+ let authValue =
+   stripBearer(req.headers.get(authHeaderName)) ??
+   stripBearer(req.headers.get("Authorization")) ??
+   serverConfig.anthropicApiKey ??
+   "";
📝 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
let authValue =
req.headers.get(authHeaderName) ||
req.headers.get("Authorization")?.replaceAll("Bearer ", "").trim() ||
req.headers.get(authHeaderName) ||
serverConfig.anthropicApiKey ||
const stripBearer = (token: string | null) =>
token?.replaceAll("Bearer ", "").trim() ?? null;
let authValue =
stripBearer(req.headers.get(authHeaderName)) ??
stripBearer(req.headers.get("Authorization")) ??
serverConfig.anthropicApiKey ??
"";

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