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

Move --no-binary=lxml,xmlsec into the Dockerfile #8361

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Aug 27, 2024

Motivation and context

The intention was for this option to only be set in the production requirements file, but due to how pip-compile-multi works, it ends up leaking into all other files too. Moving it to the Dockerfile fixes this.

How has this been tested?

I re-ran the Docker build to make sure lxml and xmlsec are actually built from source.

Checklist

  • 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

    • Updated dependency management to allow binary distributions for lxml and xmlsec, improving installation flexibility.
  • Bug Fixes

    • Adjusted the specification for dj-rest-auth to ensure correct package resolution during installation.
  • Chores

    • Cleaned up formatting in requirement files for better readability.

The intention was for this option to only be set in the production
requirements file, but due to how pip-compile-multi works, it ends up
leaking into all other files too. Moving it to the Dockerfile fixes
this.
Copy link
Contributor

coderabbitai bot commented Aug 27, 2024

Walkthrough

The changes involve modifications to several requirements files related to Python package management. Key alterations include the removal of --no-binary directives for the lxml and xmlsec packages, allowing for binary installations. Additionally, there is a minor formatting change in the specification of the dj-rest-auth package. Overall, the updates simplify the dependency management process without altering the core functionality of the application.

Changes

Files Change Summary
cvat/requirements/all.txt, Removed --no-binary lxml and --no-binary xmlsec, allowing for binary distributions of these packages.
cvat/requirements/development.txt, Removed --no-binary lxml and --no-binary xmlsec, simplifying package installation.
cvat/requirements/production.in, Changed lxml and xmlsec from no-binary to allowing binary installations.
cvat/requirements/production.txt Removed --no-binary lxml and --no-binary xmlsec.
cvat/requirements/base.txt Changed dj-rest-auth[with-social]==5.0.2 to dj-rest-auth[with_social]==5.0.2.
cvat/requirements/testing.txt Removed a blank line for formatting purposes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant PackageManager

    User->>App: Request to install packages
    App->>PackageManager: Process installation
    PackageManager->>PackageManager: Check dependencies
    PackageManager->>PackageManager: Install dependencies (binary if available)
    PackageManager-->>App: Return installation status
    App-->>User: Confirm package installation
Loading

🐰 In the meadow where bunnies play,
The packages dance, hip-hip-hooray!
No more binaries to chase away,
With simpler paths, we hop all day!
Let's celebrate, with joy and cheer,
For smoother installs, we hold so dear! 🌼


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 ec28076 and 2af816c.

Files selected for processing (7)
  • Dockerfile (1 hunks)
  • cvat/requirements/all.txt (1 hunks)
  • cvat/requirements/base.txt (2 hunks)
  • cvat/requirements/development.txt (1 hunks)
  • cvat/requirements/production.in (1 hunks)
  • cvat/requirements/production.txt (1 hunks)
  • cvat/requirements/testing.txt (1 hunks)
Files skipped from review due to trivial changes (4)
  • cvat/requirements/base.txt
  • cvat/requirements/development.txt
  • cvat/requirements/production.txt
  • cvat/requirements/testing.txt
Additional comments not posted (3)
cvat/requirements/production.in (1)

Line range hint 1-7: Verify the impact of removing --no-binary directive.

The removal of the --no-binary directive for lxml and xmlsec simplifies the dependency declaration. Ensure that this change does not affect the functionality of the application, especially in production environments where these libraries are critical.

Run the following script to check for potential issues:

cvat/requirements/all.txt (1)

Line range hint 1-13: Verify the impact of removing --no-binary directive.

The removal of the --no-binary directive for lxml and xmlsec simplifies the dependency declaration. Ensure that this change does not affect the functionality of the application, especially in production environments where these libraries are critical.

Run the following script to check for potential issues:

Dockerfile (1)

83-84: LGTM!

The addition of the --no-binary directive ensures that lxml and xmlsec are built from source. This change addresses issues related to binary distributions of these libraries.

The code changes are approved.

@SpecLad
Copy link
Contributor Author

SpecLad commented Aug 28, 2024

@Marishka17 What do you think?

@Marishka17
Copy link
Contributor

@SpecLad, I liked when --no-binary lxml,xmlsec was in the file with production requirements because all requirements' details were in one place. However, that approach required updating generated .txt files manually. That was not convenient and obviously generated files should not be updated manually. So, thanks, that fixed that.
I would only ask to create PR in the private repo just to be sure that authentication tests pass (before merging this one).

@SpecLad
Copy link
Contributor Author

SpecLad commented Aug 29, 2024

Alright, I tested it.

@SpecLad SpecLad merged commit c1a39d8 into cvat-ai:develop Aug 29, 2024
32 checks passed
@SpecLad SpecLad deleted the dockerfile-no-binary branch August 29, 2024 11:05
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 2024
The intention was for this option to only be set in the production
requirements file, but due to how pip-compile-multi works, it ends up
leaking into all other files too. Moving it to the Dockerfile fixes
this.
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.

2 participants