Replace FART with our own JarTransformer

We still need jar transformation for the AWs, but it is now much lighter as it doesn't require all the tracking and built-in transformers that FART was providing.

Author: Yeregorix

gradle/libs.versions.toml

@@ -5,7 +5,6 @@ version = "1.0"
 accessWidener = "2.1.0"
 asm = "9.7.1"
 checker = "3.48.4"
-forgeAutoRenamingTool = "1.0.8"
 vineFlower = "1.10.1"
 ideaExt = "1.3"
 immutables = "2.10.1"
@@ -26,7 +25,6 @@ accessWidener = { module = "net.fabricmc:access-widener", version.ref = "accessW
 asm = { module = "org.ow2.asm:asm", version.ref = "asm" }
 asm-commons = { module = "org.ow2.asm:asm-commons", version.ref = "asm" }
 asm-util = { module = "org.ow2.asm:asm-util", version.ref = "asm" }
-forgeAutoRenamingTool = { module = "net.minecraftforge:ForgeAutoRenamingTool", version.ref = "forgeAutoRenamingTool" }
 vineFlower = { module = "org.vineflower:vineflower", version.ref = "vineFlower" }
 gson = { module = "com.google.code.gson:gson", version = "2.11.0" }
 ideaExt = { module = "gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext", version.ref = "ideaExt" }

subprojects/gradle-plugin/build.gradle.kts

@@ -20,21 +20,18 @@ val accessWiden by sourceSets.creating {
 val shadow by sourceSets.creating {
     configurations.named(this.implementationConfigurationName) { extendsFrom(commonDeps) }
 }
+val transformer by sourceSets.creating {
+    configurations.named(this.implementationConfigurationName) { extendsFrom(commonDeps) }
+}
 
 configurations {
     api { extendsFrom(commonDeps) }
-    "jarDecompileCompileClasspath" {
-        attributes {
-            attribute(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, 11) // VF needs 11
-        }
-    }
 }
 
 val accessWidenerVersion: String by project
 val asmVersion: String by project
 val checkerVersion: String by project
 val vineFlowerVersion: String by project
-val forgeAutoRenamingToolVersion: String by project
 val junitVersion: String by project
 val mergeToolVersion: String by project
 dependencies {
@@ -43,10 +40,6 @@ dependencies {
     commonDeps(libs.asm)
     commonDeps(libs.asm.commons)
     commonDeps(libs.asm.util)
-    commonDeps(libs.forgeAutoRenamingTool) {
-        exclude("org.ow2.asm") // Use our own ASM
-        exclude("net.sf.jopt-simple")
-    }
     commonDeps(libs.mammoth)
 
     // Just main
@@ -77,11 +70,14 @@ dependencies {
     "accessWidenCompileOnly"(libs.accessWidener) {
         exclude("org.ow2.asm")
     }
+    "accessWidenCompileOnly"(transformer.output)
     implementation(accessWiden.output)
 
     "shadowCompileOnly"(libs.shadowPlugin)
     implementation(shadow.output)
 
+    implementation(transformer.output)
+
     testImplementation(platform(libs.junit.bom))
     testImplementation(libs.junit.api)
     testRuntimeOnly(libs.junit.launcher)

subprojects/gradle-plugin/src/accessWiden/java/org/spongepowered/gradle/vanilla/internal/worker/AccessWidenerEntryTransformer.java

@@ -26,33 +26,18 @@
 
 import net.fabricmc.accesswidener.AccessWidener;
 import net.fabricmc.accesswidener.AccessWidenerClassVisitor;
-import net.fabricmc.accesswidener.AccessWidenerVisitor;
-import net.minecraftforge.fart.api.Transformer;
-import org.objectweb.asm.ClassReader;
 import org.objectweb.asm.ClassVisitor;
-import org.objectweb.asm.ClassWriter;
-import org.objectweb.asm.Opcodes;
+import org.spongepowered.gradle.vanilla.internal.transformer.ClassTransformer;
 
-final class AccessWidenerEntryTransformer implements Transformer {
+final class AccessWidenerEntryTransformer implements ClassTransformer {
     private final AccessWidener widener;
 
     public AccessWidenerEntryTransformer(final AccessWidener widener) {
         this.widener = widener;
     }
 
     @Override
-    public ClassEntry process(final ClassEntry entry) {
-        // Because InnerClass attributes can be present in any class AW'd classes
-        // are referenced from, we have to target every class to get a correct output.
-        final ClassReader reader = new ClassReader(entry.getData());
-        final ClassWriter writer = new ClassWriter(reader, 0);
-        // TODO: Expose the ASM version constant somewhere visible to this worker
-        final ClassVisitor visitor = AccessWidenerClassVisitor.createClassVisitor(Opcodes.ASM9, writer, this.widener);
-        reader.accept(visitor, 0);
-        if (entry.isMultiRelease()) {
-            return ClassEntry.create(entry.getName(), entry.getTime(), writer.toByteArray(), entry.getVersion());
-        } else {
-            return ClassEntry.create(entry.getName(), entry.getTime(), writer.toByteArray());
-        }
+    public ClassVisitor apply(final ClassVisitor parent) {
+        return AccessWidenerClassVisitor.createClassVisitor(ClassTransformer.ASM_VERSION, parent, this.widener);
     }
 }

subprojects/gradle-plugin/src/accessWiden/java/org/spongepowered/gradle/vanilla/internal/worker/AccessWidenerTransformerProvider.java

@@ -26,10 +26,10 @@
 
 import net.fabricmc.accesswidener.AccessWidener;
 import net.fabricmc.accesswidener.AccessWidenerReader;
-import net.minecraftforge.fart.api.Transformer;
 import org.gradle.api.GradleException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.spongepowered.gradle.vanilla.internal.transformer.ClassTransformer;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -39,12 +39,12 @@
 import java.util.Set;
 import java.util.function.Function;
 
-public final class AccessWidenerTransformerProvider implements Function<Set<Path>, Transformer> {
+public final class AccessWidenerTransformerProvider implements Function<Set<Path>, ClassTransformer> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AccessWidenerTransformerProvider.class);
 
     @Override
-    public Transformer apply(final Set<Path> paths) {
+    public ClassTransformer apply(final Set<Path> paths) {
         final AccessWidener widener = new AccessWidener();
         final AccessWidenerReader reader = new AccessWidenerReader(widener);
 

subprojects/gradle-plugin/src/main/java/org/spongepowered/gradle/vanilla/internal/Constants.java

@@ -48,7 +48,6 @@ public final class Constants {
     public static final String USER_AGENT = String.format("%s/%s Gradle/%s", Constants.NAME, Constants.VERSION, GradleVersion.current().getVersion());
     public static final String MINECRAFT_RESOURCES_HOST = "resources.download.minecraft.net";
     public static final String TASK_GROUP = "vanilla gradle";
-    public static final int ASM_VERSION = Opcodes.ASM9;
     public static final String FIRST_TARGETABLE_RELEASE_TIMESTAMP = "2019-09-04T11:19:34+00:00"; // 19w36a+
     public static final String OUT_OF_BAND_RELEASE = "1.14.4"; // Cause it is special
     public static final String INDENT = "    "; // indent to use when writing files

subprojects/gradle-plugin/src/main/java/org/spongepowered/gradle/vanilla/internal/repository/modifier/AccessWidenerModifier.java

@@ -24,11 +24,11 @@
  */
 package org.spongepowered.gradle.vanilla.internal.repository.modifier;
 
-import net.minecraftforge.fart.api.Transformer;
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.gradle.vanilla.internal.repository.ResolvableTool;
 import org.spongepowered.gradle.vanilla.internal.resolver.AsyncUtils;
+import org.spongepowered.gradle.vanilla.internal.transformer.ClassTransformer;
 import org.spongepowered.gradle.vanilla.repository.MinecraftResolver;
 import org.spongepowered.gradle.vanilla.resolver.HashAlgorithm;
 
@@ -86,13 +86,13 @@ public String stateKey() {
 
     @Override
     @SuppressWarnings("unchecked")
-    public CompletableFuture<TransformerProvider> providePopulator(
+    public CompletableFuture<ClassTransformer.Provider> providePopulator(
         final MinecraftResolver.Context context
     ) {
         final Supplier<URLClassLoader> loaderProvider = context.classLoaderWithTool(ResolvableTool.ACCESS_WIDENER);
-        return AsyncUtils.failableFuture(() -> new TransformerProvider() {
+        return AsyncUtils.failableFuture(() -> new ClassTransformer.Provider() {
             private final URLClassLoader loader = loaderProvider.get();
-            private @Nullable Function<Set<Path>, Transformer> accessWidenerLoader = (Function<Set<Path>, Transformer>) Class.forName(
+            private @Nullable Function<Set<Path>, ClassTransformer> accessWidenerLoader = (Function<Set<Path>, ClassTransformer>) Class.forName(
                 "org.spongepowered.gradle.vanilla.internal.worker.AccessWidenerTransformerProvider",
                 true,
                 this.loader
@@ -101,7 +101,7 @@ public CompletableFuture<TransformerProvider> providePopulator(
                 .newInstance();
 
             @Override
-            public Transformer provide() {
+            public ClassTransformer provide() {
                 if (this.accessWidenerLoader == null) {
                     throw new IllegalStateException("Already closed!");
                 }

subprojects/gradle-plugin/src/main/java/org/spongepowered/gradle/vanilla/internal/repository/modifier/ArtifactModifier.java

@@ -24,16 +24,14 @@
  */
 package org.spongepowered.gradle.vanilla.internal.repository.modifier;
 
-import net.minecraftforge.fart.api.Renamer;
-import net.minecraftforge.fart.api.Transformer;
+import org.spongepowered.gradle.vanilla.internal.transformer.ClassTransformer;
 import org.spongepowered.gradle.vanilla.repository.MinecraftResolver;
 
-import java.io.IOException;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
 /**
- * Some sort of operation that can be performed on a jar, via a {@link Renamer}.
+ * Some sort of operation that can be performed on a jar, via a {@link ClassTransformer.Provider}.
  */
 public interface ArtifactModifier {
 
@@ -86,7 +84,7 @@ static String decorateArtifactId(final String originalId, final Set<ArtifactModi
      *     asynchronously
      * @return a future providing the populator
      */
-    CompletableFuture<TransformerProvider> providePopulator(final MinecraftResolver.Context context);
+    CompletableFuture<ClassTransformer.Provider> providePopulator(final MinecraftResolver.Context context);
 
     /**
      * Indicates that the result of this modification should be stored in the
@@ -96,16 +94,4 @@ static String decorateArtifactId(final String originalId, final Set<ArtifactModi
      */
     boolean requiresLocalStorage();
 
-    /**
-     * A function that can provide a {@link Transformer} for use with a renamer, optionally having a post-rename operation to clean up resources.
-     */
-    @FunctionalInterface
-    interface TransformerProvider extends AutoCloseable {
-        Transformer provide();
-
-        @Override
-        default void close() throws IOException {
-        }
-    }
-
 }

subprojects/gradle-plugin/src/main/java/org/spongepowered/gradle/vanilla/repository/MinecraftResolverImpl.java

@@ -24,7 +24,6 @@
  */
 package org.spongepowered.gradle.vanilla.repository;
 
-import net.minecraftforge.fart.api.Renamer;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.immutables.value.Value;
 import org.slf4j.Logger;
@@ -41,6 +40,8 @@
 import org.spongepowered.gradle.vanilla.internal.repository.modifier.AssociatedResolutionFlags;
 import org.spongepowered.gradle.vanilla.internal.resolver.AsyncUtils;
 import org.spongepowered.gradle.vanilla.internal.resolver.FileUtils;
+import org.spongepowered.gradle.vanilla.internal.transformer.ClassTransformer;
+import org.spongepowered.gradle.vanilla.internal.transformer.JarTransformer;
 import org.spongepowered.gradle.vanilla.internal.util.FunctionalUtils;
 import org.spongepowered.gradle.vanilla.internal.util.SelfPreferringClassLoader;
 import org.spongepowered.gradle.vanilla.resolver.Downloader;
@@ -336,7 +337,7 @@ public CompletableFuture<ResolutionResult<MinecraftEnvironment>> provide(
         boolean requiresLocalStorage = false;
         // Synchronously compute the modifier populator providers
         @SuppressWarnings({"unchecked", "rawtypes"})
-        final CompletableFuture<ArtifactModifier.TransformerProvider>[] populators = new CompletableFuture[modifiers.size()];
+        final CompletableFuture<ClassTransformer.Provider>[] populators = new CompletableFuture[modifiers.size()];
 
         int idx = 0;
         for (final ArtifactModifier modifier : modifiers) {
@@ -368,16 +369,12 @@ public CompletableFuture<ResolutionResult<MinecraftEnvironment>> provide(
                         final Path outputTmp = Files.createTempDirectory("vanillagradle").resolve("output" + decoratedArtifact + ".jar");
                         FileUtils.createDirectoriesSymlinkSafe(output.getParent());
 
-                        final Renamer.Builder builder = Renamer.builder()
-                            .logger(MinecraftResolverImpl.LOGGER::info);
-
-                        for (final CompletableFuture<ArtifactModifier.TransformerProvider> populator : populators) {
+                        final JarTransformer.Builder builder = JarTransformer.builder();
+                        for (final CompletableFuture<ClassTransformer.Provider> populator : populators) {
                             builder.add(populator.get().provide());
                         }
 
-                        try (final Renamer ren = builder.build()) {
-                            ren.run(input.get().jar().toFile(), outputTmp.toFile());
-                        }
+                        builder.build().transform(input.get().jar(), outputTmp);
 
                         FileUtils.atomicMove(outputTmp, output);
                         this.writeMetaIfNecessary(side, decoratedArtifact, input.mapIfPresent((upToDate, env) -> env.metadata()), input.get()::dependencies, output.getParent());
@@ -386,7 +383,7 @@ public CompletableFuture<ResolutionResult<MinecraftEnvironment>> provide(
                 } catch (final Exception ex) {
                     throw new CompletionException(ex);
                 } finally {
-                    for (final CompletableFuture<ArtifactModifier.TransformerProvider> populator : populators) {
+                    for (final CompletableFuture<ClassTransformer.Provider> populator : populators) {
                         if (!populator.isCompletedExceptionally()) {
                             try {
                                 populator.join().close();

subprojects/gradle-plugin/src/transformer/java/org/spongepowered/gradle/vanilla/internal/transformer/ClassTransformer.java

@@ -0,0 +1,50 @@
+/*
+ * This file is part of VanillaGradle, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.gradle.vanilla.internal.transformer;
+
+import org.objectweb.asm.ClassVisitor;
+import org.objectweb.asm.Opcodes;
+
+import java.io.IOException;
+import java.util.function.UnaryOperator;
+
+/**
+ * Transforms the content of a class using a {@link ClassVisitor}.
+ */
+public interface ClassTransformer extends UnaryOperator<ClassVisitor> {
+    int ASM_VERSION = Opcodes.ASM9;
+
+    /**
+     * A function that can provide a {@link ClassTransformer}, optionally having a post-rename operation to clean up resources.
+     */
+    @FunctionalInterface
+    interface Provider extends AutoCloseable {
+        ClassTransformer provide();
+
+        @Override
+        default void close() throws IOException {
+        }
+    }
+}