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

Enforce openjdk 21, part 4/4 (Purple, Sage, Sigs, Virusinterpreter) #52274

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

luan-n-nguyen
Copy link
Contributor

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

📝 Walkthrough

Walkthrough

This pull request introduces modifications to the meta.yaml files for multiple hmftools packages. The changes include updates to version numbers and build numbers across the packages. Specifically, the hmftools-purple package's build number is increased from 2 to 3, and its OpenJDK requirement is revised to a version range of >=8,<=21. The hmftools-sage package sees its version updated to "4.0_beta.3" and its build number incremented from 3 to 4, with a similar OpenJDK requirement adjustment. The hmftools-sigs package's build number is updated from 0 to 1, along with a change in the OpenJDK requirement to >=8,<=21. Lastly, the hmftools-virus-interpreter package has its version set to "3.7_beta," its build number increased from 0 to 1, and the OpenJDK requirement adjusted to the same version range. The source URLs and other metadata remain unchanged across these packages.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • martin-g
  • mencian

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 (1)
recipes/hmftools-purple/meta.yaml (1)

Line range hint 16-31: Recipe structure follows best practices

The recipe demonstrates good practices:

  • Proper use of run_exports for dependency pinning
  • Well-defined R and Bioconductor dependencies
  • Appropriate version constraints for critical dependencies like circos

Consider documenting the rationale for the specific version constraints in the recipe, particularly for dependencies like circos >=0.69.6 and perl-gd >=2.76, to help future maintainers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d0834c4 and f23ae2d.

📒 Files selected for processing (4)
  • recipes/hmftools-purple/meta.yaml (1 hunks)
  • recipes/hmftools-sage/meta.yaml (1 hunks)
  • recipes/hmftools-sigs/meta.yaml (1 hunks)
  • recipes/hmftools-virus-interpreter/meta.yaml (1 hunks)
🔇 Additional comments (6)
recipes/hmftools-sigs/meta.yaml (2)

14-14: LGTM: Build number increment is appropriate

The build number increment is correct as we're modifying package requirements.


21-21: LGTM: OpenJDK requirement change aligns with project goals

The OpenJDK version constraint >=8,<=21 appropriately enforces OpenJDK 21 as the upper bound while maintaining backward compatibility.

Let's verify consistency of OpenJDK requirements across related packages:

✅ Verification successful

OpenJDK requirement update aligns with other HMF tools

The OpenJDK version constraint >=8,<=21 in hmftools-sigs is consistent with the evolving pattern in the HMF tools suite. Several other HMF tools (virus-interpreter, redux, purple) have already adopted this upper bound constraint, while others are still using the minimum requirement of >=8. This change maintains backward compatibility while adding a sensible upper bound.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify OpenJDK requirements are consistent across hmftools packages
# Expected: All hmftools packages should use the same OpenJDK version constraint

# Search for OpenJDK requirements in hmftools recipes
fd 'meta.yaml' recipes/hmftools- --exec rg -l 'openjdk' {} | \
while read -r file; do
    echo "=== $file ==="
    rg 'openjdk.*' "$file"
done

Length of output: 178


Script:

#!/bin/bash
# Let's try a different approach to find hmftools recipes
fd 'meta.yaml' -p 'hmftools-.*' --exec rg -l 'openjdk' {} | \
while read -r file; do
    echo "=== $file ==="
    rg 'openjdk.*' "$file"
done

Length of output: 171


Script:

#!/bin/bash
# Let's try a simpler approach to find all meta.yaml files with openjdk requirements
rg -l "openjdk" ".*meta.yaml$"

# Then examine the content of found files
echo "=== Found files with their openjdk requirements ==="
rg "openjdk.*" ".*meta.yaml$"

Length of output: 281


Script:

#!/bin/bash
# Search for meta.yaml files containing openjdk requirements
find . -name "meta.yaml" -type f -exec grep -l "openjdk" {} \;

# Show the openjdk requirements from these files
echo "=== OpenJDK requirements in meta.yaml files ==="
find . -name "meta.yaml" -type f -exec sh -c 'echo "=== $1 ==="; grep "openjdk" "$1"' sh {} \;

Length of output: 200000


Script:

#!/bin/bash
# Let's try a more targeted approach to find OpenJDK requirements in hmftools packages
rg -l "openjdk" recipes/hmftools-*/meta.yaml | \
while read -r file; do
    echo "=== $file ==="
    rg "openjdk.*" "$file"
done

