Absence of an unpack attribute must not result in BundleShapeAdvice #477
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently the FeaturesAction assumes that the unpack attribute is always set, if that is not the case it leads to unexpected results because then unpack=true is assumed always. This is especially dangerous as PDE since 2023-12 release removes the attributes and Tycho assume they are false by default the same as PDE has done in the past when adding new items. To mitigate this this adds an additional check to only evaluate the unpack if it is set, together with a testcase that covers all possible combinations.
|
The change looks good to me. I would like to get @merks review here too as we are really late in the game. |
13 tasks
akurtakov
approved these changes
Feb 29, 2024
HeikoKlare
approved these changes
Feb 29, 2024
There was a problem hiding this comment.
The change looks good to me.
- The change is sound. From understanding an unspecified
unpackshould have never defaulted totrueand that is what this change fixes. - The change fixes the problem I have originally reported.
Thanks for providing a fix to quickly, @laeubi!
merks
approved these changes
Feb 29, 2024
|
For the record - PMC approved |
|
I build started here: https://ci.eclipse.org/releng/job/Builds/job/I-build-4.31/162/ |
tjwatson
reviewed
Feb 29, 2024
| @@ -186,7 +186,7 @@ private void createAdviceFileAdvice(Feature feature, IPublisherInfo publisherInf | |||
| private void createBundleShapeAdvice(Feature feature, IPublisherInfo publisherInfo) { | |||
| FeatureEntry entries[] = feature.getEntries(); | |||
| for (FeatureEntry entry : entries) { | |||
| if (entry.isUnpack() && entry.isPlugin() && !entry.isRequires()) | |||
| if (entry.unpackSet() && entry.isUnpack() && entry.isPlugin() && !entry.isRequires()) | |||
There was a problem hiding this comment.
It would seem there is a bug in isUnpack if we want the default to be false. For a future release we should consider if this is correct for isUnpack:
public boolean isUnpack() {
return (unpack != null && unpack.booleanValue());
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the FeaturesAction assumes that the unpack attribute is always set, if that is not the case it leads to unexpected results because then unpack=true is assumed always. This is especially dangerous as PDE since 2023-12 release removes the attributes and Tycho assume they are false by default the same as PDE has done in the past when adding new items.
To mitigate this this adds an additional check to only evaluate the unpack if it is set, together with a testcase that covers all possible combinations.
I give +1 as project lead for this really late fix but I think it is urgent enough as it has unexpected side-effects for users using already released PDE that will likely be hard to discover and the previous state was to always specify this attribute so existing setup won't be affected. Waiting for one more release to fix this seems therefore not acceptable for me.