Restarter: Add properties to exclude directories from restarter classpath

Author: freya022

BotCommands-restarter/src/main/kotlin/dev/freya02/botcommands/internal/restart/Restarter.kt

@@ -30,7 +30,7 @@ class Restarter private constructor(
         val thread = Thread.currentThread()
 
         appClassLoader = thread.contextClassLoader
-        appClasspathUrls = AppClasspath.getPaths().map { it.toUri().toURL() }
+        appClasspathUrls = AppClasspath.paths.map { it.toUri().toURL() }
 
         mainClassName = StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE)
             .walk { stream -> stream.filter { it.methodName == "main" }.toList().last() }

BotCommands-restarter/src/main/kotlin/dev/freya02/botcommands/internal/restart/utils/AppClasspath.kt

@@ -1,18 +1,60 @@
 package dev.freya02.botcommands.internal.restart.utils
 
+import io.github.oshai.kotlinlogging.KotlinLogging
 import java.io.File
 import java.lang.management.ManagementFactory
 import java.nio.file.Path
+import java.util.*
 import kotlin.io.path.Path
 import kotlin.io.path.isDirectory
 
+private val logger = KotlinLogging.logger { }
+
 internal object AppClasspath {
 
-    fun getPaths(): List<Path> {
-        return ManagementFactory.getRuntimeMXBean().classPath
+    val paths: List<Path>
+
+    init {
+        val resources = Thread.currentThread().contextClassLoader.getResources("META-INF/BotCommands-restarter.properties")
+
+        val excludePatterns = buildSet {
+            resources.iterator().forEach { url ->
+                val properties = url.openStream().use { inputStream ->
+                    val prop = Properties()
+                    prop.load(inputStream)
+                    prop
+                }
+
+                // Load "restart.exclude.[patternName]=[pattern]"
+                properties.forEach { key, value ->
+                    if (key !is String) return@forEach
+                    if (value !is String) return@forEach
+
+                    val patternName = key.substringAfter("restart.exclude.", missingDelimiterValue = "")
+                    if (patternName.isNotBlank() && value.isNotBlank()) {
+                        add(value.toRegex())
+                    }
+                }
+            }
+        }
+
+        logger.debug { "Restart classpath exclude patterns: $excludePatterns" }
+
+        val (includedPaths, excludedPaths) = ManagementFactory.getRuntimeMXBean().classPath
             .split(File.pathSeparator)
             .map(::Path)
             .filter { it.isDirectory() }
-            .filter { it.endsWith("test-classes") } // TODO add proper configurable filters
+            .partition { path ->
+                val uri = path.toUri().toString()
+                if (excludePatterns.any { it.containsMatchIn(uri) })
+                    return@partition false // Exclude
+
+                true // Include
+            }
+
+        logger.info { "Restart classpath includes (+ JARs) $includedPaths" }
+        logger.info { "Restart classpath excludes $excludedPaths" }
+
+        paths = includedPaths
     }
-}
+}

BotCommands-restarter/src/main/kotlin/dev/freya02/botcommands/internal/restart/watcher/ClasspathWatcher.kt

@@ -41,7 +41,7 @@ internal class ClasspathWatcher private constructor(
     private val snapshots: MutableMap<Path, SourceFiles> = hashMapOf()
 
     init {
-        AppClasspath.getPaths().forEach { classRoot ->
+        AppClasspath.paths.forEach { classRoot ->
             require(classRoot.isDirectory())
 
             logger.trace { "Creating snapshot of ${classRoot.absolutePathString()}" }
@@ -179,4 +179,4 @@ internal class ClasspathWatcher private constructor(
 
 private fun Path.takeSnapshot(): SourceFiles = walkFiles().associate { (it, attrs) ->
     it.relativeTo(this).pathString to SourceFile(attrs.lastModifiedTime().toInstant())
-}.let(::SourceFiles)
+}.let(::SourceFiles)

BotCommands-restarter/src/main/resources/META-INF/BotCommands-restarter.properties

@@ -0,0 +1,13 @@
+# This file is for BotCommands's own tests
+# It is in the production resources so it can be applied regardless of in which module it is used
+# This principally excludes source sets which are used by the restarter, to avoid classpath issues
+
+restart.exclude.jda-cache-prod=BotCommands-jda-cache/build/classes/(?:kotlin|java)/main
+restart.exclude.jda-cache-prod-res=BotCommands-jda-cache/build/resources/main
+
+restart.exclude.restarter-prod=BotCommands-restarter/build/classes/(?:kotlin|java)/main
+restart.exclude.restarter-prod-res=BotCommands-restarter/build/resources/main
+
+# Have to use a negative lookbehind as the main module doesn't have a dedicated directory
+restart.exclude.core-prod=(?<!BotCommands-jda-cache/)build/classes/(?:kotlin|java)/main
+restart.exclude.core-prod-res=(?<!BotCommands-jda-cache/)build/resources/main