PublishedMetadata.java

// SPDX-License-Identifier: Apache-2.0
package org.gradlex.javamodule.moduleinfo;

import static java.util.Collections.emptyList;
import static java.util.Objects.requireNonNull;
import static org.gradle.api.attributes.Category.CATEGORY_ATTRIBUTE;
import static org.gradle.api.attributes.Category.ENFORCED_PLATFORM;
import static org.gradle.api.attributes.Category.LIBRARY;
import static org.gradle.api.attributes.Category.REGULAR_PLATFORM;
import static org.gradle.api.attributes.Usage.USAGE_ATTRIBUTE;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.ConfigurationContainer;
import org.gradle.api.artifacts.Dependency;
import org.gradle.api.artifacts.ModuleDependency;
import org.gradle.api.artifacts.result.DependencyResult;
import org.gradle.api.artifacts.result.ResolvedDependencyResult;
import org.gradle.api.artifacts.result.UnresolvedDependencyResult;
import org.gradle.api.attributes.Attribute;
import org.gradle.api.attributes.Bundling;
import org.gradle.api.attributes.Category;
import org.gradle.api.attributes.LibraryElements;
import org.gradle.api.attributes.Usage;
import org.gradle.api.attributes.java.TargetJvmEnvironment;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.util.GradleVersion;
import org.jspecify.annotations.Nullable;

public class PublishedMetadata implements Serializable {
    private static final Attribute<String> CATEGORY_ATTRIBUTE_UNTYPED =
            Attribute.of(CATEGORY_ATTRIBUTE.getName(), String.class);
    private static final Attribute<Category> CATEGORY_ATTRIBUTE_TYPED =
            Attribute.of(CATEGORY_ATTRIBUTE.getName(), Category.class);
    private static final String DEFAULT_VERSION_SOURCE_CONFIGURATION = "definedDependenciesVersions";

    private final String gav;
    private final List<String> requires = new ArrayList<>();
    private final List<String> requiresTransitive = new ArrayList<>();
    private final List<String> requiresStaticTransitive = new ArrayList<>();

    @Nullable
    private String errorMessage = null;

    PublishedMetadata(String gav, Project project, ExtraJavaModuleInfoPluginExtension extension) {
        this.gav = gav;

        List<String> compileDependencies = componentVariant(
                extension.getVersionsProvidingConfiguration(),
                extension.getPlatformDependency(),
                project,
                Usage.JAVA_API);
        List<String> runtimeDependencies = componentVariant(
                extension.getVersionsProvidingConfiguration(),
                extension.getPlatformDependency(),
                project,
                Usage.JAVA_RUNTIME);

        Stream.concat(compileDependencies.stream(), runtimeDependencies.stream())
                .distinct()
                .forEach(ga -> {
                    if (compileDependencies.contains(ga) && runtimeDependencies.contains(ga)) {
                        requiresTransitive.add(ga);
                    } else if (runtimeDependencies.contains(ga)) {
                        requires.add(ga);
                    } else if (compileDependencies.contains(ga)) {
                        requiresStaticTransitive.add(ga);
                    }
                });
    }

    @SuppressWarnings({"UnstableApiUsage", "unchecked"})
    private List<String> componentVariant(
            Provider<String> versionsProvidingConfiguration,
            Provider<Dependency> platformDependencyProvider,
            Project project,
            String usage) {
        Configuration versionsSource;
        if (versionsProvidingConfiguration.isPresent()) {
            versionsSource = project.getConfigurations()
                    .named(versionsProvidingConfiguration.get())
                    .get();
        } else {
            // version provider is not configured, create on adhoc based on ALL classpaths of the project
            versionsSource = maybeCreateDefaultVersionSourcConfiguration(
                    project.getConfigurations(),
                    project.getObjects(),
                    project.getExtensions().findByType(SourceSetContainer.class));
        }

        List<Dependency> dependencies = new ArrayList<>();
        dependencies.add(project.getDependencies().create(gav));
        if (platformDependencyProvider.isPresent()) {
            if (!ModuleDependency.class.isAssignableFrom(
                    platformDependencyProvider.get().getClass())) {
                throw new IllegalArgumentException("Unable to determine dependency '"
                        + platformDependencyProvider.get().getName() + "' type");
            }

            ModuleDependency platformDependency = (ModuleDependency) platformDependencyProvider.get();
            // A platform dependency must have the platform attribute specified.
            Category category = platformDependency.getAttributes().getAttribute(CATEGORY_ATTRIBUTE_TYPED);
            if (category == null
                    || (!category.getName().equals(REGULAR_PLATFORM)
                            && !category.getName().equals(ENFORCED_PLATFORM))) {
                throw new IllegalArgumentException(
                        "Dependency '" + platformDependency.getName() + "' is not a platform");
            }
            dependencies.add(platformDependency);
        }

        Configuration singleComponentVariantResolver =
                project.getConfigurations().detachedConfiguration(dependencies.toArray(new Dependency[0]));
        singleComponentVariantResolver.setCanBeConsumed(false);
        singleComponentVariantResolver.shouldResolveConsistentlyWith(versionsSource);
        versionsSource.getAttributes().keySet().forEach(a -> {
            @SuppressWarnings("rawtypes")
            Attribute untypedAttributeKey = a;
            singleComponentVariantResolver
                    .getAttributes()
                    .attribute(
                            untypedAttributeKey,
                            requireNonNull(versionsSource.getAttributes().getAttribute(a)));
        });
        singleComponentVariantResolver
                .getAttributes()
                .attribute(USAGE_ATTRIBUTE, project.getObjects().named(Usage.class, usage));
        return firstAndOnlyComponentDependencies(singleComponentVariantResolver);
    }

