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 issue with cvat running in HTTP mode behind a HTTPS reverse proxy #7313

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

cargoculttech
Copy link

@cargoculttech cargoculttech commented Jan 4, 2024

  • Check if HTTP_ORIGIN exists in the request.META, if it does, use the same http scheme for the TUS location uri. If not exist, use Django's build_absolute_uri() for the TUS location uri.

Issue: #7288

Motivation and context

Fixed the problem where TUS resumable upload feature does not work when CVAT is setup to run in HTTP only, but put behind a HTTPs proxy.
Scenario: Client --> HTTPS reverse proxy --> HTTP Cvat server
Originally, CVAT would return HTTP location for tus resumable, but since client is requesting CVAT through a HTTPS proxy, CVAT should also return a HTTPS location for TUS resumable.
The change allows CVAT to recognize that it's behind a HTTPS reverse proxy, and return the HTTP scheme accordingly. This
change also works if Client --> HTTP reverse proxy --> HTTPS Cvat server.

This change is required because it makes CVAT easier to be hosted behind a reverse proxy.
Screenshot from 2024-01-04 17-02-061

How has this been tested?

I set up a public nginx proxy manager on https://dev.cvat.mycompany.com, and it proxies to http://192.168.1.123:8080 (my cvat machine). Features such as import dataset didn't work because it uses TUS Resumable, which was returning the wrong HTTP scheme. After the change, the feature works when the proxy server and cvat runs in different HTTP scheme.

Checklist

If an item isn't applicable for some reason, then explicitly strikethrough the whole
line. If you don't do that, GitHub will show incorrect progress for the pull request.
If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

  • I submit my changes into the develop branch
    - [ ] I have created a changelog fragment
    - [ ] I have updated the documentation accordingly
    - [ ] I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
    - [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Improved handling of file upload requests by prioritizing the HTTP_ORIGIN header for location construction.
  • Bug Fixes

    • Enhanced compatibility with cross-origin requests, potentially resolving issues related to file uploads in specific client configurations.

- Check if HTTP_ORIGIN exists in the request.META, if it does, use the same http scheme for the TUS location uri. If not exist, use Django's build_absolute_uri() for the TUS location uri.
Copy link
Contributor

coderabbitai bot commented Aug 22, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve modifying the logic for constructing the location variable within the init_tus_upload method in cvat/apps/engine/mixins.py. The update shifts the condition to prioritize the HTTP_ORIGIN header over the HTTP_X_FORWARDED_HOST header for determining the request's origin. This alteration affects how file upload URLs are formed and may influence behavior in cross-origin scenarios.

Changes

Files Change Summary
cvat/apps/engine/mixins.py Modified logic in the init_tus_upload method to prioritize the HTTP_ORIGIN header over the HTTP_X_FORWARDED_HOST header for constructing the location.

Poem

🐰 In the land where uploads fly,
A change was made to let them sigh.
Origin now takes the lead,
Helping files with utmost speed.
Hooray for headers, clear and bright,
In the world of code, all feels right! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3fdb032 and 5c6d711.

Files selected for processing (1)
  • cvat/apps/engine/mixins.py (1 hunks)
Additional comments not posted (2)
cvat/apps/engine/mixins.py (2)

303-303: LGTM! The change aligns with the PR objective.

The modification to prioritize the HTTP_ORIGIN header is consistent with the goal of handling HTTPS reverse proxy scenarios.


303-303: Verify the correctness of location construction logic.

Ensure that the HTTP_ORIGIN header is correctly set and used in all relevant scenarios, especially when dealing with cross-origin requests.

Run the following script to verify the usage of HTTP_ORIGIN in the codebase:

Verification successful

Verified: Correct usage of HTTP_ORIGIN for location construction.

The HTTP_ORIGIN header is correctly used to construct the location variable in cvat/apps/engine/mixins.py. This change is consistent with handling cross-origin requests effectively.

  • File: cvat/apps/engine/mixins.py
    • Lines: Usage of HTTP_ORIGIN to construct location.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `HTTP_ORIGIN` in the codebase.

# Test: Search for occurrences of `HTTP_ORIGIN`. Expect: Correct usage in relevant scenarios.
rg --type python 'HTTP_ORIGIN'

Length of output: 61


Script:

#!/bin/bash
# Description: Verify the usage of `HTTP_ORIGIN` in the codebase.

# Test: Search for occurrences of `HTTP_ORIGIN`. Expect: Correct usage in relevant scenarios.
rg 'HTTP_ORIGIN'

Length of output: 207

Copy link

sonarcloud bot commented Aug 26, 2024

@drguptavivek
Copy link

any chance this will get merged soon ?

@drguptavivek
Copy link

Hi cargoculttech
Can you please suggest what commands I need to run after making the changes in cvat/apps/engine/mixins.py file please ?
I do not wish to destroy any containers as I already have data on them.

Does the following look right?

docker compose \
     -f docker-compose.yml \
     -f docker-compose.dev.yml \
      build

docker compose \
     -f docker-compose.yml \
      up -d

Thanks
Vivek

@drguptavivek
Copy link

Hi cargoculttech
Can you please suggest what commands I need to run after making the changes in cvat/apps/engine/mixins.py file please ?
Does the following look right?

docker compose \
     -f docker-compose.yml \
     -f docker-compose.dev.yml \
     -f docker-compose.settings_overlay.local.yml     \
      build

docker compose \
     -f docker-compose.yml \
     -f docker-compose.settings_overlay.local.yml     \
      up -d

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.

3 participants