Add ApolloExtension.useGradleVariants (#6325)

* Publish Apollo metadata as variants in the main publication

* fix tests

* fix if

Author: martinbonnin

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo/gradle/api/ApolloExtension.kt

@@ -1,5 +1,6 @@
 package com.apollographql.apollo.gradle.api
 
+import com.apollographql.apollo.annotations.ApolloExperimental
 import org.gradle.api.Action
 import org.gradle.api.provider.Property
 
@@ -89,6 +90,9 @@ interface ApolloExtension {
    */
   val generateSourcesDuringGradleSync: Property<Boolean>
 
+  @ApolloExperimental
+  val useGradleVariants: Property<Boolean>
+
   /**
    * Common apollo dependencies using the same version as the Apollo Gradle Plugin currently in the classpath
    */

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo/gradle/internal/DefaultApolloExtension.kt

@@ -35,6 +35,7 @@ import org.gradle.util.GradleVersion
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 import org.jetbrains.kotlin.gradle.targets.js.KotlinJsTarget
 import java.io.File
+import java.lang.reflect.Field
 import java.util.concurrent.Callable
 import javax.inject.Inject
 
@@ -48,7 +49,9 @@ abstract class DefaultApolloExtension(
   private val checkVersionsTask: TaskProvider<Task>
   private val generateApolloSources: TaskProvider<Task>
   private var hasExplicitService = false
-  private val adhocComponentWithVariants: AdhocComponentWithVariants
+  private val adhocComponentWithVariants: AdhocComponentWithVariants by lazy {
+    project.adhocComponentWithVariants()
+  }
   private val apolloMetadataConfiguration: Configuration
   private var apolloBuildServiceProvider: Provider<ApolloBuildService>
 
@@ -144,9 +147,6 @@ abstract class DefaultApolloExtension(
       "apollo-kotlin requires Gradle version $MIN_GRADLE_VERSION or greater"
     }
 
-    adhocComponentWithVariants = softwareComponentFactory.adhoc("apollo")
-    project.components.add(adhocComponentWithVariants)
-
     checkVersionsTask = registerCheckVersionsTask()
 
     /**
@@ -386,7 +386,7 @@ abstract class DefaultApolloExtension(
   class Configurations(
       val scope: Configuration,
       val consumable: Configuration,
-      val resolvable: Configuration
+      val resolvable: Configuration,
   )
   private fun createConfigurations(
       serviceName: String,
@@ -1035,4 +1035,27 @@ abstract class DefaultApolloExtension(
   }
 
   override val deps: ApolloDependencies = ApolloDependencies(project.dependencies)
+
+  private fun Project.adhocComponentWithVariants(): AdhocComponentWithVariants {
+    if (useGradleVariants.getOrElse(false)) {
+      val javaComponent = project.components.findByName("java")
+      if (javaComponent != null) {
+        // JVM
+        return javaComponent as AdhocComponentWithVariants
+      }
+
+      val kotlin = project.kotlinMultiplatformExtension
+      if (kotlin != null) {
+        error("Adding variants to multiplatform project is not possible. See https://youtrack.jetbrains.com/issue/KT-58830/")
+      }
+
+      error("Impossible to find an AdHocComponent")
+    } else {
+      return softwareComponentFactory.adhoc("apollo").also {
+        project.components.add(it)
+      }
+    }
+  }
 }
+
+

libraries/apollo-gradle-plugin/src/test-java11/kotlin/com/apollographql/apollo/gradle/test/MultiModulesTests.kt

@@ -114,10 +114,12 @@ class MultiModulesTests {
   @Test
   fun `metadata is published`() {
     TestUtils.withTestProject("multi-modules-publishing-producer") { dir ->
-      TestUtils.executeTaskAndAssertSuccess(
-          ":publishAllPublicationsToPluginTestRepository",
+      val result = TestUtils.executeTask(
+          "publishAllPublicationsToPluginTestRepository",
           dir
       )
+      Assert.assertEquals(TaskOutcome.SUCCESS, result.task(":schema:publishAllPublicationsToPluginTestRepository")?.outcome)
+      Assert.assertEquals(TaskOutcome.SUCCESS, result.task(":fragments:publishAllPublicationsToPluginTestRepository")?.outcome)
     }
     TestUtils.withTestProject("multi-modules-publishing-consumer") { dir ->
       TestUtils.executeTaskAndAssertSuccess(

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-consumer/build.gradle.kts

@@ -6,17 +6,17 @@ plugins {
 
 dependencies {
   add("implementation", libs.apollo.api)
-  add("implementation", "com.jvm:jvm-producer:1.0.0")
+  add("implementation", "com.fragments:fragments:1.0.0")
 }
 
 apollo {
-  service("jvm") {
-    packageName.set("com.consumer")
-    dependsOn("com.jvm:jvm-producer-apollo:1.0.0")
+  service("service1") {
+    packageName.set("com.service1")
+    dependsOn("com.fragments:fragments:1.0.0")
   }
-  service("jvm2") {
-    packageName.set("com.consumer2")
-    dependsOn("com.jvm:jvm-producer-apollo:1.0.0")
+  service("service2") {
+    packageName.set("com.service2")
+    dependsOn("com.fragments:fragments:1.0.0")
   }
 }
 

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-consumer/src/main/graphql/operation.graphql

@@ -0,0 +1,4 @@
+query GetField($fieldInput: FieldInput!) {
+  ...QueryDetails
+}
+

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-consumer/src/main/graphql/some/path/operation.graphql

@@ -2,12 +2,17 @@ fun main() {
   /**
    * This just ensures the classes are built and accessible
    */
-  // Classes from the dependency
-  println(com.jvm.type.FieldInput::class.java)
-  println(com.jvm.type.FieldInput2::class.java)
-  println(com.jvm2.type.FieldInput::class.java)
+  // Classes from the schema
+  println(com.service1.type.FieldInput::class.java)
+  println(com.service1.type.FieldInput2::class.java)
+  println(com.service2.type.FieldInput::class.java)
+  println(com.service2.type.FieldInput2::class.java)
+
+  // Fragments
+  println(com.service1.fragment.QueryDetails::class.java)
+  println(com.service2.fragment.QueryDetails::class.java)
 
   // Classes from this module
-  println(com.consumer.GetField2Query::class.java)
-  println(com.consumer2.GetField2Query::class.java)
+  println(com.service1.GetFieldQuery::class.java)
+  println(com.service2.GetFieldQuery::class.java)
 }

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-consumer/src/main/kotlin/Main.kt

@@ -1,44 +1,6 @@
 
 plugins {
-  alias(libs.plugins.kotlin.jvm)
-  alias(libs.plugins.apollo)
-  id("maven-publish")
+  alias(libs.plugins.kotlin.jvm).apply(false)
+  alias(libs.plugins.apollo).apply(false)
 }
 
-group = "com.jvm"
-version = "1.0.0"
-
-dependencies {
-  add("implementation", libs.apollo.api)
-}
-
-apollo {
-  service("jvm") {
-    packageName.set("com.jvm")
-    generateApolloMetadata.set(true)
-    alwaysGenerateTypesMatching.add(".*")
-  }
-  service("jvm2") {
-    packageName.set("com.jvm2")
-    generateApolloMetadata.set(true)
-    alwaysGenerateTypesMatching.add(".*")
-  }
-}
-
-configure<PublishingExtension> {
-  publications {
-    create<MavenPublication>("mavenJava") {
-      from(components["java"])
-    }
-    create<MavenPublication>("apollo") {
-      from(components["apollo"])
-      artifactId = "jvm-producer-apollo"
-    }
-  }
-  repositories {
-    maven {
-      name = "pluginTest"
-      url = uri("file://${rootProject.rootDir.parentFile}/localMaven")
-    }
-  }
-}

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-producer/build.gradle.kts

@@ -0,0 +1,40 @@
+
+plugins {
+  alias(libs.plugins.kotlin.jvm)
+  alias(libs.plugins.apollo)
+  id("maven-publish")
+}
+
+group = "com.fragments"
+version = "1.0.0"
+
+dependencies {
+  add("api", project(":schema"))
+}
+
+apollo {
+  useGradleVariants.set(true)
+
+  service("service1") {
+    packageName.set("com.service1")
+    dependsOn(project(":schema"))
+  }
+  service("service2") {
+    packageName.set("com.service2")
+    dependsOn(project(":schema"))
+  }
+}
+
+configure<PublishingExtension> {
+  publications {
+    create<MavenPublication>("default") {
+      from(components["java"])
+    }
+  }
+  repositories {
+    maven {
+      name = "pluginTest"
+      url = uri("file://${rootProject.rootDir.parentFile}/localMaven")
+    }
+  }
+}

libraries/apollo-gradle-plugin/testProjects/multi-modules-publishing-producer/fragments/build.gradle.kts

@@ -0,0 +1,3 @@
+fragment QueryDetails on Query {
+  field(fieldInput: $fieldInput)
+}