DefaultDevelocityBuildLifecycleService shouldn't force IP compatibility for build (#30382)

bot-gradle · web-flow · commit 5124855acbbf · 2024-09-03T16:38:19.000Z
diff --git a/platforms/enterprise/enterprise/build.gradle.kts b/platforms/enterprise/enterprise/build.gradle.kts
@@ -53,6 +53,7 @@ dependencies {
     }
 
     testImplementation(projects.resources)
+    testImplementation(testFixtures(projects.core))
 
     integTestImplementation(projects.internalTesting)
     integTestImplementation(projects.internalIntegTesting)
diff --git a/platforms/enterprise/enterprise/src/main/java/org/gradle/internal/enterprise/impl/DefaultDevelocityBuildLifecycleService.java b/platforms/enterprise/enterprise/src/main/java/org/gradle/internal/enterprise/impl/DefaultDevelocityBuildLifecycleService.java
@@ -19,6 +19,7 @@
 
 import org.gradle.api.Action;
 import org.gradle.api.Project;
+import org.gradle.api.configuration.BuildFeatures;
 import org.gradle.api.invocation.Gradle;
 import org.gradle.internal.enterprise.DevelocityBuildLifecycleService;
 
@@ -27,14 +28,27 @@
 public class DefaultDevelocityBuildLifecycleService implements DevelocityBuildLifecycleService {
 
     private final Gradle gradle;
+    private final BuildFeatures buildFeatures;
 
     @Inject
-    public DefaultDevelocityBuildLifecycleService(Gradle gradle) {
+    public DefaultDevelocityBuildLifecycleService(Gradle gradle, BuildFeatures buildFeatures) {
         this.gradle = gradle;
+        this.buildFeatures = buildFeatures;
     }
 
     @Override
     public void beforeProject(Action<? super Project> action) {
-        gradle.getLifecycle().beforeProject(action::execute);
+        // GradleLifecycle#beforeProject isolates the action to be safe with Isolated Projects.
+        // This brings additional serializability requirements for any state referenced by the action.
+        // Therefore, the new callback cannot be used without Isolated Projects, because it implies a breaking change in behavior
+        if (isIsolatedProjects()) {
+            gradle.getLifecycle().beforeProject(action::execute);
+        } else {
+            gradle.allprojects(action);
+        }
+    }
+
+    private boolean isIsolatedProjects() {
+        return buildFeatures.getIsolatedProjects().getActive().getOrElse(false);
     }
 }
diff --git a/platforms/enterprise/enterprise/src/test/groovy/org/gradle/internal/enterprise/DevelocityBuildLifecycleServiceTest.groovy b/platforms/enterprise/enterprise/src/test/groovy/org/gradle/internal/enterprise/DevelocityBuildLifecycleServiceTest.groovy
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.gradle.internal.enterprise
+
+import org.gradle.api.configuration.BuildFeatures
+import org.gradle.api.internal.configuration.DefaultBuildFeature
+import org.gradle.api.invocation.Gradle
+import org.gradle.api.invocation.GradleLifecycle
+import org.gradle.internal.enterprise.impl.DefaultDevelocityBuildLifecycleService
+import org.gradle.util.TestUtil
+import spock.lang.Specification
+
+class DevelocityBuildLifecycleServiceTest extends Specification {
+
+    def 'uses #correctApi API for `beforeProject` logic execution if IsolatedProjects enabled=#ipEnabled'() {
+        given:
+        def gradle = Mock(Gradle) {
+            _ * getLifecycle() >> Mock(GradleLifecycle)
+        }
+        def buildFeatures = Mock(BuildFeatures) {
+            _ * getIsolatedProjects() >> new DefaultBuildFeature(
+                TestUtil.providerFactory().provider { ipEnabled },
+                TestUtil.providerFactory().provider { ipEnabled }
+            )
+        }
+        def service = new DefaultDevelocityBuildLifecycleService(gradle, buildFeatures)
+
+        when:
+        service.beforeProject {/*do something*/ }
+
+        then:
+        if (ipEnabled) {
+            0 * gradle.allprojects(_)
+            1 * gradle.lifecycle.beforeProject(_)
+        } else {
+            1 * gradle.allprojects(_)
+            0 * gradle.lifecycle.beforeProject(_)
+        }
+
+        where:
+        ipEnabled | correctApi
+        true      | "GradleLifecycle#beforeProject"
+        false     | "Gradle#allprojects"
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ dependencies {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`testImplementation(projects.resources)`
	`56`	`+ testImplementation(testFixtures(projects.core))`
`56`	`57`
`57`	`58`	`integTestImplementation(projects.internalTesting)`
`58`	`59`	`integTestImplementation(projects.internalIntegTesting)`