[MSHADE-307] adding useDefaultConfiguration flag in ShadeMojo #11

rmannibucau · 2018-12-15T20:39:41Z

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 [MSHADE-XXX] - Fixes bug in ApproximateQuantiles,
where you replace MSHADE-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.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.
I'm already an ASF committer

eolivelli

Very useful!

I am sure about the name. A 'default' configuration which is not active by default sounds weird.

What about about 'safe', 'common', 'standard'....

rmannibucau · 2018-12-15T23:59:48Z

Common sounds a good alternative but too generic, I thought about "auto" but was not that happy too. Maybe "autoConfigure" + adding a spi on transformers and filters would make more sense?

eolivelli · 2018-12-16T07:07:39Z

autoConfigure + SPI will be great, but it a more complex change.

The other way would be to have such "useDefaultConfiguration", turned on by default, but with a bump in the major version for the plugin.

@rfscholte what do you think ?

rfscholte · 2018-12-16T10:16:59Z

In general I'd like prefer to keep the number of parameters to a minimum. So if we want to do this, why not set these as defaults. When there are explicit filters/transformers, these will be used. Any empty list would mean: no filters or transformers. And this implies there should be an explicit filter for signatures.

eolivelli · 2018-12-16T10:28:52Z

Changing defaults needs a bump in major version ?

These new defaults are safe but not obvious.

I am +1 in changing defaults

rfscholte · 2018-12-16T10:32:59Z

The new version will be 3.n+1.0. The first 3 means that is requires at least Maven 3. We discovered that this pattern makes is very clear when certain plugins can be used.
We should add this change to the index.html file too, just to be clear. (in the end the result should be the same, because if filters and transformers are specified, nothing will change)

rmannibucau · 2018-12-16T11:16:43Z

Hmm, i thought of that - active by default and ignored if set by the user - but it is rare it is sufficient and does need a log4j, openwebbeans or other transformer so i preferred the composition. Should we have it with 3 values: default = use, skip and merge?

eolivelli · 2018-12-16T11:55:02Z

Okay for versioning and index.html
I can take of take (with a little guidance).

For use/skip/merge....things are getting complicated and complicated.

We should default to 'merge', but will 'use' be useful? As 'merge' is a super set of 'use'

rfscholte · 2018-12-16T12:22:04Z

For use/skip/merge....things are getting complicated and complicated.

I totally agree here. Like all Maven plugin parameters it is: use the default or override it. Those are the only 2 modes, clear and simple.

rmannibucau · 2018-12-16T12:34:04Z

Hmm it must be combinable or it is useless and config stays complex.

Merge (default), override, skip?

rfscholte · 2018-12-16T12:42:42Z

Sorry, but it will be default or override: easy to understand and maximum control. If you want full merge/override-control, you need to do that with the magic attributes as described at https://blog.sonatype.com/2011/01/maven-how-to-merging-plugin-configuration-in-complex-projects/

rmannibucau · 2018-12-16T15:14:08Z

@rfscholte this is my intention but here it does not work cause the config is implicit, this is why i proposed 3 states. Now if you say the impl is ok to turn on by default it can be enough for the next release (and we enhance later if needed). If so, do you have a name preference?

rfscholte · 2018-12-16T15:21:10Z

If so, do you have a name preference?

for what?

rmannibucau · 2018-12-16T15:23:20Z

@rfscholte "useDefaultConfiguration" was not liked by @eolivelli and I have to admit I'm not fan of "common" usage so asking for options here

I will try to PoC the SPI idea now to let us "see it" before going with your other options which seems to kill the idea to simplify the config of the plugin.

rfscholte · 2018-12-16T15:24:31Z

there's no need for this parameter. Just remove it

rmannibucau · 2018-12-16T15:50:34Z

Guys, I added the SPI and removed the toggle, can you have a look and let me know if it looks better this way? I like this solution cause we can plug the SPI in log4j, openwebbeans, and other extensions

rfscholte · 2018-12-16T16:07:28Z

