Add a way to skip reference repositories

[tivervac]

This goes hand in hand with the PR in PDE. If there's a way to achieve this without editing the public API in IPlanner, I would much prefer it.

Seeing how FOLLOW_ARTIFACT_REPOSITORY_REFERENCES was always hardcoded to true in ProvisioningContext, I feel like someone wanted to implement something similar at some point, but didn't get around to it.

For versioning, I just followed the quick fixes, I hope this is correct.

[merks]

I’ll look in detail tomorrow. I just wonder how p2 director already supports the -followReferences option (off by default) with the current implementation.

https://help.eclipse.org/latest/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/p2_director.html

I also recall when oomph’s p2 director task didn’t follow references and I had change something to enable that. That’s a few years back…

[laeubi]

@tivervac the value is hardcoded in the constructor but code creating the provisioning context can still override that value by calling setProperty(FOLLOW_ARTIFACT_REPOSITORY_REFERENCES, "false") so I don't think we need a new constructor parameter but make the property public.
@merks thats exactly how DirecorApplication works, but currently uses a copy of the constant FOLLOW_ARTIFACT_REPOSITORY_REFERENCES

Also note that there is another property FOLLOW_REPOSITORY_REFERENCES for metadata repositories what already is public.

[merks]

This is specifically where the director application configures that:

p2/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/DirectorApplication.java

Lines 1063 to 1064 in 1b21340

	context.setProperty(ProvisioningContext.FOLLOW_REPOSITORY_REFERENCES, String.valueOf(followReferences));
	context.setProperty(FOLLOW_ARTIFACT_REPOSITORY_REFERENCES, String.valueOf(followReferences));

So I don't think this PR is needed because one can always achieve the goal by configuring the context properties.

[laeubi]

So I don't think this PR is needed because one can always achieve the goal by configuring the context properties.

As mentioned the property is private, we should make it public instead of maintain just another copy at PDE soon.
Beside that, it might be worth to have a method ProvisioningContext#setFollowReferences(boolean) that simply sets both properties to true/false to cover the common case and make this more obvious.

[merks]

Let's not pollute the API with convenience methods that then must interact properly with the property settings. In any case, that's not what this PR does.

Note that this is public:

• p2/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/ProvisioningContext.java

  Line 98 in 1b21340

  public static final String FOLLOW_REPOSITORY_REFERENCES = "org.eclipse.equinox.p2.director.followRepositoryReferences"; //$NON-NLS-1$

But this is not:

• p2/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/p2/engine/ProvisioningContext.java

  Line 110 in 1b21340

  private static final String FOLLOW_ARTIFACT_REPOSITORY_REFERENCES = "org.eclipse.equinox.p2.director.followArtifactRepositoryReferences"; //$NON-NLS-1$

That one could and probably should be made public and that would avoid the copy in the director:

But that's also not what this PR does. So we don't need this PR but a different PR to make the constant public seems helpful.

[tivervac]

@tivervac the value is hardcoded in the constructor but code creating the provisioning context can still override that value by calling setProperty(FOLLOW_ARTIFACT_REPOSITORY_REFERENCES, "false") so I don't think we need a new constructor parameter but make the property public. @merks thats exactly how DirecorApplication works, but currently uses a copy of the constant FOLLOW_ARTIFACT_REPOSITORY_REFERENCES

Also note that there is another property FOLLOW_REPOSITORY_REFERENCES for metadata repositories what already is public.

Right, the copy is what threw me off. I did a find references on FOLLOW_ARTIFACT_REPOSITORY_REFERENCES and didn't see it used in any set context. I'll make the constant public to make sure other people don't hit the same mistake. Once I've confirmed that setting the properties solves my issue, I'll close this PR. Thanks for the help both!

[tivervac]

Settings the property works for my usecase \o/

[merks]

@tivervac

Thanks for taking the time to contribute to such a complex project where it's all too easy to be thrown off by the endless details!

[tivervac]

Replaced by #506