Add Facade Support Closes #1067

Add Extra Mavenizer arguments support Closes #1068
Bump Mavenizer fixes 1.12.2 Side.BUKKIT issue

Author: LexManos

settings.gradle

@@ -24,7 +24,7 @@ gradle.beforeProject { Project project ->
 
 //@formatter:off
 dependencyResolutionManagement.versionCatalogs.register('libs') {
-    version 'gradleutils', '3.4.3'
+    version 'gradleutils', '3.4.5'
 
     plugin 'licenser',       'net.minecraftforge.licenser'    version '1.2.0' // https://plugins.gradle.org/plugin/net.minecraftforge.licenser
     plugin 'gradleutils',    'net.minecraftforge.gradleutils' versionRef 'gradleutils'

src/main/java/net/minecraftforge/gradle/MinecraftDependency.java

@@ -11,6 +11,8 @@
 import net.minecraftforge.gradleutils.shared.Closures;
 import org.gradle.api.Action;
 import org.gradle.api.NamedDomainObjectContainer;
+import org.gradle.api.file.ConfigurableFileCollection;
+import org.gradle.api.provider.ListProperty;
 
 /// The Minecraft dependency contains information essential for how the
 /// {@linkplain MinecraftExtensionForProject minecraft extension} processes Minecraft dependencies.
@@ -37,4 +39,21 @@ default void runs(
     default void runs(Action<? super NamedDomainObjectContainer<? extends SlimeLauncherOptions>> action) {
         this.runs(Closures.action(this, action));
     }
+
+    /// Gets the Facade configuration files to use.
+    ///
+    /// Files must be in the format supported by the [Facade](https://github.com/minecraftforge/facade) project.
+    ///
+    /// This is only supported when using Mavenizer >= 0.4.56
+    ///
+    /// @return The property for the configuration files to use
+    ///
+    ConfigurableFileCollection getFacade();
+
+    /// Gets any *extra* arguments to be passed to the Mavenizer invocation.
+    /// These arguments will be added after all other args.
+    /// This is useful if using a version of Mavenizer that hasn't had a feature exposed to ForgeGradle yet
+    ///
+    /// @return A list of extra arguments to pass to Mavenizer
+    ListProperty<String> getMavenizerArguments();
 }

src/main/java/net/minecraftforge/gradle/internal/ClosureOwnerInternal.java

@@ -26,6 +26,7 @@
 import org.gradle.api.attributes.AttributeContainer;
 import org.gradle.api.capabilities.Capability;
 import org.gradle.api.file.ConfigurableFileCollection;
+import org.gradle.api.provider.ListProperty;
 import org.gradle.api.reflect.HasPublicType;
 import org.gradle.api.reflect.TypeOf;
 import org.jspecify.annotations.Nullable;
@@ -109,6 +110,16 @@ default ConfigurableFileCollection getAccessTransformers() {
             return this.getOwnerDelegate().getAccessTransformers();
         }
 
+        @Override
+        default ConfigurableFileCollection getFacade() {
+            return this.getOwnerDelegate().getFacade();
+        }
+
+        @Override
+        default ListProperty<String> getMavenizerArguments() {
+            return this.getOwnerDelegate().getMavenizerArguments();
+        }
+
         @Override
         default void setAccessTransformer(String accessTransformer) {
             this.getOwnerDelegate().setAccessTransformer(accessTransformer);

src/main/java/net/minecraftforge/gradle/internal/Constants.java

@@ -4,6 +4,8 @@
  */
 package net.minecraftforge.gradle.internal;
 
+import org.apache.maven.artifact.versioning.ComparableVersion;
+
 /// The package-private constants used throughout ForgeGradle.
 ///
 /// Looking for attributes? They are in [ForgeGradleExtension.Attributes].
@@ -73,4 +75,17 @@ please see our MDKExamples repo (https://github.com/MinecraftForge/MDKExamples).
 
             For more information, see https://docs.minecraftforge.net/en/fg-7.0/magic/""";
     }
+
+    static class Mavenizer {
+        /*
+         * Add support for --facade configs, a system that allows consumers to attach interfaces to the dependency.
+         * https://github.com/MinecraftForge/MinecraftMavenizer/commit/610bb2b11d6999e98d44cc4a87ec926e68d26a37
+         */
+        static final ComparableVersion SUPPORTS_FACADES = new ComparableVersion("0.4.61");
+
+        /*
+         * Also added --local-cache which is a project specific caching folder, used for post processors such as ATs and Facades
+         */
+        static final ComparableVersion SUPPORTS_LOCAL_CACHE = new ComparableVersion("0.4.56");
+    }
 }

src/main/java/net/minecraftforge/gradle/internal/ForgeGradleProblems.java

@@ -282,6 +282,21 @@ RuntimeException accessTransformersNotOnClasspath(Throwable e) {
     }
     //endregion
 
+    //region Facades
+    void reportFacadesNotSupported(String dependency) {
+        this.report("mavenizer-out-of-date-facade", "Mavenizer Tool doesn't support facades", spec -> spec
+            .details("""
+            The Mavenizer configured for this project does not support Facades.
+            Any facade configured to be used, will be skipped.
+            This may result in compile or runtime errors.
+            Configured Version:\s""" + dependency)
+            .severity(Severity.ERROR)
+            .solution("Update mavenizer to >=" + Constants.Mavenizer.SUPPORTS_FACADES + " or remove manual override.")
+            .solution("Remove Facade config if not needed.")
+            .solution(HELP_MESSAGE));
+    }
+    //endregion
+
     //region Message Board
     void reportMessageBoardCacheBroken(Throwable e, File file, String property) {
         this.report("message-board-cache-broken", "ForgeGradle's message board cannot save data", spec -> spec

src/main/java/net/minecraftforge/gradle/internal/MavenizerInstanceImpl.java

@@ -62,12 +62,13 @@ private Provider<String> get(String key, @Nullable String _default, String requi
         return this.invoke.getting(key)
             .orElse(this.extension.getProviders().provider(() -> {
                 // This should only happen when someone hardcodes their tool version, warn them
-                var message = "Mavenizer did not output expected json data " + key +", Make sure you're using Mavenizer >= " + requiredVersion;
+                var version = this.extension.plugin.getTool(Tools.MAVENIZER).getModule();
+                var message = "Mavenizer did not output expected json data " + key + ", Make sure you're using Mavenizer >= " + requiredVersion + " using " + version;
                 if (_default != null) {
                     LOGGER.warn(message);
                     return _default;
                 }
-                throw new IllegalStateException("Mavenizer did not output expected json data " + key +", Make sure you're using Mavenizer >= " + requiredVersion);
+                throw new IllegalStateException(message);
             }));
     }
 

src/main/java/net/minecraftforge/gradle/internal/MinecraftDependencyImpl.java

@@ -24,6 +24,7 @@
 import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.ExtensionAware;
+import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.TaskProvider;
@@ -51,6 +52,11 @@ abstract class MinecraftDependencyImpl implements MinecraftDependencyInternal {
     private final ConfigurableFileCollection accessTransformer = this.getObjects().fileCollection();
     private final Property<String> accessTransformerPath = this.getObjects().property(String.class);
 
+    // Facades
+    private final ConfigurableFileCollection facade = this.getObjects().fileCollection();
+    // Extra Mavenizer Arguments
+    private final ListProperty<String> extraMavenizerArguments = this.getObjects().listProperty(String.class);
+
     // Dependency Information
     private final Property<String> asString = getObjects().property(String.class);
     private final Property<String> asPath = getObjects().property(String.class);
@@ -71,6 +77,8 @@ abstract class MinecraftDependencyImpl implements MinecraftDependencyInternal {
     public MinecraftDependencyImpl(String mavenizerName) {
         this.mavenizerName = mavenizerName;
         this.mappings.convention(minecraft.getMappingsProperty());
+        this.facade.convention(minecraft.getFacade());
+        this.extraMavenizerArguments.convention(minecraft.getMavenizerArguments());
     }
 
     // Can be nullable due to configuration caching.
@@ -151,6 +159,16 @@ public Property<String> getAccessTransformerPath() {
         return this.accessTransformerPath;
     }
 
+    @Override
+    public ConfigurableFileCollection getFacade() {
+        return this.facade;
+    }
+
+    @Override
+    public ListProperty<String> getMavenizerArguments() {
+        return this.extraMavenizerArguments;
+    }
+
     /* INTERNAL */
 
     private boolean hasAccessTransformers() {

src/main/java/net/minecraftforge/gradle/internal/MinecraftExtensionImpl.java

@@ -14,6 +14,7 @@
 import net.minecraftforge.gradle.MinecraftExtensionForProject;
 import net.minecraftforge.gradle.MinecraftMappings;
 import net.minecraftforge.gradle.SlimeLauncherOptions;
+import org.apache.maven.artifact.versioning.ComparableVersion;
 import org.gradle.api.Action;
 import org.gradle.api.NamedDomainObjectContainer;
 import org.gradle.api.Project;
@@ -36,6 +37,7 @@
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.ProviderFactory;
 import org.gradle.api.reflect.TypeOf;
@@ -182,6 +184,11 @@ static abstract class ForProjectImpl extends MinecraftExtensionImpl implements F
         private final ConfigurableFileCollection accessTransformer = getObjects().fileCollection();
         private final Property<String> accessTransformerPath = getObjects().property(String.class);
 
+        // Facades
+        private final ConfigurableFileCollection facades = getObjects().fileCollection();
+        // Extra Mavenizer Arguments
+        private final ListProperty<String> extraMavenizerArguments = this.getObjects().listProperty(String.class);
+
         private final ForgeGradleProblems problems = getObjects().newInstance(ForgeGradleProblems.class);
 
         protected abstract @Inject Project getProject();
@@ -277,6 +284,16 @@ public Property<String> getAccessTransformerPath() {
             return this.accessTransformerPath;
         }
 
+        @Override
+        public ConfigurableFileCollection getFacade() {
+            return this.facades;
+        }
+
+        @Override
+        public ListProperty<String> getMavenizerArguments() {
+            return this.extraMavenizerArguments;
+        }
+
         @Override
         public List<? extends MavenArtifactRepository> getRepositories() {
             var repositoriesMode = getDependencyResolutionManagement().getRepositoriesMode().getOrElse(RepositoriesMode.PREFER_PROJECT);
@@ -399,6 +416,7 @@ public MavenizerInstance dependency(
             var mavenizer = this.getProviders().of(MavenizerValueSource.class, spec -> {
                 spec.parameters(params -> {
                     var tool = this.plugin.getTool(Tools.MAVENIZER);
+                    var toolVersion = new ComparableVersion(tool.getModule().getVersion());
                     params.getClasspath().setFrom(tool.getClasspath());
                     params.getJavaLauncher().set(tool.getJavaLauncher().map(JavaLauncher::getExecutablePath));
                     params.getArguments().set(this.getProviders().provider(() -> {
@@ -407,6 +425,10 @@ public MavenizerInstance dependency(
                             .map(this.problems.ensureFileLocation());
                         var cache = toolCache.get().dir("caches").getAsFile().getAbsolutePath();
 
+                        var localToolCache = this.plugin.localCaches()
+                            .dir(tool.getName().toLowerCase(Locale.ENGLISH))
+                            .map(this.problems.ensureFileLocation());
+
                         var ret = new ArrayList<>(List.of(
                             "--maven",
                             "--cache", cache,
@@ -422,7 +444,7 @@ public MavenizerInstance dependency(
                             ret.add("--ignore-cache");
 
                         // If we are finding the access transformer from sourcesets, just find from any source set
-                        // We can't filter by configurations becase the config cache doesn't like that.
+                        // We can't filter by configurations because the config cache doesn't like that.
                         // So if users fuck up, then we can output a warning, or they can manually set the AT file.
                         // This is a 'best effort'
                         var sourceSets = getProject().getExtensions().getByType(JavaPluginExtension.class).getSourceSets();
@@ -449,6 +471,26 @@ else if (!"official".equals(mappings.getChannel()))
                             ret.add("--repository");
                             ret.add(repo.getName() + ',' + url);
                         }
+
+                        if (!minecraftDependency.getFacade().isEmpty()) {
+                            if (toolVersion.compareTo(Constants.Mavenizer.SUPPORTS_FACADES) < 0) {
+                                problems.reportFacadesNotSupported(tool.getModule().toString());
+                            } else {
+                                for (var cfg : minecraftDependency.getFacade()) {
+                                    ret.add("--facade-config");
+                                    ret.add(cfg.getAbsolutePath());
+                                }
+                            }
+                        }
+
+                        if (toolVersion.compareTo(Constants.Mavenizer.SUPPORTS_LOCAL_CACHE) >= 0) {
+                            ret.add("--local-cache");
+                            ret.add(localToolCache.get().getAsFile().getAbsolutePath());
+                        }
+
+                        // Make sure to do this at the very end
+                        ret.addAll(minecraftDependency.getMavenizerArguments().getOrElse(Collections.emptyList()));
+
                         return ret;
                     }));
                 });

src/main/java/net/minecraftforge/gradle/internal/Tools.java

@@ -11,5 +11,5 @@ private Tools() { }
 
     static final Tool SLIMELAUNCHER = Tool.ofForge("slimelauncher", "net.minecraftforge:slime-launcher:0.1.12", 8, "net.minecraftforge.launcher.Main");
 
-    static final Tool MAVENIZER = Tool.ofForge("mavenizer", "net.minecraftforge:minecraft-mavenizer:0.4.55", 25, "net.minecraftforge.mcmaven.cli.Main");
+    static final Tool MAVENIZER = Tool.ofForge("mavenizer", "net.minecraftforge:minecraft-mavenizer:0.4.61", 25, "net.minecraftforge.mcmaven.cli.Main");
 }