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

adding sort option for build-classpath #188

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

Conversation

rmannibucau
Copy link

For now it is a proposal since jira status is quite weird regarding that but I fail to see how to have a deterministic build without such an option so proposing a solution and will create tickets if there is an agreement on the solution.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MDEP-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MDEP-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@michael-o
Copy link
Member

What is the benefit? The same request keeps popping up with Tomcat and the classpath does not rely on order.

@rmannibucau
Copy link
Author

@michael-o well you should consider these points:

  1. if not sorted then nothing is reproducible in java world so the build-classpath mojo requires a postprocessor or replacement for all consumer of the output (downstream mojo, custom runtime code etc) - including a java -cp @<cp from build-classpath> MyMain kind of commands or jib based builds or CDS archive build ...
  2. tomcat has solutions for that - mainly custom webapploader/classloader or OS specific stuff - even if tomcat itself does not want to do the integration out of the box for the same reason so even if the project rejects the features some users rely on it

I'm not 100% sure if we need more flexibility on the ordering but not sorting the output is quite useless for any pipeline relying on the classpath dump (it is fine for other use cases) so hope we can find a way to sort somehow whatever the order is.

Hope it makes sense.

@michael-o
Copy link
Member

For debug purposes I understand that a canonization makes sense, but bit for the actual class path. That should always work.

@rmannibucau
Copy link
Author

Classpath is a sorted list in the jvm so order is important for classes and resources. Custom classloaders are unrelated to the classpath and dont have to respect that even if all "true" urlclassloaders will. But here we speak of classpath so order is a thing.

Copy link
Member

@slawekjaranowski slawekjaranowski left a comment

Choose a reason for hiding this comment

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

For new feature jira issue is appreciated.

/**
* Should the classpath be lexicographically sorted.
*/
@Parameter( property = "mdep.sortClasspath", defaultValue = "false" )
Copy link
Member

Choose a reason for hiding this comment

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

@since tag is missing

* Should the classpath be lexicographically sorted.
*/
@Parameter( property = "mdep.sortClasspath", defaultValue = "false" )
private boolean sortClasspath = false;
Copy link
Member

Choose a reason for hiding this comment

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

false is default value, initialization is redundant

@michael-o
Copy link
Member

michael-o commented Feb 9, 2022

Classpath is a sorted list in the jvm so order is important for classes and resources. Custom classloaders are unrelated to the classpath and dont have to respect that even if all "true" urlclassloaders will. But here we speak of classpath so order is a thing.

Ordered != sorted. Where is the sort? Show me!

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