src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java

        if ( transformers == null )
        {
-            return Collections.emptyList();
+            return resourceTransformers;


You're still merging. Here you should replace Collections.emptyList() with getDefaultResourceTransformers()

this is the case, resourceTransformers is initialized with getDefaultResourceTransformers. If the else skips the default transformers the feature is pointless since in 80% of the case you need to add a custom transformer or customize a config (like mainClass for the manifest)

Let's agree to disagree

I'm fine to disagree but I'd like to solve the issue which aims to reduce the entry cost of the plugin and save hours of debug time due to a bad packaging which is hard to identify - and even more with jpms since module-info.java drops SPI registration :s.

any alternative proposal to have a trivial to enable good auto configuration compatible with user customizations?

Can't think of a clean, clear and simple solution yet. So let's split it into 2 issues: 1. have good default transformers; 2. combine default+custom transfomers

Ok, let's split. Just to ensure I get it and not do work for nothing, it means 3 PR - no order:

defaults (transformers and filters)

SPI

combine
?

1 done at #12
2 done at #13

will let 3 to a bit later to see if we find a good idea

rfscholte · 2018-12-16T16:10:03Z

src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java


-        return Arrays.asList( transformers );
+    private List<ResourceTransformer> getDefaultResourceTransformers()
+    {


Since we're not merging, so you can return a list with these 2 transformers.
Also document this on the transfomers-parameter.

guess it is addressed by previous comment, we want to merge ;)

rfscholte · 2018-12-16T16:12:45Z

src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java

@@ -823,6 +844,50 @@ private File resolveArtifactSources( Artifact artifact )
            }
        }

+        // first check for backward compatibility this is not already configured explicitly
+        boolean addExclusion = true;


We need a similar trick here:

public Collection<Filter> getFilters() { if ( this.filters == null ) { return defaultFilters(); } else { return this.filters; } }

likely the same

rfscholte · 2018-12-16T16:15:29Z

src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java

+                    new HashSet<String>( Arrays.asList( "META-INF/*.SF", "META-INF/*.DSA", "META-INF/*.RSA" ) ) ) );
+        }
+
+        for ( final Filter filter : ServiceLoader.load( Filter.class ) )


Using ServiceLoader requires a separate JIRA issue, and I wonder if this is going to work. See https://issues.apache.org/jira/browse/MNG-6275

It must work if the extension is added in plugin dependencies as commonly done for transformers - http://openwebbeans.apache.org/meecrowave/meecrowave-maven/index.html#_shading for example. About the other issue: it can be the case but the issue is to make the configuration easier, if we don't want of a toggle then the SPI is the answer so it is the same issue, no?

eolivelli requested changes Dec 15, 2018

View reviewed changes

rfscholte requested changes Dec 16, 2018

View reviewed changes

[MSHADE-307] - adding useDefaultConfiguration flag in ShadeMojo

6300425

rmannibucau force-pushed the adding-useDefaultConfiguration-toggle branch from ad66d55 to 6300425 Compare August 8, 2019 10:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MSHADE-307] adding useDefaultConfiguration flag in ShadeMojo #11

[MSHADE-307] adding useDefaultConfiguration flag in ShadeMojo #11

rmannibucau commented Dec 15, 2018

eolivelli left a comment

rmannibucau commented Dec 15, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

rmannibucau Dec 19, 2018 •

edited

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

rfscholte Dec 16, 2018

rmannibucau Dec 16, 2018

[MSHADE-307] adding useDefaultConfiguration flag in ShadeMojo #11

Are you sure you want to change the base?

[MSHADE-307] adding useDefaultConfiguration flag in ShadeMojo #11

Conversation

rmannibucau commented Dec 15, 2018

eolivelli left a comment

Choose a reason for hiding this comment

rmannibucau commented Dec 15, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

eolivelli commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

rfscholte commented Dec 16, 2018

rmannibucau commented Dec 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmannibucau Dec 19, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmannibucau Dec 19, 2018 •

edited