Make the launcher self update

Author: Matyrobbrt

build.gradle

@@ -35,6 +35,9 @@ configurations {
     agentCompileOnly.extendsFrom(globalCompileOnly)
     launcherCompileOnly.extendsFrom(globalCompileOnly)
     compileOnly.extendsFrom(globalCompileOnly)
+
+    logback
+    launcherRuntimeOnly.extendsFrom(logback)
 }
 
 def agentClass = "com.mcmoddev.relauncher.agent.Agent"
@@ -72,17 +75,25 @@ dependencies {
     implementation sourceSets.api.output
     api sourceSets.api.output
 
-    agentImplementation libs.jda // This is just a compat layer for jda mentionables. DO NOT USE FOR ANYTHING ELSE as the agent will not have it shaded
-    agentImplementation libs.logback
+    agentCompileOnly libs.jda // This is just a compat layer for jda mentionables. DO NOT USE FOR ANYTHING ELSE as the agent will not have it shaded
+    agentCompileOnly libs.logback
     agentImplementation sourceSets.api.output
 
     launcherImplementation sourceSets.main.output
 
     shade sourceSets.api.output
     shade libs.gson
-    shade libs.logback
     shade libs.configurate.hocon
 
+    def slf4j = "org.slf4j:slf4j-api:1.7.36"
+
+    launcherCompileOnly slf4j
+    runtimeElements slf4j
+    logback(libs.logback) {
+        exclude module: 'logback-classic'
+    }
+    logback slf4j
+
     // Discord stuff
     shade libs.jda
     shade libs.chewtils.command
@@ -138,12 +149,34 @@ tasks.create("copyAgentJar", Copy) {
     mustRunAfter(tasks.getByName("processLauncherResources"))
     from "$buildDir/libs/$archivesBaseName-$version-agent.jar"
     into "$buildDir/resources/launcher/"
-    rename "$archivesBaseName-$version-agent.jar", "agent.zip"
+    rename "$archivesBaseName-$version-agent.jar", "relauncher-agent.zip"
+}
+
+tasks.create("selfUpdateJar", Jar).configure {
+    from(sourceSets.launcher.output) {
+        include "com/mcmoddev/relauncher/selfupdate/**/*.class"
+    }
+    classifier("selfupdate")
+    group("build")
+    description("Builds the selfupdate JAR")
+    manifest.attributes(makeManifestAttributes('Main-Class', 'com.mcmoddev.relauncher.selfupdate.SelfUpdate'))
+}
+
+tasks.create("copySelfUpdateJar", Copy) {
+    dependsOn("selfUpdateJar")
+    mustRunAfter(tasks.getByName("processLauncherResources"))
+    from "$buildDir/libs/$archivesBaseName-$version-selfupdate.jar"
+    into "$buildDir/resources/launcher/"
+    rename "$archivesBaseName-$version-selfupdate.jar", "relauncher-selfupdate.zip"
 }
 
 tasks.getByName('launcherClasses').configure {
     dependsOn("copyAgentJar")
     mustRunAfter(tasks.getByName("copyAgentJar"))
+    doLast {
+        tasks.getByName('selfUpdateJar').copy()
+        tasks.getByName('copySelfUpdateJar').copy()
+    }
 }
 
 tasks.named('build').configure {
@@ -153,8 +186,13 @@ tasks.named('build').configure {
 tasks.named('shadowJar', ShadowJar).configure {
     dependsOn("copyAgentJar")
     from sourceSets.main.output // The logback file
-    from sourceSets.launcher.output
-    configurations = [project.configurations.shade]
+    from(sourceSets.launcher.output) {
+        exclude "com/mcmoddev/relauncher/selfupdate/**/*.class"
+    }
+    configurations = [
+            project.configurations.shade,
+            project.configurations.logback
+    ]
     classifier("all")
     group("build")
     description("Builds the whole project with its dependencies.")
@@ -163,7 +201,9 @@ tasks.named('shadowJar', ShadowJar).configure {
 tasks.named(JavaPlugin.JAR_TASK_NAME, Jar).configure {
     dependsOn("generatePomFileForMavenPublication")
     from sourceSets.api.output
-    from sourceSets.launcher.output
+    from(sourceSets.launcher.output) {
+        exclude "com/mcmoddev/relauncher/selfupdate/**.class"
+    }
 
     exclude "logback.xml"
     into("META-INF/maven/${project.group}/${project.name}") {
@@ -188,7 +228,9 @@ tasks.create("apiJar", Jar).configure {
 tasks.create("sourcesJar", Jar) {
     dependsOn("launcherClasses")
     from sourceSets.api.allSource
-    from sourceSets.launcher.allSource
+    from(sourceSets.launcher.allSource) {
+        exclude "com/mcmoddev/relauncher/selfupdate/**.java"
+    }
     classifier("sources")
     group("build")
     description("Builds the sources jar")

gradle.properties

@@ -1,2 +1,2 @@
 name = "ReLauncher"
-version = 1.0.0
+version = 1.1.0

gradle/libs.versions.toml

@@ -10,7 +10,6 @@ gson = "2.9.0"
 logback = "1.2.11"
 annotations = "23.0.0"
 configurate = "4.1.2"
-slf4j = "1.7.36"
 
 [libraries]
 # jda = { module = "net.dv8tion:JDA", version.ref = "jda" }
@@ -22,4 +21,3 @@ gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
 logback = { module = "ch.qos.logback:logback-classic", version.ref = "logback" }
 configurate-hocon = {module = "org.spongepowered:configurate-hocon", version.ref = "configurate"}
 annotations = { module = "org.jetbrains:annotations", version.ref = "annotations" }
-slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }

src/api/java/com/mcmoddev/relauncher/api/JarUpdater.java

@@ -92,10 +92,10 @@ default Optional<String> getJarVersion() {
      */
     @NotNull
     default InputStream getAgentResource() {
-        var agent = getClass().getResourceAsStream("/agent.jar");
+        var agent = getClass().getResourceAsStream("/relauncher-agent.jar");
         if (agent == null) {
             // If we can't find it as a .jar, try a .zip
-            agent = getClass().getResourceAsStream("/agent.zip");
+            agent = getClass().getResourceAsStream("/relauncher-agent.zip");
         }
         return Objects.requireNonNull(agent);
     }

src/api/java/com/mcmoddev/relauncher/api/LauncherConfig.java

@@ -51,5 +51,12 @@ default boolean throwIfNew() {
         return true;
     }
 
+    /**
+     * @return if the launcher should be able to update itself
+     */
+    default boolean allowSelfUpdate() {
+        return true;
+    }
+
     record CheckingRate(long amount, TimeUnit unit) {}
 }

src/api/java/com/mcmoddev/relauncher/api/LauncherFactory.java

@@ -23,7 +23,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.io.IOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
 import java.nio.file.Path;
+import java.util.concurrent.ForkJoinPool;
 
 /**
  * A factory for ReLauncher. <br>
@@ -74,4 +80,22 @@ default Path getConfigPath(Path launcherDirectory) {
     @Nullable
     DiscordIntegration createDiscordIntegration(T config, JarUpdater updater);
 
+    /**
+     * @return the GitHub repository of the launcher
+     */
+    @Nullable
+    default RepoInfo getLauncherRepo() {
+        return new RepoInfo("MinecraftModDevelopment", "ReLauncher");
+    }
+
+    /**
+     * Gets the self update url for a tag name.
+     *
+     * @param tagName the tag to update to
+     * @return the download url, or {@code null}
+     */
+    @Nullable
+    String getSelfUpdateUrl(String tagName) throws IOException, InterruptedException;
+
+    record RepoInfo(String owner, String repo) {}
 }

src/launcher/java/com/mcmoddev/relauncher/DefaultJarUpdater.java

@@ -20,6 +20,7 @@
  */
 package com.mcmoddev.relauncher;
 
+import static com.mcmoddev.relauncher.Main.findJavaBinary;
 import com.mcmoddev.relauncher.api.DiscordIntegration;
 import com.mcmoddev.relauncher.api.JarUpdater;
 import com.mcmoddev.relauncher.api.ProcessInfo;
@@ -189,10 +190,6 @@ private List<String> getStartCommand() {
         return command;
     }
 
-    private static String findJavaBinary() {
-        return ProcessHandle.current().info().command().orElse("java");
-    }
-
     @Override
     public void startProcess() {
         process = new ProcessInfoImpl(createProcess(), updateChecker.getLatestFound());

src/launcher/java/com/mcmoddev/relauncher/DefaultLauncherFactory.java

@@ -24,17 +24,24 @@
 import com.mcmoddev.relauncher.api.JarUpdater;
 import com.mcmoddev.relauncher.api.LauncherFactory;
 import com.mcmoddev.relauncher.discord.DefaultDiscordIntegration;
+import com.mcmoddev.relauncher.github.GithubRelease;
 import com.mcmoddev.relauncher.github.GithubUpdateChecker;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.spongepowered.configurate.ConfigurateException;
 
+import java.io.IOException;
+import java.net.URI;
 import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
 import java.nio.file.Path;
 import java.util.regex.Pattern;
 
 public class DefaultLauncherFactory implements LauncherFactory<Config> {
 
+    public static final Pattern SELF_UPDATE_PATTERN = Pattern.compile("ReLauncher-.*-all\\.jar", Pattern.CASE_INSENSITIVE);
+
     @Override
     public @NotNull Config getConfig(final Path path) {
         try {
@@ -57,4 +64,28 @@ public class DefaultLauncherFactory implements LauncherFactory<Config> {
     public @Nullable DiscordIntegration createDiscordIntegration(final Config config, final JarUpdater updater) {
         return new DefaultDiscordIntegration(Path.of(""), config.discord, () -> updater);
     }
+
+    @Override
+    public @Nullable String getSelfUpdateUrl(final String tagName) throws IOException, InterruptedException {
+        final var repo = getLauncherRepo();
+        if (repo == null) {
+            return null;
+        }
+        final var url = "https://api.github.com/repos/%s/%s/releases/tags/%s".formatted(repo.owner(), repo.repo(), tagName);
+        final var response = HttpClient.newBuilder()
+            .executor(Main.HTTP_CLIENT_EXECUTOR)
+            .build()
+            .send(HttpRequest.newBuilder(URI.create(url))
+                .GET()
+                .build(), HttpResponse.BodyHandlers.ofString());
+        if (response.statusCode() == 404) {
+            return null;
+        }
+        final var release = Constants.GSON.fromJson(response.body(), GithubRelease.class);
+        return release.assets.stream()
+            .filter(a -> SELF_UPDATE_PATTERN.matcher(a.name).find())
+            .map(a -> a.browserDownloadUrl)
+            .findFirst()
+            .orElse(null);
+    }
 }