Skip to content

Commit c315a0e

Browse files
reaver585reaver585
committed
Manually enforce platform constraints for conditional dependencies in QuarkusComponentVariants
Addresses #49743
1 parent 55be758 commit c315a0e

File tree

31 files changed

+786
-42
lines changed

31 files changed

+786
-42
lines changed

‎devtools/gradle/gradle-model/src/main/java/io/quarkus/gradle/dependency/ApplicationDeploymentClasspathBuilder.java‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import org.gradle.api.internal.tasks.TaskDependencyFactory;
3030
import org.gradle.api.plugins.JavaPlugin;
3131
import org.gradle.api.provider.ListProperty;
32+
import org.gradle.api.provider.Property;
3233

3334
import io.quarkus.bootstrap.BootstrapConstants;
3435
import io.quarkus.bootstrap.model.PlatformImports;
@@ -38,6 +39,7 @@
3839
import io.quarkus.gradle.tooling.dependency.DependencyUtils;
3940
import io.quarkus.gradle.tooling.dependency.ExtensionDependency;
4041
import io.quarkus.maven.dependency.ArtifactCoords;
42+
import io.quarkus.maven.dependency.ArtifactKey;
4143
import io.quarkus.runtime.LaunchMode;
4244

4345
public class ApplicationDeploymentClasspathBuilder {
@@ -93,13 +95,14 @@ public static void initConfigurations(Project project) {
9395
final ConfigurationContainer configContainer = project.getConfigurations();
9496

9597
// Custom configuration for dev mode
96-
configContainer.register(ToolingUtils.DEV_MODE_CONFIGURATION_NAME, config -> {
97-
config.extendsFrom(configContainer.getByName(JavaPlugin.IMPLEMENTATION_CONFIGURATION_NAME));
98-
config.setCanBeConsumed(false);
99-
if (!isDisableComponentVariants(project)) {
100-
QuarkusComponentVariants.setConditionalAttributes(config, project, LaunchMode.DEVELOPMENT);
101-
}
102-
});
98+
configContainer
99+
.register(ToolingUtils.DEV_MODE_CONFIGURATION_NAME, config -> {
100+
config.extendsFrom(configContainer.getByName(JavaPlugin.IMPLEMENTATION_CONFIGURATION_NAME));
101+
config.setCanBeConsumed(false);
102+
if (!isDisableComponentVariants(project)) {
103+
QuarkusComponentVariants.setConditionalAttributes(config, project, LaunchMode.DEVELOPMENT);
104+
}
105+
});
103106

104107
// Base runtime configurations for every launch mode
105108
configContainer
@@ -178,6 +181,7 @@ private static Configuration[] getOriginalRuntimeClasspaths(Project project, Lau
178181
private final String platformImportName;
179182

180183
private final List<Dependency> platformDataDeps = new ArrayList<>();
184+
private final Map<ArtifactKey, PlatformSpec.Constraint> platformConstraints = new HashMap<>();
181185

182186
public ApplicationDeploymentClasspathBuilder(Project project, LaunchMode mode,
183187
TaskDependencyFactory taskDependencyFactory) {
@@ -239,6 +243,13 @@ private void setUpPlatformConfiguration() {
239243
break;
240244
}
241245
}
246+
} else {
247+
ArtifactKey artifactKey = ArtifactKey.ga(d.getTarget().getGroup(), name);
248+
platformConstraints.computeIfAbsent(artifactKey,
249+
k -> new PlatformSpec.Constraint(
250+
d.getTarget().getGroup(),
251+
name,
252+
d.getTarget().getVersion()));
242253
}
243254
});
244255
});
@@ -276,14 +287,22 @@ private List<Dependency> resolvePlatformDependencies() {
276287
return platformDataDeps;
277288
}
278289

