com.autonomousapps.tasks.FindServiceLoadersTask.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dependency-analysis-gradle-plugin Show documentation

Analyzes dependency usage in Android and JVM projects

There is a newer version: 2.0.2

Show newest version

package com.autonomousapps.tasks

import com.autonomousapps.TASK_GROUP_DEP
import com.autonomousapps.internal.DependencyConfiguration
import com.autonomousapps.internal.ServiceLoader
import com.autonomousapps.internal.utils.*
import com.autonomousapps.tasks.FindDeclaredProcsTask.Companion.ANNOTATION_PROCESSOR_PATH
import org.gradle.api.DefaultTask
import org.gradle.api.artifacts.ArtifactCollection
import org.gradle.api.artifacts.result.ResolvedArtifactResult
import org.gradle.api.file.FileCollection
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.tasks.*
import java.io.BufferedReader
import java.util.zip.ZipFile

/**
 * See also [ServiceLoader][https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html].
 *
 * Some dependencies are loaded at runtime, and cannot reasonably be detected by looking at compiled
 * bytecode. We will special-case all such dependencies discovered on the classpath.
 */
@CacheableTask
abstract class FindServiceLoadersTask : DefaultTask() {

  init {
    group = TASK_GROUP_DEP
    description = "Produces a report of all dependencies that include Java ServiceLoaders"
  }

  companion object {
    private const val SERVICE_LOADER_PATH = "META-INF/services/"
  }

  @get:Internal
  lateinit var artifacts: ArtifactCollection

  /**
   * Unused, except as a task input for Gradle.
   */
  @Classpath
  fun getDependencies(): FileCollection = artifacts.artifactFiles

  @get:PathSensitive(PathSensitivity.NONE)
  @get:InputFile
  abstract val dependencyConfigurations: RegularFileProperty

  @get:OutputFile
  abstract val output: RegularFileProperty

  private val candidates by lazy { dependencyConfigurations.fromJsonSet() }

  @TaskAction fun action() {
    val outputFile = output.getAndDelete()
    val serviceLoaders: Set = artifacts.flatMapToSet {
      findServiceLoaders(it)
    }

    outputFile.writeText(serviceLoaders.toJson())
  }

  // E.g. org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.5 -->
  // 1. META-INF/services/kotlinx.coroutines.internal.MainDispatcherFactory
  // 2. META-INF/services/kotlinx.coroutines.CoroutineExceptionHandler
  private fun findServiceLoaders(artifact: ResolvedArtifactResult): Set {
    val zip = ZipFile(artifact.file)

    return zip.entries().toList()
      .filter { it.name.startsWith(SERVICE_LOADER_PATH) }
      .filterNot { it.name.startsWith(ANNOTATION_PROCESSOR_PATH) }
      .filterNot { it.isDirectory }
      .mapToOrderedSet { serviceFile ->
        val providerClasses = zip.getInputStream(serviceFile).bufferedReader().use(BufferedReader::readLines)
          // remove whitespace
          .map { it.trim() }
          // Ignore comments
          .filterToSet { !it.startsWith("#") }

        ServiceLoader(
          providerFile = serviceFile.name.removePrefix(SERVICE_LOADER_PATH),
          providerClasses = providerClasses,
          componentIdentifier = artifact.id.componentIdentifier,
          candidates = candidates
        )
      }
  }
}