com.grab.grazel.hybrid.DependencySubstitution.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grazel-gradle-plugin Show documentation
A Gradle plugin to automate Bazel migration for Android projects
The newest version!
/*
 * Copyright 2022 Grabtaxi Holdings PTE LTD (GRAB)
 *
 * 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 com.grab.grazel.hybrid

import com.grab.grazel.di.qualifiers.RootProject
import com.grab.grazel.gradle.isMigrated
import com.jakewharton.picnic.TextAlignment.MiddleCenter
import com.jakewharton.picnic.table
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.gradle.api.artifacts.DependencySet
import org.gradle.api.artifacts.ProjectDependency
import java.io.File
import java.util.concurrent.TimeUnit
import javax.inject.Inject
import javax.inject.Singleton

interface DependencySubstitution {
    fun register()
}

@Singleton
class DefaultDependencySubstitution
@Inject
constructor(
    @param:RootProject private val rootProject: Project,
    private val artifactSearcher: ArtifactSearcher,
) : DependencySubstitution {

    private fun performSubstitution(
        sourceProject: Project,
        configuration: Configuration,
        dependencySet: DependencySet,
        artifactCache: Map>
    ) {
        val migratedProjects = dependencySet.asSequence()
            .filterIsInstance()
            .filter { it.dependencyProject.isMigrated }
            .toList()

        if (migratedProjects.isEmpty()) return

        dependencySet.removeAll(migratedProjects.toSet())

        table {
            cellStyle {
                border = true
            }
            header {
                cellStyle {
                    alignment = MiddleCenter
                }
                row {
                    cell(sourceProject.path) {
                        columnSpan = 3
                    }
                }
                row("Configuration", "Project", "Substitution Artifacts")
            }
            body {
                migratedProjects.forEach { projectDependency: ProjectDependency ->
                    val rootProject = sourceProject.rootProject
                    val depProject = projectDependency.dependencyProject
                    val buildArtifacts = artifactCache.getOrDefault(depProject.path, emptyList())

                    if (buildArtifacts.isNotEmpty()) {
                        val artifactNames = buildArtifacts.map { it.name }
                        val dependency = sourceProject
                            .dependencies
                            .create(rootProject.files(buildArtifacts))
                        dependencySet.add(dependency)
                        row(configuration.name, depProject.path, artifactNames)
                    } else {
                        sourceProject.logger.error(
                            "Build artifact was not found for " +
                                "${depProject.path}, skipping substitution"
                        )
                        throw GradleException(
                            "Dependency substitution failed for " +
                                "${sourceProject.path} for dependency ${depProject.path}"
                        )
                    }
                }
            }
        }.let { table -> println(table.toString()) }
    }

    override fun register() {
        rootProject.afterEvaluate {
            logger.debug("Caching migrated modules and their artifacts")
            var measuredMillis = System.currentTimeMillis()

            val artifactCache = subprojects
                .filter(Project::isMigrated).associate { project ->
                    val builtArtifacts = artifactSearcher.findArtifacts()
                    project.path to builtArtifacts
                }

            measuredMillis = System.currentTimeMillis() - measuredMillis
            val measuredSeconds = TimeUnit.MILLISECONDS.toSeconds(measuredMillis)
            logger.quiet("Caching artifacts took $measuredSeconds seconds.")

            subprojects {
                afterEvaluate {
                    val sourceProject = this
                    configurations.configureEach {
                        val configuration = this
                        withDependencies {
                            performSubstitution(
                                sourceProject,
                                configuration,
                                this,
                                artifactCache
                            )
                        }
                    }
                }
            }
        }
    }
}