290+
private PlatformSpec resolvePlatformSpec() {
291+
getPlatformConfiguration().resolve();
292+
return new PlatformSpec(platformConstraints, getPlatformConfiguration().getExcludeRules());
293+
}
294+
279295
private void setUpRuntimeConfiguration() {
280296
if (!project.getConfigurations().getNames().contains(this.runtimeConfigurationName)) {
281297
final String baseConfig;
282298
final boolean disableComponentVariants = isDisableComponentVariants(project);
283299
if (disableComponentVariants) {
284300
baseConfig = ApplicationDeploymentClasspathBuilder.getBaseRuntimeConfigName(mode);
285301
} else {
286-
QuarkusComponentVariants.addVariants(project, mode);
302+
Property<PlatformSpec> platformSpecProperty = project.getObjects()
303+
.property(PlatformSpec.class);
304+
QuarkusComponentVariants.addVariants(project, mode,
305+
platformSpecProperty.value(project.provider(this::resolvePlatformSpec)));
287306
baseConfig = QuarkusComponentVariants.getConditionalConfigurationName(mode);
288307
}
289308
project.getConfigurations().register(this.runtimeConfigurationName, configuration -> {

‎devtools/gradle/gradle-model/src/main/java/io/quarkus/gradle/dependency/PlatformSpec.java‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
package io.quarkus.gradle.dependency;
2+
3+
import java.util.Map;
4+
import java.util.Set;
5+
6+
import org.gradle.api.artifacts.ExcludeRule;
7+
8+
import io.quarkus.maven.dependency.ArtifactKey;
9+
10+
class PlatformSpec {
11+
private final Map<ArtifactKey, Constraint> constraints;
12+
private final Set<ExcludeRule> exclusions;
13+
14+
public PlatformSpec(Map<ArtifactKey, Constraint> constraints, Set<ExcludeRule> exclusions) {
15+
this.constraints = constraints;
16+
this.exclusions = exclusions;
17+
}
18+
19+
public Map<ArtifactKey, Constraint> getConstraints() {
20+
return constraints;
21+
}
22+
23+
public Set<ExcludeRule> getExclusions() {
24+
return exclusions;
25+
}
26+
27+
static class Constraint {
28+
private final String groupId;
29+
private final String artifactId;
30+
private final String version;
31+
32+
public Constraint(String groupId, String artifactId, String version) {
33+
this.groupId = groupId;
34+
this.artifactId = artifactId;
35+
this.version = version;
36+
}
37+
38+
public String getGroupId() {
39+
return groupId;
40+
}
41+
42+
public String getArtifactId() {
43+
return artifactId;
44+
}
45+
46+
public String getVersion() {
47+
return version;
48+
}
49+
}
50+
}

‎devtools/gradle/gradle-model/src/main/java/io/quarkus/gradle/dependency/QuarkusComponentVariants.java‎

Lines changed: 60 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
import java.util.HashSet;
99
import java.util.List;
1010
import java.util.Map;
11+
import java.util.Objects;
12+
import java.util.Optional;
1113
import java.util.Set;
1214
import java.util.concurrent.atomic.AtomicInteger;
1315

@@ -28,6 +30,7 @@
2830
import org.gradle.api.attributes.java.TargetJvmEnvironment;
2931
import org.gradle.api.model.ObjectFactory;
3032
import org.gradle.api.provider.ListProperty;
33+
import org.gradle.api.provider.Property;
3134

3235
import io.quarkus.gradle.tooling.dependency.DependencyUtils;
3336
import io.quarkus.gradle.tooling.dependency.ExtensionDependency;
@@ -169,22 +172,26 @@ public static void setCommonAttributes(AttributeContainer attrs, ObjectFactory o
169172
* @param project project
170173
* @param mode launch mode
171174
*/
172-
public static void addVariants(Project project, LaunchMode mode) {
173-
new QuarkusComponentVariants(project, mode).configureAndAddVariants();
175+
public static void addVariants(Project project, LaunchMode mode,
176+
Property<PlatformSpec> platformSpecProperty) {
177+
new QuarkusComponentVariants(project, mode, platformSpecProperty).configureAndAddVariants();
174178
}
175179

176180
private final Attribute<String> quarkusDepAttr;
177181
private final Project project;
182+
private final Property<PlatformSpec> platformSpecProperty;
178183
private final Map<ArtifactKey, ProcessedDependency> processedDeps = new HashMap<>();
179184
private final Map<ArtifactKey, ConditionalDependency> allConditionalDeps = new HashMap<>();
180185
private final List<ConditionalDependencyVariant> dependencyVariantQueue = new ArrayList<>();
181186
private final Map<String, SatisfiedExtensionDeps> satisfiedExtensionDeps = new HashMap<>();
182187
private final LaunchMode mode;
183188
private final AtomicInteger configCopyCounter = new AtomicInteger();
184189

185-
private QuarkusComponentVariants(Project project, LaunchMode mode) {
190+
private QuarkusComponentVariants(Project project, LaunchMode mode,
191+
Property<PlatformSpec> platformSpecProperty) {
186192
this.project = project;
187193
this.mode = mode;
194+
this.platformSpecProperty = platformSpecProperty;
188195
this.quarkusDepAttr = getConditionalDependencyAttribute(project.getName(), mode);
189196
project.getDependencies().getAttributesSchema().attribute(quarkusDepAttr);
190197
project.getDependencies().getAttributesSchema().attribute(getDeploymentDependencyAttribute(project.getName(), mode));
@@ -407,7 +414,10 @@ private void processDependency(ProcessedDependency parent,
407414
}
408415

409416
private void queueConditionalDependency(ProcessedDependency parent, Dependency dep) {
410-
dependencyVariantQueue.add(new ConditionalDependencyVariant(parent.extension, getOrCreateConditionalDep(dep)));
417+
var conditionalDep = getOrCreateConditionalDep(dep);
418+
if (conditionalDep != null) {
419+
dependencyVariantQueue.add(new ConditionalDependencyVariant(parent.extension, conditionalDep));
420+
}
411421
}
412422

413423
private ConditionalDependency getOrCreateConditionalDep(Dependency dep) {
@@ -417,7 +427,7 @@ private ConditionalDependency getOrCreateConditionalDep(Dependency dep) {
417427
}
418428

419429
private ResolvedArtifact tryResolvingRelocationArtifact(Dependency dep) {
420-
final Configuration configForRelocated = project.getConfigurations().detachedConfiguration(dep).setTransitive(true);
430+
final Configuration configForRelocated = getDetachedWithExclusions(dep).setTransitive(true);
421431
setConditionalAttributes(configForRelocated, project, mode);
422432

423433
var firstLevelDeps = configForRelocated.getResolvedConfiguration().getFirstLevelModuleDependencies();
@@ -447,8 +457,10 @@ private ResolvedArtifact tryResolvingRelocationArtifact(Dependency dep) {
447457
return artifact;
448458
}
449459

450-
private ConditionalDependency newConditionalDep(Dependency dep) {
451-
final Configuration config = project.getConfigurations().detachedConfiguration(dep).setTransitive(false);
460+
private ConditionalDependency newConditionalDep(Dependency originalDep) {
461+
var dep = getConstrainedDep(originalDep);
462+
final Configuration config = getDetachedWithExclusions(dep).setTransitive(false);
463+
452464
setConditionalAttributes(config, project, mode);
453465
ResolvedArtifact resolvedArtifact = null;
454466

@@ -464,6 +476,11 @@ private ConditionalDependency newConditionalDep(Dependency dep) {
464476
}
465477

466478
if (resolvedArtifact == null) {
479+
// check if that's due to exclude rules, and if yes, ignore
480+
if (isExplicitlyExcluded(dep)) {
481+
project.getLogger().info("Conditional dependency {} ignored due to exclusion rule", dep);
482+
return null;
483+
}
467484
throw new RuntimeException(dep + " did not resolve to any artifacts");
468485
}
469486

@@ -474,6 +491,42 @@ private ConditionalDependency newConditionalDep(Dependency dep) {
474491

475492
}
476493

494+
private boolean isExplicitlyExcluded(Dependency dep) {
495+
return platformSpecProperty.get().getExclusions().stream().anyMatch(rule -> {
496+
// Do not abort if the group is null, allow the next comparison to take place
497+
if (rule.getGroup() != null && !Objects.equals(rule.getGroup(), dep.getGroup())) {
498+
return false;
499+
}
500+
// If we reached this point, and module of the rule is null, it is a match
501+
return rule.getModule() == null || Objects.equals(rule.getModule(), dep.getName());
502+
});
503+
}
504+
505+
private Configuration getDetachedWithExclusions(Dependency dep) {
506+
var c = project.getConfigurations().detachedConfiguration(dep);
507+
PlatformSpec platformSpec = platformSpecProperty.get();
508+
platformSpec.getExclusions().forEach(rule -> {
509+
Map<String, String> excludeProperties = new HashMap<>(2);
510+
excludeProperties.put("group", rule.getGroup());
511+
excludeProperties.put("module", rule.getModule());
512+
c.exclude(excludeProperties);
513+
});
514+
return c;
515+
}
516+
517+
private Dependency getConstrainedDep(Dependency dep) {
518+
return findMatchingConstraint(dep).map(c -> project.getDependencies().create(
519+
dep.getGroup() + ":" + dep.getName() + ":" + c.getVersion())).orElse(dep);
520+
}
521+
522+
private Optional<PlatformSpec.Constraint> findMatchingConstraint(Dependency dep) {
523+
PlatformSpec platformSpec = platformSpecProperty.get();
524+
Map<ArtifactKey, PlatformSpec.Constraint> constraints = platformSpec.getConstraints();
525+
PlatformSpec.Constraint matchingConstraint = constraints
526+
.get(ArtifactKey.ga(dep.getGroup(), dep.getName()));
527+
return Optional.ofNullable(matchingConstraint);
528+
}
529+
477530
private class ProcessedDependency {
478531
private final ResolvedArtifact artifact;
479532
private final ExtensionDependency<?> extension;

‎integration-tests/gradle/src/main/resources/enforcing-platform-for-conditional-deps/consumer-project/gradle.properties‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
quarkusPlatformArtifactId=quarkus-bom
2+
quarkusPlatformGroupId=io.quarkus
3+
org.gradle.logging.level=INFO

‎integration-tests/gradle/src/main/resources/enforcing-platform-for-conditional-deps/consumer-project/runner-enforced/build.gradle‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
plugins {
2+
id 'java'
3+
id 'io.quarkus'
4+
}
5+
6+
repositories {
7+
mavenLocal {
8+
content {
9+
includeGroup 'org.enforcing.deps' // for dependencies built in this test
10+
includeGroup 'org.enforcing.conditional' // for dependencies built in this test
11+
includeGroupByRegex 'io.quarkus.*'
12+
includeGroup 'org.hibernate.orm'
13+
}
14+
}
15+
mavenCentral()
16+
}
17+
18+
dependencies {
19+
implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
20+
implementation enforcedPlatform("org.enforcing.deps:test-bom:1.0.0")
21+
implementation 'io.quarkus:quarkus-rest'
22+
implementation 'org.enforcing.deps:ext-a:1.0-SNAPSHOT'
23+
testImplementation 'io.quarkus:quarkus-junit5'
24+
testImplementation 'io.rest-assured:rest-assured'
25+
}

‎integration-tests/gradle/src/main/resources/enforcing-platform-for-conditional-deps/consumer-project/runner-enforced/src/main/java/org/acme/HelloResource.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package org.acme;
2+
3+
import org.eclipse.microprofile.config.inject.ConfigProperty;
4+
5+
import jakarta.inject.Inject;
6+
import jakarta.ws.rs.GET;
7+
import jakarta.ws.rs.Path;
8+
import jakarta.ws.rs.Produces;
9+
import jakarta.ws.rs.core.MediaType;
10+
import java.io.IOException;
11+
import java.net.URL;
12+
import java.util.Enumeration;
13+
14+
@Path("/hello")
15+
public class HelloResource {
16+
17+
@GET
18+
@Produces(MediaType.TEXT_PLAIN)
19+
public String hello() {
20+
return "hello";
21+
}
22+
}

‎integration-tests/gradle/src/main/resources/enforcing-platform-for-conditional-deps/consumer-project/runner-excluded-1/build.gradle‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
plugins {
2+
id 'java'
3+
id 'io.quarkus'
4+
}
5+
6+
repositories {
7+
mavenLocal {
8+
content {
9+
includeGroup 'org.enforcing.deps' // for dependencies built in this test
10+
includeGroup 'org.enforcing.conditional' // for dependencies built in this test
11+
includeGroupByRegex 'io.quarkus.*'
12+
includeGroup 'org.hibernate.orm'
13+
}
14+
}
15+
mavenCentral()
16+
}
17+
18+
dependencies {
19+
implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
20+
implementation enforcedPlatform("org.enforcing.deps:test-bom:1.0.0")
21+
implementation 'io.quarkus:quarkus-rest'
22+
implementation 'org.enforcing.deps:ext-a:1.0-SNAPSHOT'
23+
testImplementation 'io.quarkus:quarkus-junit5'
24+
testImplementation 'io.rest-assured:rest-assured'
25+
}
26+
27+
configurations {
28+
configureEach {
29+
exclude group: 'org.enforcing.conditional', module: 'dev-mode-only-lib'
30+
}
31+
}

‎integration-tests/gradle/src/main/resources/enforcing-platform-for-conditional-deps/consumer-project/runner-excluded-1/src/main/java/org/acme/HelloResource.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package org.acme;
2+
3+
import org.eclipse.microprofile.config.inject.ConfigProperty;
4+
5+
import jakarta.inject.Inject;
6+
import jakarta.ws.rs.GET;
7+
import jakarta.ws.rs.Path;
8+
import jakarta.ws.rs.Produces;
9+
import jakarta.ws.rs.core.MediaType;
10+
import java.io.IOException;
11+
import java.net.URL;
12+
import java.util.Enumeration;
13+
14+
@Path("/hello")
15+
public class HelloResource {
16+
17+
@GET
18+
@Produces(MediaType.TEXT_PLAIN)
19+
public String hello() {
20+
return "hello";
21+
}
22+
}

0 commit comments

Comments
 (0)