    private Configuration maybeCreateDefaultVersionSourcConfiguration(
            ConfigurationContainer configurations, ObjectFactory objects, @Nullable SourceSetContainer sourceSets) {
        String name = DEFAULT_VERSION_SOURCE_CONFIGURATION;
        Configuration existing = configurations.findByName(name);
        if (existing != null) {
            return existing;
        }

        return configurations.create(name, c -> {
            c.setCanBeResolved(true);
            c.setCanBeConsumed(false);
            c.getAttributes().attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.class, Usage.JAVA_RUNTIME));
            c.getAttributes().attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.class, Category.LIBRARY));
            c.getAttributes()
                    .attribute(
                            LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE,
                            objects.named(LibraryElements.class, LibraryElements.JAR));
            c.getAttributes().attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.class, Bundling.EXTERNAL));
            if (GradleVersion.current().compareTo(GradleVersion.version("7.0")) >= 0) {
                c.getAttributes()
                        .attribute(
                                TargetJvmEnvironment.TARGET_JVM_ENVIRONMENT_ATTRIBUTE,
                                objects.named(TargetJvmEnvironment.class, TargetJvmEnvironment.STANDARD_JVM));
            }

            if (sourceSets != null) {
                for (SourceSet sourceSet : sourceSets) {
                    Configuration implementation = configurations
                            .named(sourceSet.getImplementationConfigurationName())
                            .get();
                    Configuration compileOnly = configurations
                            .named(sourceSet.getCompileOnlyConfigurationName())
                            .get();
                    Configuration runtimeOnly = configurations
                            .named(sourceSet.getRuntimeOnlyConfigurationName())
                            .get();
                    Configuration annotationProcessor = configurations
                            .named(sourceSet.getAnnotationProcessorConfigurationName())
                            .get();
                    c.extendsFrom(implementation, compileOnly, runtimeOnly, annotationProcessor);
                }
            }
        });
    }

    private List<String> firstAndOnlyComponentDependencies(Configuration singleComponentVariantResolver) {
        DependencyResult result = singleComponentVariantResolver
                .getIncoming()
                .getResolutionResult()
                .getRoot()
                .getDependencies()
                .iterator()
                .next();

        if (result instanceof UnresolvedDependencyResult) {
            errorMessage = ((UnresolvedDependencyResult) result).getFailure().getMessage();
            return emptyList();
        } else {
            return ((ResolvedDependencyResult) result)
                    .getSelected().getDependencies().stream()
                            .filter(PublishedMetadata::filterComponentDependencies)
                            .map(PublishedMetadata::ga)
                            .collect(Collectors.toList());
        }
    }

    private static boolean filterComponentDependencies(DependencyResult d) {
        if (d instanceof ResolvedDependencyResult) {
            Category category = ((ResolvedDependencyResult) d)
                    .getResolvedVariant()
                    .getAttributes()
                    .getAttribute(CATEGORY_ATTRIBUTE);
            String categoryUntyped = ((ResolvedDependencyResult) d)
                    .getResolvedVariant()
                    .getAttributes()
                    .getAttribute(CATEGORY_ATTRIBUTE_UNTYPED);
            return LIBRARY.equals(categoryUntyped) || (category != null && LIBRARY.equals(category.getName()));
        }
        return false;
    }

    private static String ga(DependencyResult d) {
        if (d instanceof ResolvedDependencyResult) {
            return ExtraJavaModuleInfoPlugin.ga(
                    ((ResolvedDependencyResult) d).getSelected().getId());
        }
        return d.getRequested().getDisplayName();
    }

    public String getGav() {
        return gav;
    }

    public List<String> getRequires() {
        return requires;
    }

    public List<String> getRequiresTransitive() {
        return requiresTransitive;
    }

    public List<String> getRequiresStaticTransitive() {
        return requiresStaticTransitive;
    }

    @Nullable
    public String getErrorMessage() {
        return errorMessage;
    }
}