Length of output: 4904

recipes/hmftools-virus-interpreter/meta.yaml (1)

14-14: LGTM! Build number increment is appropriate.

The build number increment follows Conda packaging best practices for package updates.

recipes/hmftools-purple/meta.yaml (1)

15-15: LGTM: Build number increment is appropriate

The build number increment is correct and follows Conda packaging guidelines.

recipes/hmftools-sage/meta.yaml (2)

15-15: LGTM: Build number increment is appropriate

The build number increment is correct as we're rebuilding the package with modified dependencies.


22-22: Verify OpenJDK version compatibility with upstream

While the OpenJDK version constraint >=9,<=21 aligns with the PR objectives, let's verify this range is supported by the upstream project.

run_exports:
- {{ pin_subpackage("hmftools-virus-interpreter", max_pin="x.x") }}

requirements:
run:
- openjdk >=8
- openjdk >=8,<=21
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

OpenJDK constraints are inconsistent across hmftools packages

The verification reveals inconsistencies in OpenJDK version constraints across hmftools packages:

  • Most packages specify only a lower bound >=8
  • A few packages (virus-interpreter, sage, redux, purple, sigs) include an upper bound <=21
  • One package (sage) has a different lower bound >=9
  • One package (break-point-inspector) has no version constraint

The current change to virus-interpreter (>=8,<=21) is not consistent with the majority of hmftools packages, which only specify a lower bound.

🔗 Analysis chain

Verify consistency of OpenJDK constraints across hmftools packages.

While the constraint change aligns with the PR objective to enforce OpenJDK 21, let's verify this is consistent across all hmftools packages.

Consider if the upper bound of <=21 might be too restrictive for future updates. A more flexible approach might be to use >=8,<22 to allow for point releases of OpenJDK 21, while still preventing upgrades to future major versions without explicit testing.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check OpenJDK constraints across hmftools packages
# Expected: All hmftools packages should have the same OpenJDK constraint

echo "Checking OpenJDK constraints in hmftools packages:"
fd -t f "meta.yaml" recipes/hmftools- -x grep -H "openjdk" {}

Length of output: 277


Script:

#!/bin/bash
# Let's try a different approach using ripgrep to find hmftools recipes
# and check their OpenJDK constraints
echo "Searching for hmftools meta.yaml files and their OpenJDK constraints:"
rg -l "hmftools" --type yaml | grep "meta.yaml" | xargs grep -H "openjdk"

Length of output: 1492

run_exports:
- {{ pin_subpackage('hmftools-purple', max_pin="x") }}

requirements:
run:
- zlib
- openjdk >=8
- openjdk >=8,<=21
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

OpenJDK version constraints are inconsistent across hmftools packages

The verification reveals inconsistencies in OpenJDK version constraints across hmftools packages:

  • Only 4 packages specify the upper bound <=21: purple, redux, sage (>=9), and virus-interpreter
  • All other packages (19) only specify the lower bound >=8
  • One package (sage) has a different minimum version requirement >=9

These inconsistencies should be addressed to maintain uniformity across the hmftools suite.

🔗 Analysis chain

Verify OpenJDK version constraint consistency

The OpenJDK version constraint >=8,<=21 aligns with the PR objectives. Let's verify this constraint is consistent across related packages.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check OpenJDK version constraints across hmftools packages
# Expected: All hmftools packages should use the same OpenJDK version constraint

echo "Checking OpenJDK constraints in hmftools packages:"
fd 'meta.yaml$' recipes/hmftools- --exec grep -H 'openjdk' {}

Length of output: 279


Script:

#!/bin/bash
# Let's try a different approach to find hmftools packages
echo "Finding hmftools packages:"
fd 'meta.yaml$' | grep 'hmftools'

echo -e "\nChecking OpenJDK constraints in these packages:"
fd 'meta.yaml$' | grep 'hmftools' | xargs grep -H 'openjdk'

Length of output: 2266

@luan-n-nguyen
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 21, 2024
@bgruening
Copy link
Member

@luan-n-nguyen can you remind me please why this is needed? Is JDK22+ breaking things?

@luan-n-nguyen
Copy link
Contributor Author

Hi, yes this is to prevent the Ljdk.internal.vm.FillerArray issue which happens during multithreading with memory pressure. We tried changing the java code to circumvent this error, but the only surefire way to prevent the error was to ensure openjdk 22 was not used.

@mencian mencian merged commit 16f4712 into bioconda:master Nov 25, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants