improve MC dependency names

- include dist in module
- include actual version in version
- use a shorter, cleaner hash for readability
  - mark as changing to avoid collisions

Author: TropheusJ

build.gradle.kts

@@ -18,7 +18,7 @@ repositories {
 
 val mc by minecraft.creating {
     version = "1.21.7"
-    distribution = Distribution.SERVER
+    distribution = Distribution.MERGED
 
     runs {
         register("server") {

plugin/src/main/java/fish/cichlidmc/cichlid_gradle/cache/mcmaven/MinecraftMaven.java

@@ -29,6 +29,8 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collection;
 import java.util.Optional;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -39,14 +41,16 @@
  */
 public final class MinecraftMaven {
 	public static final String GROUP = "net.minecraft";
-	public static final String MODULE = "minecraft";
+	public static final Collection<String> MODULES = Arrays.stream(Distribution.values())
+			.map(dist -> "minecraft-" + dist.name)
+			.toList();
 
 	/**
 	 * Regex for files that could possibly be provided.
 	 */
 	public static final Pattern VALID_FILE = Pattern.compile(
-			// groups:				  |1 |           |2 |   |-  3  -||-           4            -|
-			"/net/minecraft/minecraft/(.+)/minecraft-(.+)\\.(pom|jar)(.md5|.sha1|.sha256|.sha512)?"
+			// groups:				  |-         1        -| |2 |           |-         3        -| |4 |   |-  5  -||-           6            -|
+			"/net/minecraft/minecraft-(client|server|merged)/(.+)/minecraft-(client|server|merged)-(.+)\\.(pom|jar)(.md5|.sha1|.sha256|.sha512)?"
 	);
 
 	private static final Logger logger = Logging.getLogger(MinecraftMaven.class);
@@ -67,12 +71,19 @@ public InputStream get(URI uri) throws IOException {
 
 		MinecraftDefinitionImpl def = (MinecraftDefinitionImpl) this.defs.findByName(request.def);
 		if (def == null) {
-			throw new InvalidUserDataException("Minecraft definition '" + request.def + "' does not exist");
+			throw new IllegalStateException("Minecraft definition '" + request.def + "' does not exist");
 		}
 
 		String version = def.version();
+		Distribution dist = def.dist();
 
-		InputStream stream = this.getArtifact(version, def.dist(), def.getTransformers(), request);
+		// validate that the request matches
+		if (request.dist != dist || !request.version.equals(version)) {
+			throw new IllegalStateException("Malformed request for Minecraft definition " + request.def);
+		}
+
+
+		InputStream stream = this.getArtifact(version, dist, def.getTransformers(), request);
 		if (stream == null || request.hashAlgorithm.isEmpty())
 			return stream;
 
@@ -135,7 +146,7 @@ private InputStream getArtifact(String versionId, Distribution dist, Transformer
 	private InputStream getPom(FullVersion version, Distribution dist, Request request) throws IOException {
 		Path template = this.cache.pomTemplates.get(version.id, dist);
 		if (!Files.exists(template)) {
-			PomGenerator.generate(version, template);
+			PomGenerator.generate(version, dist, template);
 		}
 
 		// file should now exist
@@ -152,9 +163,17 @@ private static Request extractRequest(URI uri) {
 		if (!matcher.matches())
 			return null;
 
+		// extract and verify dist
+		String dist1 = matcher.group(1);
+		String dist2 = matcher.group(3);
+		if (!dist1.equals(dist2))
+			return null;
+
+		Distribution dist = Distribution.ofName(dist1).orElseThrow();
+
 		// make sure both versions are the same
-		String version1 = matcher.group(1);
-		String version2 = matcher.group(2);
+		String version1 = matcher.group(2);
+		String version2 = matcher.group(4);
 
 		// -sources will get caught in group 2 if present, check for it
 		boolean sources = false;
@@ -166,15 +185,16 @@ private static Request extractRequest(URI uri) {
 		if (!version1.equals(version2))
 			return null;
 
-		// version is defName$hash, extract the name
-		int separator = version1.indexOf('$');
-		if (separator == -1)
+		// version is version$def$hash, extract the name
+		String[] split = version1.split("\\$");
+		if (split.length != 3)
 			return null;
 
-		String defName = version1.substring(0, separator);
-		String hash = version1.substring(separator + 1);
+		String version = split[0];
+		String defName = split[1];
+		String hash = split[2];
 
-		Artifact artifact = switch (matcher.group(3)) {
+		Artifact artifact = switch (matcher.group(5)) {
 			case "jar" -> sources ? Artifact.SOURCES : Artifact.JAR;
 			case "pom" -> Artifact.POM;
 			default -> null;
@@ -184,7 +204,7 @@ private static Request extractRequest(URI uri) {
 			return null;
 
 		HashAlgorithm hashAlgorithm;
-		switch (matcher.group(4)) {
+		switch (matcher.group(6)) {
 			case ".md5" -> hashAlgorithm = HashAlgorithm.MD5;
 			case ".sha1" -> hashAlgorithm = HashAlgorithm.SHA1;
 			case ".sha256" -> hashAlgorithm = HashAlgorithm.SHA256;
@@ -196,9 +216,9 @@ private static Request extractRequest(URI uri) {
 			}
 		}
 
-		logger.debug("Intercepted request for Minecraft definition {}, {}, {}", defName, artifact, hashAlgorithm);
+		logger.quiet("Intercepted request for Minecraft definition {}, {}, {}", defName, artifact, hashAlgorithm);
 
-		return new Request(defName, hash, artifact, Optional.ofNullable(hashAlgorithm));
+		return new Request(dist, version1, version, defName, hash, artifact, Optional.ofNullable(hashAlgorithm));
 	}
 
 	public static String createProtocol(Project project) {
@@ -221,10 +241,7 @@ private static char filterChar(char c) {
 		return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || (c == '+' || c == '-' || c == '.') ? c : '-';
 	}
 
-	private record Request(String def, String hash, Artifact artifact, Optional<HashAlgorithm> hashAlgorithm) {
-		// the version specified in the pom needs to match what gradle requested exactly (defName$hash) or it'll be rejected
-		private String gradleRequestedVersion() {
-			return this.def + '$' + this.hash;
-		}
+	private record Request(Distribution dist, String gradleRequestedVersion, String version, String def,
+						   String hash, Artifact artifact, Optional<HashAlgorithm> hashAlgorithm) {
 	}
 }

plugin/src/main/java/fish/cichlidmc/cichlid_gradle/cache/mcmaven/PomGenerator.java

@@ -1,5 +1,6 @@
 package fish.cichlidmc.cichlid_gradle.cache.mcmaven;
 
+import fish.cichlidmc.cichlid_gradle.util.Distribution;
 import fish.cichlidmc.cichlid_gradle.util.XmlBuilder;
 import fish.cichlidmc.pistonmetaparser.FullVersion;
 import fish.cichlidmc.pistonmetaparser.rule.Features;
@@ -19,11 +20,11 @@
 public final class PomGenerator {
 	public static final String VERSION_PLACEHOLDER = "${version}";
 
-	public static void generate(FullVersion version, Path output) throws IOException {
+	public static void generate(FullVersion version, Distribution dist, Path output) throws IOException {
 		XmlBuilder.create().add(new XmlBuilder.XmlElement("project", List.of(
 				new XmlBuilder.XmlElement("modelVersion", "4.0.0"),
 				new XmlBuilder.XmlElement("groupId", "net.minecraft"),
-				new XmlBuilder.XmlElement("artifactId", "minecraft"),
+				new XmlBuilder.XmlElement("artifactId", "minecraft-" + dist.name),
 				new XmlBuilder.XmlElement("version", VERSION_PLACEHOLDER),
 				new XmlBuilder.XmlElement("dependencies", version.libraries.stream().flatMap(PomGenerator::makeDependencyElements).toList())
 		))).write(output);

plugin/src/main/java/fish/cichlidmc/cichlid_gradle/extension/def/DefHash.java

@@ -0,0 +1,15 @@
+package fish.cichlidmc.cichlid_gradle.extension.def;
+
+import fish.cichlidmc.cichlid_gradle.util.hash.Encoding;
+
+public record DefHash(byte[] bytes, String shortString, String longString) {
+	public static final int SHORT_LENGTH = 6;
+
+	public static DefHash of(byte[] bytes) {
+		return new DefHash(
+				bytes,
+				Encoding.BASE36.encode(bytes).substring(0, SHORT_LENGTH),
+				Encoding.BASE_FUNNY.encode(bytes)
+		);
+	}
+}

plugin/src/main/java/fish/cichlidmc/cichlid_gradle/extension/def/MinecraftDefinitionImpl.java

@@ -5,7 +5,6 @@
 import fish.cichlidmc.cichlid_gradle.run.RunConfigurationImpl;
 import fish.cichlidmc.cichlid_gradle.util.Distribution;
 import fish.cichlidmc.cichlid_gradle.util.Utils;
-import fish.cichlidmc.cichlid_gradle.util.hash.Encoding;
 import fish.cichlidmc.cichlid_gradle.util.hash.HashAlgorithm;
 import org.gradle.api.InvalidUserDataException;
 import org.gradle.api.NamedDomainObjectContainer;
@@ -34,7 +33,7 @@ public final class MinecraftDefinitionImpl implements MinecraftDefinition {
 
 	private final Provider<ExternalModuleDependency> dependency;
 
-	private String hash;
+	private DefHash hash;
 
 	public MinecraftDefinitionImpl(String name, Project project) {
 		if (name.contains("$")) {
@@ -56,9 +55,7 @@ public MinecraftDefinitionImpl(String name, Project project) {
 		this.transformers = TransformersImpl.of(name, project.getConfigurations());
 
 		DependencyFactory depFactory = project.getDependencyFactory();
-		this.dependency = project.getProviders().provider(
-				() -> depFactory.create("net.minecraft", "minecraft", name + '$' + this.hash())
-		);
+		this.dependency = project.getProviders().provider(() -> this.createDependency(depFactory));
 	}
 
 	@Override
@@ -103,7 +100,7 @@ public Distribution dist() {
 		return this.distribution.get();
 	}
 
-	private String hash() throws IOException {
+	public DefHash hash() throws IOException {
 		if (this.hash != null)
 			return this.hash;
 
@@ -126,7 +123,19 @@ private String hash() throws IOException {
 			}
 		}
 
-		this.hash = Encoding.BASE_FUNNY.encode(digest.digest());
+		this.hash = DefHash.of(digest.digest());
 		return this.hash;
 	}
+
+	private ExternalModuleDependency createDependency(DependencyFactory factory) throws IOException {
+		String module = "minecraft-" + this.dist();
+		String version = this.version() + '$' + this.name + '$' + this.hash().shortString();
+		ExternalModuleDependency dep = factory.create("net.minecraft", module, version);
+
+		// set as changing so gradle only caches it for 24 hours.
+		// since the hash is short, collisions aren't out of the question over a long period of time.
+		dep.setChanging(true);
+
+		return dep;
+	}
 }

plugin/src/main/java/fish/cichlidmc/cichlid_gradle/extension/repo/MinecraftReposExtension.java

@@ -50,7 +50,7 @@ public MavenArtifactRepository versions() {
 
         repos.exclusiveContent(exclusive -> exclusive.forRepositories(maven).filter(contents -> {
             contents.includeGroup(MinecraftMaven.GROUP);
-            contents.includeModule(MinecraftMaven.GROUP, MinecraftMaven.MODULE);
+            MinecraftMaven.MODULES.forEach(module -> contents.includeModule(MinecraftMaven.GROUP, module));
         }));
 
         return maven;