Skip to content

[gradle-plugin] expose regular configurations for multi-module projects #6408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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")
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ internal enum class ApolloDirection {
}

internal enum class ConfigurationKind {
DependencyScope,
Consumable,
Resolvable
}
Original file line number Diff line number Diff line change
Expand Up @@ -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)))
}
}
Expand Down Expand Up @@ -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
)
Expand Down Expand Up @@ -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)) {
Expand Down Expand Up @@ -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
)

/**
Expand Down Expand Up @@ -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)
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ dependencies {
apollo {
service("service") {
// PLACEHOLDER
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
packageNamesFromFilePaths()
dependsOn(project(":root"))
}
}

dependencies {
add("apolloService", project(":root"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -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"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ dependencies {
apollo {
service("service") {
packageName.set("com.library")
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
isADependencyOf(project(":leaf"))
mapScalar("Date", "java.util.Date")
mapScalar("ID", "com.library.MyID", "com.library.MyIDAdapter()")
}
}

dependencies {
add("apolloServiceUsedCoordinates", project(":leaf"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ dependencies {
apollo {
service("service") {
packageNamesFromFilePaths()
dependsOn(project(":root"))
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
}
}


dependencies {
add("apolloService", project(":root"))
}

Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ dependencies {
apollo {
service("service") {
packageNamesFromFilePaths()
dependsOn(project(":root"))
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
}
}

dependencies {
add("apolloService", project(":root"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ apollo {
alwaysGenerateTypesMatching.set(listOf("Cat"))
packageNamesFromFilePaths()
generateApolloMetadata.set(true)
isADependencyOf(project(":node1:impl"))
isADependencyOf(project(":node2:impl"))
mapScalar("Date", "java.util.Date")
}
}

dependencies {
add("apolloServiceUsedCoordinates", project(":node1:impl"))
add("apolloServiceUsedCoordinates", project(":node2:impl"))
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,20 @@ dependencies {
apollo {
service("service1") {
packageName.set("com.service1")
dependsOn("com.fragments:fragments:1.0.0")
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
}
service("service2") {
packageName.set("com.service2")
dependsOn("com.fragments:fragments:1.0.0")
alwaysGenerateTypesMatching.set(emptyList())
generateApolloMetadata.set(true)
}
}


dependencies {
add("apolloService1", "com.fragments:fragments:1.0.0")
add("apolloService2", "com.fragments:fragments:1.0.0")
}


Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,31 @@ dependencies {
apollo {
service("service1") {
packageName.set("com.service1")
dependsOn(project(":schema"))
generateApolloMetadata.set(true)
alwaysGenerateTypesMatching.set(emptyList())

outgoingVariantsConnection {
addToSoftwareComponent("java")
generateApolloMetadata.set(true)
}
}
service("service2") {
packageName.set("com.service2")
dependsOn(project(":schema"))
generateApolloMetadata.set(true)
alwaysGenerateTypesMatching.set(emptyList())

outgoingVariantsConnection {
addToSoftwareComponent("java")
generateApolloMetadata.set(true)
}
}
}

dependencies {
add("apolloService1", project(":schema"))
add("apolloService2", project(":schema"))
}

configure<PublishingExtension> {
publications {
create<MavenPublication>("default") {
Expand All @@ -42,3 +53,4 @@ configure<PublishingExtension> {
}
}
}

Loading
Loading