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

fix: allow isVisionModel utility function read env var #5982

Closed
wants to merge 1 commit into from

Conversation

JiangYingjin
Copy link

@JiangYingjin JiangYingjin commented Dec 25, 2024

πŸ’» ε˜ζ›΄η±»εž‹ | Change Type

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

πŸ”€ ε˜ζ›΄θ―΄ζ˜Ž | Description of Change

Before the fix, the isVisionModel function retrieved VISION_MODELS from the getClientConfig function. However, the getClientConfig function was unable to read VISION_MODELS from the runtime environment variables. This issue caused visual models outside the predefined and built-in configurations to be evaluated as false by the isVisionModel function, resulting in the loss of their visual functionality. Specifically, the VISION_MODELS environment variable passed by users in Docker did not take effect.

After the fix, the isVisionModel function can now retrieve VISION_MODELS not only from BuildConfig but also from the runtime environment variables, resolving the issue.

πŸ“ θ‘₯充俑息 | Additional Information

Accordingly, the test unit test/vision-model-checker.test.ts was updated. Custom visual models were passed into process.env.VISION_MODELS, and the tests were successfully passed.

process.env.VISION_MODELS = "OpenGVLab/InternVL2-26B";
expect(isVisionModel("OpenGVLab/InternVL2-26B")).toBe(true);

Summary by CodeRabbit

  • New Features

    • Enhanced model checking by integrating vision models from both client configuration and an environment variable.
    • Added support for a new vision model, OpenGVLab/InternVL2-26B.
  • Bug Fixes

    • Improved accuracy in identifying vision models through updated logic.
  • Tests

    • Updated test cases to include the new vision model and ensure correct functionality.

Copy link

vercel bot commented Dec 25, 2024

@JiangYingjin 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 25, 2024

Walkthrough

The pull request modifies the isVisionModel function in app/utils.ts to enhance vision model detection. The changes expand the method of retrieving vision models by combining client configuration with an environment variable VISION_MODELS. This approach provides more flexibility in defining and checking vision models, allowing for additional models to be specified through environment configuration while maintaining the existing logic for model identification.

Changes

File Change Summary
app/utils.ts Restructured isVisionModel function to combine vision models from client config and VISION_MODELS environment variable
test/vision-model-checker.test.ts Added new vision model OpenGVLab/InternVL2-26B to environment variable and corresponding test assertion

Possibly related PRs

Suggested labels

help wanted, planned

Poem

🐰 A rabbit's tale of models bright,
Checking visions with all its might
Environment and config combine
To make our model logic shine!
Flexibility leaps with each new test 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


πŸ“œ Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 0c3d446 and ea1751f.

πŸ“’ Files selected for processing (2)
  • app/utils.ts (1 hunks)
  • test/vision-model-checker.test.ts (1 hunks)
πŸ”‡ Additional comments (4)
test/vision-model-checker.test.ts (2)

52-52: Validate environment variable setup for custom vision models.
Including "OpenGVLab/InternVL2-26B" in VISION_MODELS ensures better coverage for custom models. This confirms that isVisionModel responds correctly to newly added models.


56-56: Good addition to test coverage.
Asserting isVisionModel("OpenGVLab/InternVL2-26B") ensures that environment-based vision models are respected, increasing confidence in the integration of runtime-defined vision models.

app/utils.ts (2)

257-259: Smart combination of client and runtime vision models.
Merging visionModels from client config and process.env.VISION_MODELS addresses the primary issue of not recognizing custom-defined models.


261-265: Ensure string splitting handles edge cases.
Using split(",") and filtering out empty strings provides a concise approach. However, ensure that any leading/trailing commas (or whitespace) in the configured strings are handled gracefully. Overall, this logic is sound.

Run the following shell script to detect potential trailing commas or whitespace issues in environment variables:

βœ… Verification successful

String splitting implementation handles edge cases appropriately

The code's approach to handling the VISION_MODELS environment variable is well-tested and handles edge cases properly:

  • The test cases in test/vision-model-checker.test.ts explicitly verify handling of:
    • Normal comma-separated values
    • Empty string values
    • Missing environment variable
  • The implementation in app/utils.ts has multiple safeguards:
    • Uses process.env.VISION_MODELS || "" to handle undefined case
    • .filter(Boolean) removes empty entries
    • .trim() handles any whitespace
  • The documentation in README files clearly shows the expected format with clean comma-separated values
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# This script searches for environment usage of VISION_MODELS in the project
# to see if there's any code that appends commas or introduces whitespace

rg -A 3 'VISION_MODELS' 

Length of output: 2236


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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