org.jetbrains.kotlin.gradle.plugin.mpp.internal.reportDeprecatedPreHmppDependencies.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-gradle-plugin Show documentation
Kotlin Gradle Plugin
There is a newer version: 2.1.0-Beta1
/*
 * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package org.jetbrains.kotlin.gradle.plugin.mpp.internal

import org.gradle.api.Project
import org.gradle.api.artifacts.component.ComponentIdentifier
import org.gradle.api.artifacts.component.ModuleComponentIdentifier
import org.gradle.api.artifacts.result.ResolvedDependencyResult
import org.gradle.api.attributes.Attribute
import org.gradle.api.attributes.Usage
import org.jetbrains.kotlin.gradle.InternalKotlinGradlePluginApi
import org.jetbrains.kotlin.gradle.dsl.multiplatformExtensionOrNull
import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.Companion.kotlinPropertiesProvider
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinMetadataTarget
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinUsages
import org.jetbrains.kotlin.gradle.plugin.mpp.resolvableMetadataConfiguration
import org.jetbrains.kotlin.gradle.plugin.sources.internal
import org.jetbrains.kotlin.gradle.targets.metadata.isKotlinGranularMetadataEnabled
import org.jetbrains.kotlin.gradle.utils.SingleWarningPerBuild
import java.util.*
import java.util.concurrent.ConcurrentHashMap

@Suppress("NAME_SHADOWING")
internal fun checkAndReportPreHmppDependenciesUsage(
    project: Project,
    reportWarning: (Project, String) -> Unit = DEFAULT_DIAGNOSTIC_REPORTER,
) {
    if (!project.isKotlinGranularMetadataEnabled || project.kotlinPropertiesProvider.allowLegacyMppDependencies) return

    val metadataTarget = project.multiplatformExtensionOrNull?.targets?.matching { it is KotlinMetadataTarget }?.singleOrNull()
        ?: return

    // Note that we do not inspect dependencies of compilations, because adding dependencies into compilation is esoteric enough on its own,
    // and x2 esoteric for KotlinMetadataTarget
    val sourceSetsInMetadataCompilations = metadataTarget.compilations.flatMapTo(mutableSetOf()) { it.allKotlinSourceSets }
    val configurationsToInspect = sourceSetsInMetadataCompilations.map { it.internal.resolvableMetadataConfiguration }

    // Resolution of configurations can happen concurrently, so need to use thread-safe primitives
    val reportedDependencies: MutableSet = Collections.newSetFromMap(ConcurrentHashMap())
    val processedDependencies: MutableSet = Collections.newSetFromMap(ConcurrentHashMap())

    for (configuration in configurationsToInspect) {
        configuration.incoming.afterResolve { configuration ->
            val resolvedDependencies = configuration.resolutionResult.root.dependencies
                .filterIsInstance()
                // We don't want to report deprecation on transitive dependencies. Gradle will add them into list of 'dependencies',
                // but will mark them as 'isConstraint'
                .filter { it.selected.id is ModuleComponentIdentifier && !it.isConstraint }

            for (dependency in resolvedDependencies) {
                val dependencyId = dependency.selected.id as ModuleComponentIdentifier
                if (!processedDependencies.add(dependencyId)) continue

                if (isPreHmppDependency(dependency) && reportedDependencies.add(dependencyId)) {
                    reportWarning(
                        project,
                        DEPRECATED_PRE_HMPP_LIBRARIES_DETECTED_MESSAGE.replace("{0}", dependencyId.displayName)
                    )
                }
            }
        }
    }
}

private fun isPreHmppDependency(dependency: ResolvedDependencyResult): Boolean {
    val attributes = dependency.resolvedVariant.attributes
    val kotlinPlatformAttribute = attributes.getAttribute(Attribute.of(KotlinPlatformType.attribute.name, String::class.java))
        ?: return false
    val usageAttribute = attributes.getAttribute(Attribute.of(Usage.USAGE_ATTRIBUTE.name, String::class.java)) ?: return false

    return kotlinPlatformAttribute == KotlinPlatformType.common.name && usageAttribute != KotlinUsages.KOTLIN_METADATA
}

private val DEFAULT_DIAGNOSTIC_REPORTER = { project: Project, message: String ->
    SingleWarningPerBuild.show(project, message)
}

@InternalKotlinGradlePluginApi
val DEPRECATED_PRE_HMPP_LIBRARIES_DETECTED_MESSAGE =
    "w: The dependency {0} was published in the legacy mode. Support for such dependencies will be removed in the future. " +
            "See https://kotl.in/0b5kn8 for details."