expose regular configurations for multi-module projects (#6408)

Author: martinbonnin

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/entrypoints.kt

@@ -186,6 +186,9 @@ internal fun Consumer<String>.toLogger(): ApolloCompiler.Logger {
 @ApolloInternal
 fun Iterable<File>.findCodegenSchemaFile(): File {
   return firstOrNull {
+    /*
+     * TODO v5: simplify this and add a schema { } block to the Gradle configuration
+     */
     it.length() > 0
   } ?: error("Cannot find CodegenSchema in $this")
 }

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

@@ -18,7 +18,6 @@ internal enum class ApolloDirection {
 }
 
 internal enum class ConfigurationKind {
-  DependencyScope,
   Consumable,
   Resolvable
 }

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

@@ -72,7 +72,7 @@ abstract class DefaultApolloExtension(
 
   internal fun registerDownstreamProject(serviceName: String, projectPath: String) {
     project.configurations.configureEach {
-      if (it.name == ModelNames.configuration(serviceName, ApolloDirection.Downstream, ApolloUsage.Ir, ConfigurationKind.DependencyScope)) {
+      if (it.name == ModelNames.scopeConfiguration(serviceName, ApolloDirection.Downstream)) {
         it.dependencies.add(project.dependencies.project(mapOf("path" to projectPath)))
       }
     }
@@ -391,36 +391,32 @@ abstract class DefaultApolloExtension(
   }
 
   class Configurations(
-      val scope: Configuration,
       val consumable: Configuration,
       val resolvable: Configuration,
   )
+
   private fun createConfigurations(
       serviceName: String,
       apolloUsage: ApolloUsage,
       direction: ApolloDirection,
+      extendsFrom: Configuration
   ): Configurations {
-    val dependencyScope = project.configurations.create(ModelNames.configuration(serviceName, direction, apolloUsage, ConfigurationKind.DependencyScope )) {
-      it.isCanBeConsumed = false
-      it.isCanBeResolved = false
-    }
     val consumable = project.configurations.create(ModelNames.configuration(serviceName, direction, apolloUsage, ConfigurationKind.Consumable )) {
       it.isCanBeConsumed = true
       it.isCanBeResolved = false
 
-      it.extendsFrom(dependencyScope)
+      it.extendsFrom(extendsFrom)
       it.attributes(serviceName, apolloUsage, direction)
     }
     val resolvable = project.configurations.create(ModelNames.configuration(serviceName, direction, apolloUsage, ConfigurationKind.Resolvable )) {
       it.isCanBeConsumed = false
       it.isCanBeResolved = true
 
-      it.extendsFrom(dependencyScope)
+      it.extendsFrom(extendsFrom)
       it.attributes(serviceName, apolloUsage, direction)
     }
 
     return Configurations(
-        scope = dependencyScope,
         consumable = consumable,
         resolvable = resolvable
     )
@@ -455,10 +451,20 @@ abstract class DefaultApolloExtension(
 
     val sourcesBaseTaskProvider: TaskProvider<*>
 
+    val upstreamScope = project.configurations.create(ModelNames.scopeConfiguration(service.name, ApolloDirection.Upstream)) {
+      it.isCanBeConsumed = false
+      it.isCanBeResolved = false
+    }
+    val downstreamScope = project.configurations.create(ModelNames.scopeConfiguration(service.name, ApolloDirection.Downstream)) {
+      it.isCanBeConsumed = false
+      it.isCanBeResolved = false
+    }
+
     val otherOptions = createConfigurations(
         serviceName = service.name,
         apolloUsage = ApolloUsage.OtherOptions,
         direction = ApolloDirection.Upstream,
+        extendsFrom = upstreamScope
     )
 
     val compilerConfiguration = project.configurations.create(ModelNames.compilerConfiguration(service)) {
@@ -489,24 +495,28 @@ abstract class DefaultApolloExtension(
           serviceName = service.name,
           apolloUsage = ApolloUsage.CodegenSchema,
           direction = ApolloDirection.Upstream,
+          extendsFrom = upstreamScope
       )
 
       val upstreamIr = createConfigurations(
           serviceName = service.name,
           apolloUsage = ApolloUsage.Ir,
           direction = ApolloDirection.Upstream,
+          extendsFrom = upstreamScope
       )
 
       val downstreamIr = createConfigurations(
           serviceName = service.name,
           apolloUsage = ApolloUsage.Ir,
           direction = ApolloDirection.Downstream,
+          extendsFrom = downstreamScope
       )
 
       val codegenMetadata = createConfigurations(
           serviceName = service.name,
           apolloUsage = ApolloUsage.CodegenMetadata,
           direction = ApolloDirection.Upstream,
+          extendsFrom = upstreamScope
       )
 
       /**
@@ -607,14 +617,11 @@ abstract class DefaultApolloExtension(
       }
 
       service.upstreamDependencies.forEach {
-        otherOptions.scope.dependencies.add(it)
-        codegenSchema.scope.dependencies.add(it)
-        upstreamIr.scope.dependencies.add(it)
-        codegenMetadata.scope.dependencies.add(it)
+        upstreamScope.dependencies.add(it)
       }
 
       service.downstreamDependencies.forEach {
-        downstreamIr.scope.dependencies.add(it)
+        downstreamScope.dependencies.add(it)
       }
     }
 

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

@@ -33,29 +33,40 @@ internal object ModelNames {
   @Deprecated("Unused. Use dependsOn() instead.")
   @ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
   fun metadataConfiguration() = "apolloMetadata"
-  fun configuration(serviceName: String, apolloDirection: ApolloDirection, apolloUsage: ApolloUsage, configurationKind: ConfigurationKind): String {
+
+  fun scopeConfiguration(
+      serviceName: String,
+      apolloDirection: ApolloDirection,
+  ): String {
     return camelCase(
         "apollo",
         serviceName,
         apolloDirection.pretty(),
-        apolloUsage.name,
-        configurationKind.pretty()
     )
   }
-  fun compilerConfiguration(service: Service) = camelCase("apollo", service.name, "Compiler")
- }
 
-private fun ConfigurationKind.pretty(): String {
-  return when(this) {
-    ConfigurationKind.DependencyScope -> ""
-    else -> name
+  fun configuration(
+      serviceName: String,
+      apolloDirection: ApolloDirection,
+      apolloUsage: ApolloUsage,
+      configurationKind: ConfigurationKind,
+  ): String {
+    return camelCase(
+        "apollo",
+        serviceName,
+        apolloDirection.pretty(),
+        apolloUsage.name,
+        configurationKind.name
+    )
   }
+
+  fun compilerConfiguration(service: Service) = camelCase("apollo", service.name, "Compiler")
 }
 
 
 private fun ApolloDirection.pretty(): String {
-  return when(this) {
+  return when (this) {
     ApolloDirection.Upstream -> ""
-    ApolloDirection.Downstream -> name
+    ApolloDirection.Downstream -> "UsedCoordinates"
   }
 }

libraries/apollo-gradle-plugin/testProjects/configuration-cache/leaf/build.gradle.kts

@@ -13,6 +13,11 @@ dependencies {
 apollo {
   service("service") {
     packageName.set("com.example.leaf")
-    dependsOn(project(":root"))
+    alwaysGenerateTypesMatching.set(emptyList())
+    generateApolloMetadata.set(true)
   }
 }
+
+dependencies {
+  add("apolloService", project(":root"))
+}

libraries/apollo-gradle-plugin/testProjects/configuration-cache/root/build.gradle.kts

@@ -7,11 +7,15 @@ apollo {
   service("service") {
     packageName.set("com.example")
     generateApolloMetadata.set(true)
-    isADependencyOf(project(":leaf"))
+    alwaysGenerateTypesMatching.set(emptyList())
 
     introspection {
       this.endpointUrl.set("ENDPOINT")
       schemaFile.set(file("schema.json"))
     }
   }
 }
+
+dependencies {
+  add("apolloServiceUsedCoordinates", project(":leaf"))
+}

libraries/apollo-gradle-plugin/testProjects/multi-modules-badconfig/leaf/build.gradle.kts

@@ -11,7 +11,12 @@ dependencies {
 apollo {
   service("service") {
     // PLACEHOLDER
+    alwaysGenerateTypesMatching.set(emptyList())
+    generateApolloMetadata.set(true)
     packageNamesFromFilePaths()
-    dependsOn(project(":root"))
   }
 }
+
+dependencies {
+  add("apolloService", project(":root"))
+}

libraries/apollo-gradle-plugin/testProjects/multi-modules-badconfig/root/build.gradle.kts

@@ -15,8 +15,12 @@ apollo {
   service("service") {
     packageNamesFromFilePaths()
     // PLACEHOLDER
+    alwaysGenerateTypesMatching.set(emptyList())
     generateApolloMetadata.set(true)
-    isADependencyOf(project(":leaf"))
     mapScalar("Date", "java.util.Date")
   }
 }
+
+dependencies {
+  add("apolloServiceUsedCoordinates", project(":leaf"))
+}

libraries/apollo-gradle-plugin/testProjects/multi-modules-custom-scalar-defined-in-leaf/leaf/build.gradle.kts

@@ -15,6 +15,13 @@ apollo {
   service("service") {
     packageName.set("com.library")
     mapScalar("Long", "java.lang.Long")
+    /**
+     * We need to call `dependsOn` here to know at graph build time that the schema is coming
+     * from a dependency and do the checks for the redundant scalar configuration.
+     *
+     * TODO v5: add a specific `schema` block so that we can know this
+     */
     dependsOn(project(":root"))
   }
 }
+

libraries/apollo-gradle-plugin/testProjects/multi-modules-custom-scalar/leaf/build.gradle.kts

@@ -19,6 +19,11 @@ application {
 apollo {
   service("service") {
     packageName.set("com.library")
-    dependsOn(project(":root"))
+    alwaysGenerateTypesMatching.set(emptyList())
+    generateApolloMetadata.set(true)
   }
 }
+
+dependencies {
+  add("apolloService", project(":root"))
+}